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 bytesReceived 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-Nothing then it is set to the source address the message was received from, and the caller must free it afterwards.

If controlMessages is non-Nothing then it is set to an array of control messages received with the message (if any), and the caller must free it afterwards. numControlMessages 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 :: InputMessage -> IO 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

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)

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

bytesReceived

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

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

flags

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

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

numControlMessages

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

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

numVectors

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

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