gi-gio
CopyrightWill Thompson and Iñaki García Etxebarria
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellNone
LanguageHaskell2010

GI.Gio.Objects.IPv6TclassMessage

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

Exported types

newtype IPv6TclassMessage Source #

Memory-managed wrapper type.

Instances

Instances details
Eq IPv6TclassMessage Source # 
Instance details

Defined in GI.Gio.Objects.IPv6TclassMessage

GObject IPv6TclassMessage Source # 
Instance details

Defined in GI.Gio.Objects.IPv6TclassMessage

ManagedPtrNewtype IPv6TclassMessage Source # 
Instance details

Defined in GI.Gio.Objects.IPv6TclassMessage

TypedObject IPv6TclassMessage Source # 
Instance details

Defined in GI.Gio.Objects.IPv6TclassMessage

Methods

glibType :: IO GType #

HasParentTypes IPv6TclassMessage Source # 
Instance details

Defined in GI.Gio.Objects.IPv6TclassMessage

HasAttributeList IPv6TclassMessage Source # 
Instance details

Defined in GI.Gio.Objects.IPv6TclassMessage

(info ~ ResolveIPv6TclassMessageMethod t IPv6TclassMessage, OverloadedMethod info IPv6TclassMessage p, HasField t IPv6TclassMessage p) => HasField (t :: Symbol) IPv6TclassMessage (p :: Type) Source # 
Instance details

Defined in GI.Gio.Objects.IPv6TclassMessage

(info ~ ResolveIPv6TclassMessageMethod t IPv6TclassMessage, OverloadedMethodInfo info IPv6TclassMessage) => IsLabel t (MethodProxy info IPv6TclassMessage) Source # 
Instance details

Defined in GI.Gio.Objects.IPv6TclassMessage

(info ~ ResolveIPv6TclassMessageMethod t IPv6TclassMessage, OverloadedMethod info IPv6TclassMessage p) => IsLabel t (IPv6TclassMessage -> p) Source # 
Instance details

Defined in GI.Gio.Objects.IPv6TclassMessage

IsGValue (Maybe IPv6TclassMessage) Source #

Convert IPv6TclassMessage to and from GValue. See toGValue and fromGValue.

Instance details

Defined in GI.Gio.Objects.IPv6TclassMessage

type AttributeList IPv6TclassMessage Source # 
Instance details

Defined in GI.Gio.Objects.IPv6TclassMessage

type ParentTypes IPv6TclassMessage Source # 
Instance details

Defined in GI.Gio.Objects.IPv6TclassMessage

type SignalList IPv6TclassMessage Source # 
Instance details

Defined in GI.Gio.Objects.IPv6TclassMessage

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

Instances details
(GObject o, IsDescendantOf IPv6TclassMessage o) => IsIPv6TclassMessage o Source # 
Instance details

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

type family ResolveIPv6TclassMessageMethod (t :: Symbol) o where ... Source #

Equations

ResolveIPv6TclassMessageMethod "bindProperty" o = ObjectBindPropertyMethodInfo 
ResolveIPv6TclassMessageMethod "bindPropertyFull" o = ObjectBindPropertyFullMethodInfo 
ResolveIPv6TclassMessageMethod "forceFloating" o = ObjectForceFloatingMethodInfo 
ResolveIPv6TclassMessageMethod "freezeNotify" o = ObjectFreezeNotifyMethodInfo 
ResolveIPv6TclassMessageMethod "getv" o = ObjectGetvMethodInfo 
ResolveIPv6TclassMessageMethod "isFloating" o = ObjectIsFloatingMethodInfo 
ResolveIPv6TclassMessageMethod "notify" o = ObjectNotifyMethodInfo 
ResolveIPv6TclassMessageMethod "notifyByPspec" o = ObjectNotifyByPspecMethodInfo 
ResolveIPv6TclassMessageMethod "ref" o = ObjectRefMethodInfo 
ResolveIPv6TclassMessageMethod "refSink" o = ObjectRefSinkMethodInfo 
ResolveIPv6TclassMessageMethod "runDispose" o = ObjectRunDisposeMethodInfo 
ResolveIPv6TclassMessageMethod "serialize" o = SocketControlMessageSerializeMethodInfo 
ResolveIPv6TclassMessageMethod "stealData" o = ObjectStealDataMethodInfo 
ResolveIPv6TclassMessageMethod "stealQdata" o = ObjectStealQdataMethodInfo 
ResolveIPv6TclassMessageMethod "thawNotify" o = ObjectThawNotifyMethodInfo 
ResolveIPv6TclassMessageMethod "unref" o = ObjectUnrefMethodInfo 
ResolveIPv6TclassMessageMethod "watchClosure" o = ObjectWatchClosureMethodInfo 
ResolveIPv6TclassMessageMethod "getData" o = ObjectGetDataMethodInfo 
ResolveIPv6TclassMessageMethod "getDscp" o = IPv6TclassMessageGetDscpMethodInfo 
ResolveIPv6TclassMessageMethod "getEcn" o = IPv6TclassMessageGetEcnMethodInfo 
ResolveIPv6TclassMessageMethod "getLevel" o = SocketControlMessageGetLevelMethodInfo 
ResolveIPv6TclassMessageMethod "getMsgType" o = SocketControlMessageGetMsgTypeMethodInfo 
ResolveIPv6TclassMessageMethod "getProperty" o = ObjectGetPropertyMethodInfo 
ResolveIPv6TclassMessageMethod "getQdata" o = ObjectGetQdataMethodInfo 
ResolveIPv6TclassMessageMethod "getSize" o = SocketControlMessageGetSizeMethodInfo 
ResolveIPv6TclassMessageMethod "setData" o = ObjectSetDataMethodInfo 
ResolveIPv6TclassMessageMethod "setDataFull" o = ObjectSetDataFullMethodInfo 
ResolveIPv6TclassMessageMethod "setProperty" o = ObjectSetPropertyMethodInfo 
ResolveIPv6TclassMessageMethod l o = MethodResolutionFailed l o :: Type 

getDscp

iPv6TclassMessageGetDscp Source #

Arguments

:: (HasCallStack, MonadIO m, IsIPv6TclassMessage a) 
=> a

message: a traffic class message

-> 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

message: a traffic class message

-> 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

iPv6TclassMessageNew Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> Word8

dscp: the DSCP value of the message

-> EcnCodePoint

ecn: the ECN value of the message

-> m IPv6TclassMessage

Returns: a new traffic class message

Creates a new traffic class message with given DSCP and ECN values.

Since: 2.88