Struct Socket 

pub struct Socket { /* private fields */ }

local_error); // handle error if needed }

## Properties


#### `blocking`
 Whether I/O on this socket is blocking.

Readable | Writable


#### `broadcast`
 Whether the socket should allow sending to broadcast addresses.

Readable | Writable


#### `family`
 s address family.

Readable | Writable | Construct Only


#### `fd`
 s file descriptor.

Readable | Writable | Construct Only


#### `keepalive`
 Whether to keep the connection alive by sending periodic pings.

Readable | Writable


#### `listen-backlog`
 The number of outstanding connections in the listen queue.

Readable | Writable


#### `local-address`
 The local address the socket is bound to.

Readable


#### `multicast-loopback`
 Whether outgoing multicast packets loop back to the local host.

Readable | Writable


#### `multicast-ttl`
 Time-to-live out outgoing multicast packets

Readable | Writable


#### `protocol`
 The ID of the protocol to use, or `-1` for unknown.

Readable | Writable | Construct Only


#### `remote-address`
 The remote address the socket is connected to.

Readable


#### `timeout`
 The timeout in seconds on socket I/O

Readable | Writable


#### `ttl`
 Time-to-live for outgoing unicast packets

Readable | Writable


#### `type`
 s type.

Readable | Writable | Construct Only

# Implements

[`SocketExt`][trait@crate::prelude::SocketExt], [`trait@glib::ObjectExt`], [`DatagramBasedExt`][trait@crate::prelude::DatagramBasedExt], [`InitableExt`][trait@crate::prelude::InitableExt], [`SocketExtManual`][trait@crate::prelude::SocketExtManual], [`DatagramBasedExtManual`][trait@crate::prelude::DatagramBasedExtManual]

GLib type: GObject with reference counted clone semantics.

Implementations

impl Socket

pub fn from_fd(fd: OwnedFd) -> Result<Socket, Error>

Available on Unix only.

Creates a new #GSocket from a native file descriptor or winsock SOCKET handle.

This reads all the settings from the file descriptor so that all properties should work. Note that the file descriptor will be set to non-blocking mode, independent on the blocking mode of the #GSocket.

On success, the returned #GSocket takes ownership of @fd. On failure, the caller must close @fd themselves.

Since GLib 2.46, it is no longer a fatal error to call this on a non-socket descriptor. Instead, a GError will be set with code IOErrorEnum::Failed

fd

a native socket file descriptor.

Returns

a #GSocket or None on error. Free the returned object with g_object_unref().

pub unsafe fn from_raw_fd(fd: impl IntoRawFd) -> Result<Socket, Error>

Available on Unix only.

impl Socket

pub const NONE: Option<&'static Socket> = None

pub fn new( family: SocketFamily, type_: SocketType, protocol: SocketProtocol, ) -> Result<Socket, Error>

Creates a new #GSocket with the defined family, type and protocol. If @protocol is 0 (SocketProtocol::Default) the default protocol type for the family and type is used.

The @protocol is a family and type specific int that specifies what kind of protocol to use. #GSocketProtocol lists several common ones. Many families only support one protocol, and use 0 for this, others support several and using 0 means to use the default protocol for the family and type.

The protocol id is passed directly to the operating system, so you can use protocols not listed in #GSocketProtocol if you know the protocol number used for it.

family

the socket family to use, e.g. SocketFamily::Ipv4.

type_

the socket type to use.

protocol

the id of the protocol to use, or 0 for default.

Returns

a #GSocket or None on error. Free the returned object with g_object_unref().

Trait Implementations

impl AsFd for Socket

Available on Unix only.

fn as_fd(&self) -> BorrowedFd<'_>

Borrows the file descriptor.

impl AsRawFd for Socket

Available on Unix only.

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl Clone for Socket

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Socket

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for Socket

impl HasParamSpec for Socket

type ParamSpec = ParamSpecObject

type SetValue = Socket

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(&str) -> ParamSpecObjectBuilder<'_, Socket>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for Socket

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Hashes the memory address of this object.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IsA<DatagramBased> for Socket

impl IsA<Initable> for Socket

impl Ord for Socket

fn cmp(&self, other: &Self) -> Ordering

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl ParentClassIs for Socket

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for Socket

fn eq(&self, other: &OT) -> bool

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for Socket

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for Socket

fn static_type() -> Type

Returns the type identifier of Self.