Struct SocketControlMessage

pub struct SocketControlMessage { /* private fields */ }

A GSocketControlMessage is a special-purpose utility message that can be sent to or received from a Socket. These types of messages are often called ‘ancillary data’.

The message can represent some sort of special instruction to or information from the socket or can represent a special kind of transfer to the peer (for example, sending a file descriptor over a UNIX socket).

These messages are sent with SocketExtManual::send_message() and received with SocketExtManual::receive_message().

To extend the set of control message that can be sent, subclass this class and override the get_size, get_level, get_type and serialize methods.

To extend the set of control messages that can be received, subclass this class and implement the deserialize method. Also, make sure your class is registered with the [type@GObject.Type] type system before calling SocketExtManual::receive_message() to read such a message.

This is an Abstract Base Class, you cannot instantiate it.

Implements

SocketControlMessageExt, [trait@glib::ObjectExt], SocketControlMessageExtManual

GLib type: GObject with reference counted clone semantics.

Implementations

impl SocketControlMessage

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

pub fn deserialize( level: i32, type_: i32, data: &[u8], ) -> Option<SocketControlMessage>

Tries to deserialize a socket control message of a given @level and @type_. This will ask all known (to GType) subclasses of #GSocketControlMessage if they can understand this kind of message and if so deserialize it into a #GSocketControlMessage.

If there is no implementation for this kind of control message, None will be returned.

level

a socket level

type_

a socket control message type for the given @level

Returns

the deserialized message or None

Trait Implementations

impl Clone for SocketControlMessage

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 SocketControlMessage

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

Formats the value using the given formatter.

impl HasParamSpec for SocketControlMessage

type ParamSpec = ParamSpecObject

type SetValue = SocketControlMessage

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for SocketControlMessage

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<T: SocketControlMessageImpl> IsSubclassable<T> for SocketControlMessage

fn class_init(class: &mut Class<Self>)

Override the virtual methods of this class for the given subclass and do other class initialization.

fn instance_init(instance: &mut InitializingObject<T>)

Instance specific initialization.

impl Ord for SocketControlMessage

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 SocketControlMessage

type Parent = Object

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

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 SocketControlMessage

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 SocketControlMessage

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for SocketControlMessage

impl IsA<SocketControlMessage> for UnixCredentialsMessage

Available on Unix only.

impl IsA<SocketControlMessage> for UnixFDMessage

Available on Unix only.