GI.Gio.Objects.SocketControlMessage

A SocketControlMessage 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 socketSendMessage and received with socketReceiveMessage.

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 GType typesystem before calling socketReceiveMessage to read such a message.

Since: 2.22

Exported types

newtype SocketControlMessage

Memory-managed wrapper type.

Constructors

SocketControlMessage (ManagedPtr SocketControlMessage)

Instances

Eq SocketControlMessage

Defined in GI.Gio.Objects.SocketControlMessage

Methods

(==) :: SocketControlMessage -> SocketControlMessage -> Bool

(/=) :: SocketControlMessage -> SocketControlMessage -> Bool

GObject SocketControlMessage

Defined in GI.Gio.Objects.SocketControlMessage

Methods

gobjectType :: IO GType

IsGValue SocketControlMessage

Convert SocketControlMessage to and from GValue with toGValue and fromGValue.

Defined in GI.Gio.Objects.SocketControlMessage

Methods

toGValue :: SocketControlMessage -> IO GValue

fromGValue :: GValue -> IO SocketControlMessage

HasParentTypes SocketControlMessage

Defined in GI.Gio.Objects.SocketControlMessage

type ParentTypes SocketControlMessage

Defined in GI.Gio.Objects.SocketControlMessage

type ParentTypes SocketControlMessage = '[Object]

class (GObject o, IsDescendantOf SocketControlMessage o) => IsSocketControlMessage o

Type class for types which can be safely cast to SocketControlMessage, for instance with toSocketControlMessage.

Instances

(GObject o, IsDescendantOf SocketControlMessage o) => IsSocketControlMessage o

Defined in GI.Gio.Objects.SocketControlMessage

toSocketControlMessage :: (MonadIO m, IsSocketControlMessage o) => o -> m SocketControlMessage

Cast to SocketControlMessage, for types for which this is known to be safe. For general casts, use castTo.

noSocketControlMessage :: Maybe SocketControlMessage

A convenience alias for Nothing :: Maybe SocketControlMessage.

Methods

Overloaded methods

deserialize

socketControlMessageDeserialize

Arguments

:: (HasCallStack, MonadIO m)

=> Int32

level: a socket level

-> Int32

type: a socket control message type for the given level

-> ByteString

data: pointer to the message data

-> m SocketControlMessage

Returns: the deserialized message or Nothing

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

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

Since: 2.22

getLevel

socketControlMessageGetLevel

Arguments

:: (HasCallStack, MonadIO m, IsSocketControlMessage a)

=> a

message: a SocketControlMessage

-> m Int32

Returns: an integer describing the level

Returns the "level" (i.e. the originating protocol) of the control message. This is often SOL_SOCKET.

Since: 2.22

getMsgType

socketControlMessageGetMsgType

Arguments

:: (HasCallStack, MonadIO m, IsSocketControlMessage a)

=> a

message: a SocketControlMessage

-> m Int32

Returns: an integer describing the type of control message

Returns the protocol specific type of the control message. For instance, for UNIX fd passing this would be SCM_RIGHTS.

Since: 2.22

getSize

socketControlMessageGetSize

Arguments

:: (HasCallStack, MonadIO m, IsSocketControlMessage a)

=> a

message: a SocketControlMessage

-> m Word64

Returns: The number of bytes required.

Returns the space required for the control message, not including headers or alignment.

Since: 2.22

serialize

socketControlMessageSerialize

Arguments

:: (HasCallStack, MonadIO m, IsSocketControlMessage a)

=> a

message: a SocketControlMessage

-> Ptr ()

data: A buffer to write data to

-> m ()

Converts the data in the message to bytes placed in the message.

data is guaranteed to have enough space to fit the size returned by socketControlMessageGetSize on this object.

Since: 2.22