| 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
- clearOutputMessageAddress :: MonadIO m => OutputMessage -> m ()
- getOutputMessageAddress :: MonadIO m => OutputMessage -> m (Maybe SocketAddress)
- outputMessageAddress :: AttrLabelProxy "address"
- setOutputMessageAddress :: MonadIO m => OutputMessage -> Ptr SocketAddress -> m ()
- getOutputMessageBytesSent :: MonadIO m => OutputMessage -> m Word32
- outputMessageBytesSent :: AttrLabelProxy "bytesSent"
- setOutputMessageBytesSent :: MonadIO m => OutputMessage -> Word32 -> m ()
- getOutputMessageNumControlMessages :: MonadIO m => OutputMessage -> m Word32
- outputMessageNumControlMessages :: AttrLabelProxy "numControlMessages"
- setOutputMessageNumControlMessages :: MonadIO m => OutputMessage -> Word32 -> m ()
- getOutputMessageNumVectors :: MonadIO m => OutputMessage -> m Word32
- outputMessageNumVectors :: AttrLabelProxy "numVectors"
- setOutputMessageNumVectors :: MonadIO m => OutputMessage -> Word32 -> m ()
- clearOutputMessageVectors :: MonadIO m => OutputMessage -> m ()
- getOutputMessageVectors :: MonadIO m => OutputMessage -> m (Maybe OutputVector)
- outputMessageVectors :: AttrLabelProxy "vectors"
- setOutputMessageVectors :: MonadIO m => OutputMessage -> Ptr OutputVector -> m ()
Exported types
newtype OutputMessage Source #
Constructors
| OutputMessage (ForeignPtr OutputMessage) |
Instances
| WrappedPtr OutputMessage Source # | |
| (~) AttrOpTag tag AttrSet => Constructible OutputMessage tag Source # | |
| ((~) * info (ResolveOutputMessageMethod t OutputMessage), MethodInfo * info OutputMessage p) => IsLabel t (OutputMessage -> p) Source # | |
| ((~) * info (ResolveOutputMessageMethod t OutputMessage), MethodInfo * info OutputMessage p) => IsLabelProxy t (OutputMessage -> p) Source # | |
| HasAttributeList * OutputMessage Source # | |
| type AttributeList OutputMessage Source # | |
newZeroOutputMessage :: MonadIO m => m OutputMessage Source #
Construct a OutputMessage struct initialized to zero.
Properties
Address
clearOutputMessageAddress :: MonadIO m => OutputMessage -> m () Source #
getOutputMessageAddress :: MonadIO m => OutputMessage -> m (Maybe SocketAddress) Source #
outputMessageAddress :: AttrLabelProxy "address" Source #
setOutputMessageAddress :: MonadIO m => OutputMessage -> Ptr SocketAddress -> m () Source #
BytesSent
getOutputMessageBytesSent :: MonadIO m => OutputMessage -> m Word32 Source #
outputMessageBytesSent :: AttrLabelProxy "bytesSent" Source #
setOutputMessageBytesSent :: MonadIO m => OutputMessage -> Word32 -> m () Source #
NumControlMessages
getOutputMessageNumControlMessages :: MonadIO m => OutputMessage -> m Word32 Source #
outputMessageNumControlMessages :: AttrLabelProxy "numControlMessages" Source #
setOutputMessageNumControlMessages :: MonadIO m => OutputMessage -> Word32 -> m () Source #
NumVectors
getOutputMessageNumVectors :: MonadIO m => OutputMessage -> m Word32 Source #
outputMessageNumVectors :: AttrLabelProxy "numVectors" Source #
setOutputMessageNumVectors :: MonadIO m => OutputMessage -> Word32 -> m () Source #
Vectors
clearOutputMessageVectors :: MonadIO m => OutputMessage -> m () Source #
getOutputMessageVectors :: MonadIO m => OutputMessage -> m (Maybe OutputVector) Source #
outputMessageVectors :: AttrLabelProxy "vectors" Source #
setOutputMessageVectors :: MonadIO m => OutputMessage -> Ptr OutputVector -> m () Source #