| 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.IPv6TclassMessage
Contents
Description
Contains the Traffic Class byte of an IPv6 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_IPV6 family with
G_SOCKET_TYPE_DATAGRAM type). The message is not meant for sending. To set
Traffic Class field to be used in datagrams sent on a Socket use:
c code
g_socket_set_option (socket, IPPROTO_IPV6, IPV6_TCLASS, <TC value>, &error);
Since: 2.88
Synopsis
- newtype IPv6TclassMessage = IPv6TclassMessage (ManagedPtr IPv6TclassMessage)
- class (GObject o, IsDescendantOf IPv6TclassMessage o) => IsIPv6TclassMessage o
- toIPv6TclassMessage :: (MonadIO m, IsIPv6TclassMessage o) => o -> m IPv6TclassMessage
- iPv6TclassMessageGetDscp :: (HasCallStack, MonadIO m, IsIPv6TclassMessage a) => a -> m Word8
- iPv6TclassMessageGetEcn :: (HasCallStack, MonadIO m, IsIPv6TclassMessage a) => a -> m EcnCodePoint
- iPv6TclassMessageNew :: (HasCallStack, MonadIO m) => Word8 -> EcnCodePoint -> m IPv6TclassMessage
Exported types
newtype IPv6TclassMessage Source #
Memory-managed wrapper type.
Constructors
| IPv6TclassMessage (ManagedPtr IPv6TclassMessage) |
Instances
class (GObject o, IsDescendantOf IPv6TclassMessage o) => IsIPv6TclassMessage o Source #
Type class for types which can be safely cast to IPv6TclassMessage, for instance with toIPv6TclassMessage.
Instances
| (GObject o, IsDescendantOf IPv6TclassMessage o) => IsIPv6TclassMessage o Source # | |
Defined in GI.Gio.Objects.IPv6TclassMessage | |
toIPv6TclassMessage :: (MonadIO m, IsIPv6TclassMessage o) => o -> m IPv6TclassMessage Source #
Cast to IPv6TclassMessage, 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
iPv6TclassMessageGetDscp Source #
Arguments
| :: (HasCallStack, MonadIO m, IsIPv6TclassMessage 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
iPv6TclassMessageGetEcn Source #
Arguments
| :: (HasCallStack, MonadIO m, IsIPv6TclassMessage 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 IPv6TclassMessage | Returns: a new traffic class message |
Creates a new traffic class message with given DSCP and ECN values.
Since: 2.88