| Copyright | Will Thompson and Iñaki García Etxebarria |
|---|---|
| License | LGPL-2.1 |
| Maintainer | Iñaki García Etxebarria |
| Safe Haskell | None |
| Language | Haskell2010 |
GI.Gio.Objects.IPTosMessage
Contents
Description
Contains the type of service (ToS) byte of an IPv4 header.
This consists of the DSCP field as per RFC 2474, and the ECN field as per RFC 3168.
It may be received using socketReceiveMessage over UDP sockets
(i.e. sockets in the G_SOCKET_FAMILY_IPV4 family with
G_SOCKET_TYPE_DATAGRAM type). The message is not meant for sending. To set
ToS field to be used in datagrams sent on a Socket use:
c code
g_socket_set_option (socket, IPPROTO_IP, IP_TOS, <ToS value>, &error);
Since: 2.88
Synopsis
- newtype IPTosMessage = IPTosMessage (ManagedPtr IPTosMessage)
- class (GObject o, IsDescendantOf IPTosMessage o) => IsIPTosMessage o
- toIPTosMessage :: (MonadIO m, IsIPTosMessage o) => o -> m IPTosMessage
- iPTosMessageGetDscp :: (HasCallStack, MonadIO m, IsIPTosMessage a) => a -> m Word8
- iPTosMessageGetEcn :: (HasCallStack, MonadIO m, IsIPTosMessage a) => a -> m EcnCodePoint
- iPTosMessageNew :: (HasCallStack, MonadIO m) => Word8 -> EcnCodePoint -> m IPTosMessage
Exported types
newtype IPTosMessage Source #
Memory-managed wrapper type.
Constructors
| IPTosMessage (ManagedPtr IPTosMessage) |
Instances
| Eq IPTosMessage Source # | |
Defined in GI.Gio.Objects.IPTosMessage | |
| GObject IPTosMessage Source # | |
Defined in GI.Gio.Objects.IPTosMessage | |
| ManagedPtrNewtype IPTosMessage Source # | |
Defined in GI.Gio.Objects.IPTosMessage Methods | |
| TypedObject IPTosMessage Source # | |
Defined in GI.Gio.Objects.IPTosMessage | |
| HasParentTypes IPTosMessage Source # | |
Defined in GI.Gio.Objects.IPTosMessage | |
| IsGValue (Maybe IPTosMessage) Source # | Convert |
Defined in GI.Gio.Objects.IPTosMessage Methods gvalueGType_ :: IO GType # gvalueSet_ :: Ptr GValue -> Maybe IPTosMessage -> IO () # gvalueGet_ :: Ptr GValue -> IO (Maybe IPTosMessage) # | |
| type ParentTypes IPTosMessage Source # | |
Defined in GI.Gio.Objects.IPTosMessage | |
class (GObject o, IsDescendantOf IPTosMessage o) => IsIPTosMessage o Source #
Type class for types which can be safely cast to IPTosMessage, for instance with toIPTosMessage.
Instances
| (GObject o, IsDescendantOf IPTosMessage o) => IsIPTosMessage o Source # | |
Defined in GI.Gio.Objects.IPTosMessage | |
toIPTosMessage :: (MonadIO m, IsIPTosMessage o) => o -> m IPTosMessage Source #
Cast to IPTosMessage, for types for which this is known to be safe. For general casts, use castTo.
Methods
Click to display all available methods, including inherited ones
Methods
bindProperty, bindPropertyFull, forceFloating, freezeNotify, getv, isFloating, notify, notifyByPspec, ref, refSink, runDispose, serialize, stealData, stealQdata, thawNotify, unref, watchClosure.
Getters
getData, getDscp, getEcn, getLevel, getMsgType, getProperty, getQdata, getSize.
Setters
getDscp
Arguments
| :: (HasCallStack, MonadIO m, IsIPTosMessage a) | |
| => a |
|
| -> m Word8 | Returns: A DSCP value as described in RFC 2474. |
Gets the differentiated services code point stored in message.
Since: 2.88
getEcn
Arguments
| :: (HasCallStack, MonadIO m, IsIPTosMessage a) | |
| => a |
|
| -> m EcnCodePoint | Returns: An ECN value as described in RFC 3168. |
Gets the Explicit Congestion Notification code point stored in message.
Since: 2.88
new
Arguments
| :: (HasCallStack, MonadIO m) | |
| => Word8 |
|
| -> EcnCodePoint |
|
| -> m IPTosMessage | Returns: a new type-of-service message |
Creates a new type-of-service message with given DSCP and ECN values.
Since: 2.88