| Copyright | Will Thompson, Iñaki García Etxebarria and Jonas Platte |
|---|---|
| License | LGPL-2.1 |
| Maintainer | Iñaki García Etxebarria (garetxe@gmail.com) |
| Safe Haskell | None |
| Language | Haskell2010 |
GI.Gio.Structs.OutputMessage
Description
Structure used for scatter/gather data output when sending multiple messages or packets in one go. You generally pass in an array of #GOutputVectors and the operation will use all the buffers as if they were one buffer.
If @address is %NULL then the message is sent to the default receiver (as previously set by g_socket_connect()).
- newtype OutputMessage = OutputMessage (ForeignPtr OutputMessage)
- newZeroOutputMessage :: MonadIO m => m OutputMessage
- noOutputMessage :: Maybe OutputMessage
- outputMessageAddress :: AttrLabelProxy "address"
- outputMessageClearAddress :: MonadIO m => OutputMessage -> m ()
- outputMessageReadAddress :: MonadIO m => OutputMessage -> m (Maybe SocketAddress)
- outputMessageWriteAddress :: MonadIO m => OutputMessage -> Ptr SocketAddress -> m ()
- outputMessageBytesSent :: AttrLabelProxy "bytesSent"
- outputMessageReadBytesSent :: MonadIO m => OutputMessage -> m Word32
- outputMessageWriteBytesSent :: MonadIO m => OutputMessage -> Word32 -> m ()
- outputMessageNumControlMessages :: AttrLabelProxy "numControlMessages"
- outputMessageReadNumControlMessages :: MonadIO m => OutputMessage -> m Word32
- outputMessageWriteNumControlMessages :: MonadIO m => OutputMessage -> Word32 -> m ()
- outputMessageNumVectors :: AttrLabelProxy "numVectors"
- outputMessageReadNumVectors :: MonadIO m => OutputMessage -> m Word32
- outputMessageWriteNumVectors :: MonadIO m => OutputMessage -> Word32 -> m ()
- outputMessageClearVectors :: MonadIO m => OutputMessage -> m ()
- outputMessageReadVectors :: MonadIO m => OutputMessage -> m (Maybe OutputVector)
- outputMessageVectors :: AttrLabelProxy "vectors"
- outputMessageWriteVectors :: MonadIO m => OutputMessage -> Ptr OutputVector -> m ()
Exported types
newtype OutputMessage Source
Constructors
| OutputMessage (ForeignPtr OutputMessage) |
Instances
| WrappedPtr OutputMessage | |
| (~) AttrOpTag tag AttrSet => Constructible OutputMessage tag | |
| ((~) * info (ResolveOutputMessageMethod t OutputMessage), MethodInfo * info OutputMessage p) => IsLabelProxy t (OutputMessage -> p) | |
| type AttributeList OutputMessage |
newZeroOutputMessage :: MonadIO m => m OutputMessage Source
Construct a OutputMessage struct initialized to zero.
Properties
Address
outputMessageAddress :: AttrLabelProxy "address" Source
outputMessageClearAddress :: MonadIO m => OutputMessage -> m () Source
outputMessageReadAddress :: MonadIO m => OutputMessage -> m (Maybe SocketAddress) Source
outputMessageWriteAddress :: MonadIO m => OutputMessage -> Ptr SocketAddress -> m () Source
BytesSent
outputMessageBytesSent :: AttrLabelProxy "bytesSent" Source
outputMessageReadBytesSent :: MonadIO m => OutputMessage -> m Word32 Source
outputMessageWriteBytesSent :: MonadIO m => OutputMessage -> Word32 -> m () Source
NumControlMessages
outputMessageNumControlMessages :: AttrLabelProxy "numControlMessages" Source
outputMessageReadNumControlMessages :: MonadIO m => OutputMessage -> m Word32 Source
outputMessageWriteNumControlMessages :: MonadIO m => OutputMessage -> Word32 -> m () Source
NumVectors
outputMessageNumVectors :: AttrLabelProxy "numVectors" Source
outputMessageReadNumVectors :: MonadIO m => OutputMessage -> m Word32 Source
outputMessageWriteNumVectors :: MonadIO m => OutputMessage -> Word32 -> m () Source
Vectors
outputMessageClearVectors :: MonadIO m => OutputMessage -> m () Source
outputMessageReadVectors :: MonadIO m => OutputMessage -> m (Maybe OutputVector) Source
outputMessageVectors :: AttrLabelProxy "vectors" Source
outputMessageWriteVectors :: MonadIO m => OutputMessage -> Ptr OutputVector -> m () Source