GI.Gio.Structs.InputMessage

Structure used for scatter/gather data input when receiving multiple messages or packets in one go. You generally pass in an array of empty #GInputVectors and the operation will use all the buffers as if they were one buffer, and will set @bytes_received to the total number of bytes received across all #GInputVectors.

This structure closely mirrors `struct mmsghdr` and `struct msghdr` from the POSIX sockets API (see `man 2 recvmmsg`).

If @address is non-%NULL then it is set to the source address the message was received from, and the caller must free it afterwards.

If control_messages is non-%NULL then it is set to an array of control messages received with the message (if any), and the caller must free it afterwards. num_control_messages is set to the number of elements in this array, which may be zero.

Flags relevant to this message will be returned in @flags. For example, MSG_EOR or MSG_TRUNC.

Exported types

newtype InputMessage

Constructors

InputMessage (ManagedPtr InputMessage)

Instances

WrappedPtr InputMessage

Methods

wrappedPtrCalloc :: IO (Ptr InputMessage)

wrappedPtrCopy :: Ptr InputMessage -> IO (Ptr InputMessage)

wrappedPtrFree :: Maybe (FunPtr (Ptr InputMessage -> IO ()))

(~) AttrOpTag tag AttrSet => Constructible InputMessage tag

Methods

new :: MonadIO m => (ManagedPtr InputMessage -> InputMessage) -> [AttrOp InputMessage tag] -> m InputMessage

((~) * info (ResolveInputMessageMethod t InputMessage), MethodInfo * info InputMessage p) => IsLabel t (InputMessage -> p)

Methods

fromLabel :: Proxy# Symbol t -> InputMessage -> p

((~) * info (ResolveInputMessageMethod t InputMessage), MethodInfo * info InputMessage p) => IsLabelProxy t (InputMessage -> p)

Methods

fromLabelProxy :: Proxy Symbol t -> InputMessage -> p

HasAttributeList * InputMessage

type AttributeList InputMessage

type AttributeList InputMessage

newZeroInputMessage :: MonadIO m => m InputMessage

Construct a InputMessage struct initialized to zero.

noInputMessage :: Maybe InputMessage

Properties

address

clearInputMessageAddress :: MonadIO m => InputMessage -> m ()

getInputMessageAddress :: MonadIO m => InputMessage -> m (Maybe SocketAddress)

inputMessage_address :: AttrLabelProxy "address"

setInputMessageAddress :: MonadIO m => InputMessage -> Ptr SocketAddress -> m ()

bytesReceived

getInputMessageBytesReceived :: MonadIO m => InputMessage -> m Word64

inputMessage_bytesReceived :: AttrLabelProxy "bytesReceived"

setInputMessageBytesReceived :: MonadIO m => InputMessage -> Word64 -> m ()

flags

getInputMessageFlags :: MonadIO m => InputMessage -> m Int32

inputMessage_flags :: AttrLabelProxy "flags"

setInputMessageFlags :: MonadIO m => InputMessage -> Int32 -> m ()

numControlMessages

getInputMessageNumControlMessages :: MonadIO m => InputMessage -> m Word32

inputMessage_numControlMessages :: AttrLabelProxy "numControlMessages"

setInputMessageNumControlMessages :: MonadIO m => InputMessage -> Word32 -> m ()

numVectors

getInputMessageNumVectors :: MonadIO m => InputMessage -> m Word32

inputMessage_numVectors :: AttrLabelProxy "numVectors"

setInputMessageNumVectors :: MonadIO m => InputMessage -> Word32 -> m ()