Copyright	(c) Formaltech Inc. 2017
License	BSD3
Maintainer	protob3n@gmail.com
Stability	experimental
Portability	Linux
Safe Haskell	None
Language	Haskell2010

System.Linux.RTNetlink.Message

Description

A netlink packet contains a top-level header (struct nlmsghdr from linux/netlink.h), a second-level header that depends on the message type (e.g., struct ifinfomsg from linux/if_link.h), and a possibly nested collection of attributes (see System.Linux.RTNetlink.Packet).

The way to create a netlink packet in RTNetlink is to instantiate either the Message or the Reply class, which entails specifying what the header type should be. You can then instantiate any of the Create, Destroy, Change, or Request classes to indicate which kinds of actions the message can be used to perform.

Synopsis

type SequenceNumber = Word32
sequenceNumber :: ByteString -> SequenceNumber
data NLMsgErr = NLMsgErr {
- nleError :: Int32
- nleHeader :: NLMsgHdr
}
class (Show h, Eq h, Sized h, Serialize h) => Header h where
- type HeaderPart h
- fromHeaderParts :: [HeaderPart h] -> h
- emptyHeader :: h
class Header h => CreateMessageHeader h where
- createTypeNumber :: h -> TypeNumber
class Header h => DestroyMessageHeader h where
- destroyTypeNumber :: h -> TypeNumber
class Header h => ChangeMessageHeader h where
- changeTypeNumber :: h -> TypeNumber
class Header h => RequestMessageHeader h where
- requestTypeNumber :: h -> TypeNumber
class Header h => ReplyMessageHeader h where
- replyTypeNumbers :: h -> [TypeNumber]
class Header (MessageHeader m) => Message m where
- type MessageHeader m
- messageHeaderParts :: m -> [HeaderPart (MessageHeader m)]
- messageAttrs :: m -> AttributeList
messageHeader :: Message m => m -> MessageHeader m
toNLMessage :: Message m => m -> (MessageHeader m -> TypeNumber) -> NLFlags -> SequenceNumber -> NLMessage (MessageHeader m)
class (Message c, CreateMessageHeader (MessageHeader c)) => Create c
createNLMessage :: Create c => c -> SequenceNumber -> NLMessage (MessageHeader c)
class (Message d, DestroyMessageHeader (MessageHeader d)) => Destroy d
destroyNLMessage :: Destroy d => d -> SequenceNumber -> NLMessage (MessageHeader d)
class (Message id, ChangeMessageHeader (MessageHeader id)) => Change id c where
- changeHeaderParts :: id -> c -> [HeaderPart (MessageHeader id)]
- changeAttrs :: id -> c -> AttributeList
changeNLMessage :: Change id c => id -> c -> SequenceNumber -> NLMessage (MessageHeader id)
class (Message r, RequestMessageHeader (MessageHeader r)) => Request r where
- requestNLFlags :: r -> ChangeFlags NLFlags
requestNLMessage :: Request r => r -> SequenceNumber -> NLMessage (MessageHeader r)
dumpOne :: a -> ChangeFlags NLFlags
dumpMany :: a -> ChangeFlags NLFlags
class ReplyMessageHeader (ReplyHeader r) => Reply r where
- type ReplyHeader r
- fromNLMessage :: NLMessage (ReplyHeader r) -> Maybe r

Documentation

type SequenceNumber = Word32 Source #

Sequence number for an NlMsgHdr.

sequenceNumber :: ByteString -> SequenceNumber Source #

Get the sequence number of a message started by an NLMsgHdr.

data NLMsgErr Source #

The header of an error sent in response to a bad netlink message. The numeric values correspond to negated values from Foreign.C.Error. Try running man 3 errno for more information.

Constructors

NLMsgErr
Fields nleError :: Int32 Negated numeric error code. nleHeader :: NLMsgHdr The header of the offending message.

Instances

Eq NLMsgErr Source #
Instance details Defined in System.Linux.RTNetlink.Message Methods (==) :: NLMsgErr -> NLMsgErr -> Bool # (/=) :: NLMsgErr -> NLMsgErr -> Bool #
Show NLMsgErr Source #
Instance details Defined in System.Linux.RTNetlink.Message Methods showsPrec :: Int -> NLMsgErr -> ShowS # show :: NLMsgErr -> String # showList :: [NLMsgErr] -> ShowS #
Serialize NLMsgErr Source #
Instance details Defined in System.Linux.RTNetlink.Message Methods put :: Putter NLMsgErr # get :: Get NLMsgErr #
Sized NLMsgErr Source #
Instance details Defined in System.Linux.RTNetlink.Message Methods size :: Integral i => NLMsgErr -> i Source # sizeAligned :: Integral a => a -> NLMsgErr -> a Source #
ReplyMessageHeader NLMsgErr Source #
Instance details Defined in System.Linux.RTNetlink.Message Methods replyTypeNumbers :: NLMsgErr -> [TypeNumber] Source #
Header NLMsgErr Source #
Instance details Defined in System.Linux.RTNetlink.Message Associated Types type HeaderPart NLMsgErr :: Type Source # Methods fromHeaderParts :: [HeaderPart NLMsgErr] -> NLMsgErr Source # emptyHeader :: NLMsgErr Source #
type HeaderPart NLMsgErr Source #
Instance details Defined in System.Linux.RTNetlink.Message type HeaderPart NLMsgErr = NLMsgErrPart

class (Show h, Eq h, Sized h, Serialize h) => Header h where Source #

Class of things that can be used as second-level netlink headers.

Associated Types

type HeaderPart h Source #

Components for a Header, so they can be combined.

Methods

fromHeaderParts :: [HeaderPart h] -> h Source #

How to construct a Header from a list of HeaderParts. An empty list should correspond to emptyHeader.

emptyHeader :: h Source #

Default header for a message, if none is specified.

class Header h => CreateMessageHeader h where Source #

Class of headers that can be used to create things.

Methods

createTypeNumber :: h -> TypeNumber Source #

The top-level type number associated with create messages with this header.

Instances

CreateMessageHeader IfInfoMsg Source #
Instance details Defined in System.Linux.RTNetlink.Link Methods createTypeNumber :: IfInfoMsg -> TypeNumber Source #
CreateMessageHeader IfAddrMsg Source #
Instance details Defined in System.Linux.RTNetlink.Address Methods createTypeNumber :: IfAddrMsg -> TypeNumber Source #

class Header h => DestroyMessageHeader h where Source #

Class of headers that can be used to destroy things.

Methods

destroyTypeNumber :: h -> TypeNumber Source #

The top-level type number associated with destroy messages with this header.

Instances

DestroyMessageHeader IfInfoMsg Source #
Instance details Defined in System.Linux.RTNetlink.Link Methods destroyTypeNumber :: IfInfoMsg -> TypeNumber Source #
DestroyMessageHeader IfAddrMsg Source #
Instance details Defined in System.Linux.RTNetlink.Address Methods destroyTypeNumber :: IfAddrMsg -> TypeNumber Source #

class Header h => ChangeMessageHeader h where Source #

Class of headers that can be used to change things.

Methods

changeTypeNumber :: h -> TypeNumber Source #

The top-level type number associated with change messages with this header.

Instances

ChangeMessageHeader IfInfoMsg Source #
Instance details Defined in System.Linux.RTNetlink.Link Methods changeTypeNumber :: IfInfoMsg -> TypeNumber Source #

class Header h => RequestMessageHeader h where Source #

Class of headers that can be used to request things.

Methods

requestTypeNumber :: h -> TypeNumber Source #

The top-level type number associated with request messages with this header.

Instances

RequestMessageHeader IfInfoMsg Source #
Instance details Defined in System.Linux.RTNetlink.Link Methods requestTypeNumber :: IfInfoMsg -> TypeNumber Source #
RequestMessageHeader IfAddrMsg Source #
Instance details Defined in System.Linux.RTNetlink.Address Methods requestTypeNumber :: IfAddrMsg -> TypeNumber Source #

class Header h => ReplyMessageHeader h where Source #

Class of headers that can be received in reply messages.

Methods

replyTypeNumbers :: h -> [TypeNumber] Source #

The expected top-level type number(s) that mark a packet replies with this header can be parsed from.

Instances

ReplyMessageHeader () Source #
Instance details Defined in System.Linux.RTNetlink.Message Methods replyTypeNumbers :: () -> [TypeNumber] Source #
ReplyMessageHeader NLMsgErr Source #
Instance details Defined in System.Linux.RTNetlink.Message Methods replyTypeNumbers :: NLMsgErr -> [TypeNumber] Source #
ReplyMessageHeader IfInfoMsg Source #
Instance details Defined in System.Linux.RTNetlink.Link Methods replyTypeNumbers :: IfInfoMsg -> [TypeNumber] Source #
ReplyMessageHeader IfAddrMsg Source #
Instance details Defined in System.Linux.RTNetlink.Address Methods replyTypeNumbers :: IfAddrMsg -> [TypeNumber] Source #

class Header (MessageHeader m) => Message m where Source #

Class of things that can be sent as messages.

Minimal complete definition

Nothing

Associated Types

type MessageHeader m Source #

The type of header to attach to the message.

Methods

messageHeaderParts :: m -> [HeaderPart (MessageHeader m)] Source #

Parts to construct a header corresponding to a message. Defaults to [].

messageAttrs :: m -> AttributeList Source #

Construct netlink attributes corresponding to a message. Defaults to [].

Instances

Message Inet6Address Source #
Instance details Defined in System.Linux.RTNetlink.Address Associated Types type MessageHeader Inet6Address :: Type Source # Methods messageHeaderParts :: Inet6Address -> [HeaderPart (MessageHeader Inet6Address)] Source # messageAttrs :: Inet6Address -> AttributeList Source #
Message InetAddress Source #
Instance details Defined in System.Linux.RTNetlink.Address Associated Types type MessageHeader InetAddress :: Type Source # Methods messageHeaderParts :: InetAddress -> [HeaderPart (MessageHeader InetAddress)] Source # messageAttrs :: InetAddress -> AttributeList Source #
Message LinkMTU Source #
Instance details Defined in System.Linux.RTNetlink.Link Associated Types type MessageHeader LinkMTU :: Type Source # Methods messageHeaderParts :: LinkMTU -> [HeaderPart (MessageHeader LinkMTU)] Source # messageAttrs :: LinkMTU -> AttributeList Source #
Message LinkMaster Source #
Instance details Defined in System.Linux.RTNetlink.Link Associated Types type MessageHeader LinkMaster :: Type Source # Methods messageHeaderParts :: LinkMaster -> [HeaderPart (MessageHeader LinkMaster)] Source # messageAttrs :: LinkMaster -> AttributeList Source #
Message VlanId Source #
Instance details Defined in System.Linux.RTNetlink.Link Associated Types type MessageHeader VlanId :: Type Source # Methods messageHeaderParts :: VlanId -> [HeaderPart (MessageHeader VlanId)] Source # messageAttrs :: VlanId -> AttributeList Source #
Message LinkType Source #
Instance details Defined in System.Linux.RTNetlink.Link Associated Types type MessageHeader LinkType :: Type Source # Methods messageHeaderParts :: LinkType -> [HeaderPart (MessageHeader LinkType)] Source # messageAttrs :: LinkType -> AttributeList Source #
Message AnyLink Source #
Instance details Defined in System.Linux.RTNetlink.Link Associated Types type MessageHeader AnyLink :: Type Source # Methods messageHeaderParts :: AnyLink -> [HeaderPart (MessageHeader AnyLink)] Source # messageAttrs :: AnyLink -> AttributeList Source #
Message LinkBroadcastEther Source #
Instance details Defined in System.Linux.RTNetlink.Link Associated Types type MessageHeader LinkBroadcastEther :: Type Source # Methods messageHeaderParts :: LinkBroadcastEther -> [HeaderPart (MessageHeader LinkBroadcastEther)] Source # messageAttrs :: LinkBroadcastEther -> AttributeList Source #
Message LinkEther Source #
Instance details Defined in System.Linux.RTNetlink.Link Associated Types type MessageHeader LinkEther :: Type Source # Methods messageHeaderParts :: LinkEther -> [HeaderPart (MessageHeader LinkEther)] Source # messageAttrs :: LinkEther -> AttributeList Source #
Message LinkName Source #
Instance details Defined in System.Linux.RTNetlink.Link Associated Types type MessageHeader LinkName :: Type Source # Methods messageHeaderParts :: LinkName -> [HeaderPart (MessageHeader LinkName)] Source # messageAttrs :: LinkName -> AttributeList Source #
Message LinkIndex Source #
Instance details Defined in System.Linux.RTNetlink.Link Associated Types type MessageHeader LinkIndex :: Type Source # Methods messageHeaderParts :: LinkIndex -> [HeaderPart (MessageHeader LinkIndex)] Source # messageAttrs :: LinkIndex -> AttributeList Source #
Message IfInet6Address Source #
Instance details Defined in System.Linux.RTNetlink.Address Associated Types type MessageHeader IfInet6Address :: Type Source # Methods messageHeaderParts :: IfInet6Address -> [HeaderPart (MessageHeader IfInet6Address)] Source # messageAttrs :: IfInet6Address -> AttributeList Source #
Message IfInetAddress Source #
Instance details Defined in System.Linux.RTNetlink.Address Associated Types type MessageHeader IfInetAddress :: Type Source # Methods messageHeaderParts :: IfInetAddress -> [HeaderPart (MessageHeader IfInetAddress)] Source # messageAttrs :: IfInetAddress -> AttributeList Source #
Message IfLabel Source #
Instance details Defined in System.Linux.RTNetlink.Address Associated Types type MessageHeader IfLabel :: Type Source # Methods messageHeaderParts :: IfLabel -> [HeaderPart (MessageHeader IfLabel)] Source # messageAttrs :: IfLabel -> AttributeList Source #
Message IfScope Source #
Instance details Defined in System.Linux.RTNetlink.Address Associated Types type MessageHeader IfScope :: Type Source # Methods messageHeaderParts :: IfScope -> [HeaderPart (MessageHeader IfScope)] Source # messageAttrs :: IfScope -> AttributeList Source #
Message IfLifetime Source #
Instance details Defined in System.Linux.RTNetlink.Address Associated Types type MessageHeader IfLifetime :: Type Source # Methods messageHeaderParts :: IfLifetime -> [HeaderPart (MessageHeader IfLifetime)] Source # messageAttrs :: IfLifetime -> AttributeList Source #
Message MulticastAutoJoin Source #
Instance details Defined in System.Linux.RTNetlink.Address Associated Types type MessageHeader MulticastAutoJoin :: Type Source # Methods messageHeaderParts :: MulticastAutoJoin -> [HeaderPart (MessageHeader MulticastAutoJoin)] Source # messageAttrs :: MulticastAutoJoin -> AttributeList Source #
Message PrefixRoute Source #
Instance details Defined in System.Linux.RTNetlink.Address Associated Types type MessageHeader PrefixRoute :: Type Source # Methods messageHeaderParts :: PrefixRoute -> [HeaderPart (MessageHeader PrefixRoute)] Source # messageAttrs :: PrefixRoute -> AttributeList Source #
Message Mip6Homing Source #
Instance details Defined in System.Linux.RTNetlink.Address Associated Types type MessageHeader Mip6Homing :: Type Source # Methods messageHeaderParts :: Mip6Homing -> [HeaderPart (MessageHeader Mip6Homing)] Source # messageAttrs :: Mip6Homing -> AttributeList Source #
Message DuplicateAddressDetection Source #
Instance details Defined in System.Linux.RTNetlink.Address Associated Types type MessageHeader DuplicateAddressDetection :: Type Source # Methods messageHeaderParts :: DuplicateAddressDetection -> [HeaderPart (MessageHeader DuplicateAddressDetection)] Source # messageAttrs :: DuplicateAddressDetection -> AttributeList Source #
Message IfPrefix Source #
Instance details Defined in System.Linux.RTNetlink.Address Associated Types type MessageHeader IfPrefix :: Type Source # Methods messageHeaderParts :: IfPrefix -> [HeaderPart (MessageHeader IfPrefix)] Source # messageAttrs :: IfPrefix -> AttributeList Source #
Message IfIndex Source #
Instance details Defined in System.Linux.RTNetlink.Address Associated Types type MessageHeader IfIndex :: Type Source # Methods messageHeaderParts :: IfIndex -> [HeaderPart (MessageHeader IfIndex)] Source # messageAttrs :: IfIndex -> AttributeList Source #
Message AnyInterface Source #
Instance details Defined in System.Linux.RTNetlink.Address Associated Types type MessageHeader AnyInterface :: Type Source # Methods messageHeaderParts :: AnyInterface -> [HeaderPart (MessageHeader AnyInterface)] Source # messageAttrs :: AnyInterface -> AttributeList Source #
(Message m, Message n, MessageHeader m ~ MessageHeader n) => Message (m, n) Source #
Instance details Defined in System.Linux.RTNetlink.Message Associated Types type MessageHeader (m, n) :: Type Source # Methods messageHeaderParts :: (m, n) -> [HeaderPart (MessageHeader (m, n))] Source # messageAttrs :: (m, n) -> AttributeList Source #

messageHeader :: Message m => m -> MessageHeader m Source #

Produce a MessageHeader from a Message using messageHeaderParts.

toNLMessage :: Message m => m -> (MessageHeader m -> TypeNumber) -> NLFlags -> SequenceNumber -> NLMessage (MessageHeader m) Source #

Produce an NLMessage suitable for sending over the wire.

class (Message c, CreateMessageHeader (MessageHeader c)) => Create c Source #

Class of Messages representing things that can be created.

Instances

Create LinkType Source #
Instance details Defined in System.Linux.RTNetlink.Link
Create IfInet6Address Source #
Instance details Defined in System.Linux.RTNetlink.Address
Create IfInetAddress Source #
Instance details Defined in System.Linux.RTNetlink.Address
(Create c, Create d, MessageHeader c ~ MessageHeader d) => Create (c, d) Source #
Instance details Defined in System.Linux.RTNetlink.Message
(Create c, MessageHeader c ~ IfInfoMsg) => Create (c, LinkBroadcastEther) Source #
Instance details Defined in System.Linux.RTNetlink.Link
(Create c, MessageHeader c ~ IfInfoMsg) => Create (c, LinkEther) Source #
Instance details Defined in System.Linux.RTNetlink.Link
(Create c, MessageHeader c ~ IfInfoMsg) => Create (c, LinkName) Source #
Instance details Defined in System.Linux.RTNetlink.Link
(Create c, MessageHeader c ~ IfInfoMsg) => Create (c, LinkIndex) Source #
Instance details Defined in System.Linux.RTNetlink.Link
(Create c, MessageHeader c ~ IfAddrMsg) => Create (c, IfLabel) Source #
Instance details Defined in System.Linux.RTNetlink.Address
(Create c, MessageHeader c ~ IfAddrMsg) => Create (c, IfScope) Source #
Instance details Defined in System.Linux.RTNetlink.Address
(Create c, MessageHeader c ~ IfAddrMsg) => Create (c, IfLifetime) Source #
Instance details Defined in System.Linux.RTNetlink.Address
(Create c, MessageHeader c ~ IfAddrMsg) => Create (c, PrefixRoute) Source #
Instance details Defined in System.Linux.RTNetlink.Address
(Create c, MessageHeader c ~ IfAddrMsg) => Create (c, DuplicateAddressDetection) Source #
Instance details Defined in System.Linux.RTNetlink.Address
(Create c, MessageHeader c ~ IfInfoMsg) => Create (LinkBroadcastEther, c) Source #
Instance details Defined in System.Linux.RTNetlink.Link
(Create c, MessageHeader c ~ IfInfoMsg) => Create (LinkEther, c) Source #
Instance details Defined in System.Linux.RTNetlink.Link
(Create c, MessageHeader c ~ IfInfoMsg) => Create (LinkName, c) Source #
Instance details Defined in System.Linux.RTNetlink.Link
(Create c, MessageHeader c ~ IfInfoMsg) => Create (LinkIndex, c) Source #
Instance details Defined in System.Linux.RTNetlink.Link
(Create c, MessageHeader c ~ IfAddrMsg) => Create (IfLabel, c) Source #
Instance details Defined in System.Linux.RTNetlink.Address
(Create c, MessageHeader c ~ IfAddrMsg) => Create (IfScope, c) Source #
Instance details Defined in System.Linux.RTNetlink.Address
(Create c, MessageHeader c ~ IfAddrMsg) => Create (IfLifetime, c) Source #
Instance details Defined in System.Linux.RTNetlink.Address
(Create c, MessageHeader c ~ IfAddrMsg) => Create (PrefixRoute, c) Source #
Instance details Defined in System.Linux.RTNetlink.Address
(Create c, MessageHeader c ~ IfAddrMsg) => Create (DuplicateAddressDetection, c) Source #
Instance details Defined in System.Linux.RTNetlink.Address

createNLMessage :: Create c => c -> SequenceNumber -> NLMessage (MessageHeader c) Source #

Produce an NLMessage suitable for sending over the wire.

class (Message d, DestroyMessageHeader (MessageHeader d)) => Destroy d Source #

Class of Messages representing things that can be destroyed.

Instances

Destroy LinkName Source #
Instance details Defined in System.Linux.RTNetlink.Link
Destroy LinkIndex Source #
Instance details Defined in System.Linux.RTNetlink.Link
Destroy IfInet6Address Source #
Instance details Defined in System.Linux.RTNetlink.Address
Destroy IfInetAddress Source #
Instance details Defined in System.Linux.RTNetlink.Address
(Destroy d, Destroy e, MessageHeader d ~ MessageHeader e) => Destroy (d, e) Source #
Instance details Defined in System.Linux.RTNetlink.Message

destroyNLMessage :: Destroy d => d -> SequenceNumber -> NLMessage (MessageHeader d) Source #

Produce an NLMessage suitable for sending over the wire.

class (Message id, ChangeMessageHeader (MessageHeader id)) => Change id c where Source #

Class of Messages representing pairs of identifying messages and quality that can be modified.

Minimal complete definition

Nothing

Methods

changeHeaderParts :: id -> c -> [HeaderPart (MessageHeader id)] Source #

Construct a list of HeaderParts from an identifier and a quality. By default, use the identifying message's messageHeaderParts.

changeAttrs :: id -> c -> AttributeList Source #

Construct an AttributeList from an identifier and a quality. By default, use the identifying message's messageAttrs.

Instances

Change LinkName LinkGroup Source #
Instance details Defined in System.Linux.RTNetlink.Link Methods changeHeaderParts :: LinkName -> LinkGroup -> [HeaderPart (MessageHeader LinkName)] Source # changeAttrs :: LinkName -> LinkGroup -> AttributeList Source #
Change LinkName LinkMTU Source #
Instance details Defined in System.Linux.RTNetlink.Link Methods changeHeaderParts :: LinkName -> LinkMTU -> [HeaderPart (MessageHeader LinkName)] Source # changeAttrs :: LinkName -> LinkMTU -> AttributeList Source #
Change LinkName LinkDebug Source #
Instance details Defined in System.Linux.RTNetlink.Link Methods changeHeaderParts :: LinkName -> LinkDebug -> [HeaderPart (MessageHeader LinkName)] Source # changeAttrs :: LinkName -> LinkDebug -> AttributeList Source #
Change LinkName LinkArp Source #
Instance details Defined in System.Linux.RTNetlink.Link Methods changeHeaderParts :: LinkName -> LinkArp -> [HeaderPart (MessageHeader LinkName)] Source # changeAttrs :: LinkName -> LinkArp -> AttributeList Source #
Change LinkName LinkPromiscuity Source #
Instance details Defined in System.Linux.RTNetlink.Link Methods changeHeaderParts :: LinkName -> LinkPromiscuity -> [HeaderPart (MessageHeader LinkName)] Source # changeAttrs :: LinkName -> LinkPromiscuity -> AttributeList Source #
Change LinkName LinkState Source #
Instance details Defined in System.Linux.RTNetlink.Link Methods changeHeaderParts :: LinkName -> LinkState -> [HeaderPart (MessageHeader LinkName)] Source # changeAttrs :: LinkName -> LinkState -> AttributeList Source #
Change LinkName LinkMaster Source #
Instance details Defined in System.Linux.RTNetlink.Link Methods changeHeaderParts :: LinkName -> LinkMaster -> [HeaderPart (MessageHeader LinkName)] Source # changeAttrs :: LinkName -> LinkMaster -> AttributeList Source #
Change LinkName LinkBroadcastEther Source #
Instance details Defined in System.Linux.RTNetlink.Link Methods changeHeaderParts :: LinkName -> LinkBroadcastEther -> [HeaderPart (MessageHeader LinkName)] Source # changeAttrs :: LinkName -> LinkBroadcastEther -> AttributeList Source #
Change LinkName LinkEther Source #
Instance details Defined in System.Linux.RTNetlink.Link Methods changeHeaderParts :: LinkName -> LinkEther -> [HeaderPart (MessageHeader LinkName)] Source # changeAttrs :: LinkName -> LinkEther -> AttributeList Source #
Change LinkIndex LinkGroup Source #
Instance details Defined in System.Linux.RTNetlink.Link Methods changeHeaderParts :: LinkIndex -> LinkGroup -> [HeaderPart (MessageHeader LinkIndex)] Source # changeAttrs :: LinkIndex -> LinkGroup -> AttributeList Source #
Change LinkIndex LinkMTU Source #
Instance details Defined in System.Linux.RTNetlink.Link Methods changeHeaderParts :: LinkIndex -> LinkMTU -> [HeaderPart (MessageHeader LinkIndex)] Source # changeAttrs :: LinkIndex -> LinkMTU -> AttributeList Source #
Change LinkIndex LinkDebug Source #
Instance details Defined in System.Linux.RTNetlink.Link Methods changeHeaderParts :: LinkIndex -> LinkDebug -> [HeaderPart (MessageHeader LinkIndex)] Source # changeAttrs :: LinkIndex -> LinkDebug -> AttributeList Source #
Change LinkIndex LinkArp Source #
Instance details Defined in System.Linux.RTNetlink.Link Methods changeHeaderParts :: LinkIndex -> LinkArp -> [HeaderPart (MessageHeader LinkIndex)] Source # changeAttrs :: LinkIndex -> LinkArp -> AttributeList Source #
Change LinkIndex LinkPromiscuity Source #
Instance details Defined in System.Linux.RTNetlink.Link Methods changeHeaderParts :: LinkIndex -> LinkPromiscuity -> [HeaderPart (MessageHeader LinkIndex)] Source # changeAttrs :: LinkIndex -> LinkPromiscuity -> AttributeList Source #
Change LinkIndex LinkState Source #
Instance details Defined in System.Linux.RTNetlink.Link Methods changeHeaderParts :: LinkIndex -> LinkState -> [HeaderPart (MessageHeader LinkIndex)] Source # changeAttrs :: LinkIndex -> LinkState -> AttributeList Source #
Change LinkIndex LinkMaster Source #
Instance details Defined in System.Linux.RTNetlink.Link Methods changeHeaderParts :: LinkIndex -> LinkMaster -> [HeaderPart (MessageHeader LinkIndex)] Source # changeAttrs :: LinkIndex -> LinkMaster -> AttributeList Source #
Change LinkIndex LinkBroadcastEther Source #
Instance details Defined in System.Linux.RTNetlink.Link Methods changeHeaderParts :: LinkIndex -> LinkBroadcastEther -> [HeaderPart (MessageHeader LinkIndex)] Source # changeAttrs :: LinkIndex -> LinkBroadcastEther -> AttributeList Source #
Change LinkIndex LinkEther Source #
Instance details Defined in System.Linux.RTNetlink.Link Methods changeHeaderParts :: LinkIndex -> LinkEther -> [HeaderPart (MessageHeader LinkIndex)] Source # changeAttrs :: LinkIndex -> LinkEther -> AttributeList Source #
Change LinkIndex LinkName Source #
Instance details Defined in System.Linux.RTNetlink.Link Methods changeHeaderParts :: LinkIndex -> LinkName -> [HeaderPart (MessageHeader LinkIndex)] Source # changeAttrs :: LinkIndex -> LinkName -> AttributeList Source #
(Change id c, Change id d) => Change id (c, d) Source #
Instance details Defined in System.Linux.RTNetlink.Message Methods changeHeaderParts :: id -> (c, d) -> [HeaderPart (MessageHeader id)] Source # changeAttrs :: id -> (c, d) -> AttributeList Source #
(Change id1 c, Change id2 c, MessageHeader id1 ~ MessageHeader id2) => Change (id1, id2) c Source #
Instance details Defined in System.Linux.RTNetlink.Message Methods changeHeaderParts :: (id1, id2) -> c -> [HeaderPart (MessageHeader (id1, id2))] Source # changeAttrs :: (id1, id2) -> c -> AttributeList Source #

changeNLMessage :: Change id c => id -> c -> SequenceNumber -> NLMessage (MessageHeader id) Source #

Produce an NLMessage suitable for sending over the wire.

class (Message r, RequestMessageHeader (MessageHeader r)) => Request r where Source #

Class of Messages that can serve as requests.

Methods

requestNLFlags :: r -> ChangeFlags NLFlags Source #

The top-level flags associated with this request.

Instances

Request LinkType Source #
Instance details Defined in System.Linux.RTNetlink.Link Methods requestNLFlags :: LinkType -> ChangeFlags NLFlags Source #
Request AnyLink Source #
Instance details Defined in System.Linux.RTNetlink.Link Methods requestNLFlags :: AnyLink -> ChangeFlags NLFlags Source #
Request LinkName Source #
Instance details Defined in System.Linux.RTNetlink.Link Methods requestNLFlags :: LinkName -> ChangeFlags NLFlags Source #
Request LinkIndex Source #
Instance details Defined in System.Linux.RTNetlink.Link Methods requestNLFlags :: LinkIndex -> ChangeFlags NLFlags Source #
Request AnyInterface Source #
Instance details Defined in System.Linux.RTNetlink.Address Methods requestNLFlags :: AnyInterface -> ChangeFlags NLFlags Source #
(Request r, Request s, MessageHeader r ~ MessageHeader s) => Request (r, s) Source #
Instance details Defined in System.Linux.RTNetlink.Message Methods requestNLFlags :: (r, s) -> ChangeFlags NLFlags Source #

requestNLMessage :: Request r => r -> SequenceNumber -> NLMessage (MessageHeader r) Source #

Produce an NLMessage suitable for sending over the wire.

dumpOne :: a -> ChangeFlags NLFlags Source #

Top-level flags to indicate that calling dump is expected to yield a single Reply.

dumpMany :: a -> ChangeFlags NLFlags Source #

Top-level flags to indicate that calling dump is expected to yield a multiple Replys.

class ReplyMessageHeader (ReplyHeader r) => Reply r where Source #

Class of things that can be received.

Associated Types

type ReplyHeader r Source #

The type of header associated with this Reply.

Methods

fromNLMessage :: NLMessage (ReplyHeader r) -> Maybe r Source #

Interpret a received NLMessage.

Instances

Reply () Source #
Instance details Defined in System.Linux.RTNetlink.Message Associated Types type ReplyHeader () :: Type Source # Methods fromNLMessage :: NLMessage (ReplyHeader ()) -> Maybe () Source #
Reply Errno Source #
Instance details Defined in System.Linux.RTNetlink.Message Associated Types type ReplyHeader Errno :: Type Source # Methods fromNLMessage :: NLMessage (ReplyHeader Errno) -> Maybe Errno Source #
Reply Inet6Address Source #
Instance details Defined in System.Linux.RTNetlink.Address Associated Types type ReplyHeader Inet6Address :: Type Source # Methods fromNLMessage :: NLMessage (ReplyHeader Inet6Address) -> Maybe Inet6Address Source #
Reply InetAddress Source #
Instance details Defined in System.Linux.RTNetlink.Address Associated Types type ReplyHeader InetAddress :: Type Source # Methods fromNLMessage :: NLMessage (ReplyHeader InetAddress) -> Maybe InetAddress Source #
Reply LinkStats Source #
Instance details Defined in System.Linux.RTNetlink.Link Associated Types type ReplyHeader LinkStats :: Type Source # Methods fromNLMessage :: NLMessage (ReplyHeader LinkStats) -> Maybe LinkStats Source #
Reply LinkGroup Source #
Instance details Defined in System.Linux.RTNetlink.Link Associated Types type ReplyHeader LinkGroup :: Type Source # Methods fromNLMessage :: NLMessage (ReplyHeader LinkGroup) -> Maybe LinkGroup Source #
Reply LinkMTU Source #
Instance details Defined in System.Linux.RTNetlink.Link Associated Types type ReplyHeader LinkMTU :: Type Source # Methods fromNLMessage :: NLMessage (ReplyHeader LinkMTU) -> Maybe LinkMTU Source #
Reply LinkDebug Source #
Instance details Defined in System.Linux.RTNetlink.Link Associated Types type ReplyHeader LinkDebug :: Type Source # Methods fromNLMessage :: NLMessage (ReplyHeader LinkDebug) -> Maybe LinkDebug Source #
Reply LinkArp Source #
Instance details Defined in System.Linux.RTNetlink.Link Associated Types type ReplyHeader LinkArp :: Type Source # Methods fromNLMessage :: NLMessage (ReplyHeader LinkArp) -> Maybe LinkArp Source #
Reply LinkPromiscuity Source #
Instance details Defined in System.Linux.RTNetlink.Link Associated Types type ReplyHeader LinkPromiscuity :: Type Source # Methods fromNLMessage :: NLMessage (ReplyHeader LinkPromiscuity) -> Maybe LinkPromiscuity Source #
Reply LinkState Source #
Instance details Defined in System.Linux.RTNetlink.Link Associated Types type ReplyHeader LinkState :: Type Source # Methods fromNLMessage :: NLMessage (ReplyHeader LinkState) -> Maybe LinkState Source #
Reply LinkMaster Source #
Instance details Defined in System.Linux.RTNetlink.Link Associated Types type ReplyHeader LinkMaster :: Type Source # Methods fromNLMessage :: NLMessage (ReplyHeader LinkMaster) -> Maybe LinkMaster Source #
Reply VlanId Source #
Instance details Defined in System.Linux.RTNetlink.Link Associated Types type ReplyHeader VlanId :: Type Source # Methods fromNLMessage :: NLMessage (ReplyHeader VlanId) -> Maybe VlanId Source #
Reply LinkType Source #
Instance details Defined in System.Linux.RTNetlink.Link Associated Types type ReplyHeader LinkType :: Type Source # Methods fromNLMessage :: NLMessage (ReplyHeader LinkType) -> Maybe LinkType Source #
Reply LinkBroadcastEther Source #
Instance details Defined in System.Linux.RTNetlink.Link Associated Types type ReplyHeader LinkBroadcastEther :: Type Source # Methods fromNLMessage :: NLMessage (ReplyHeader LinkBroadcastEther) -> Maybe LinkBroadcastEther Source #
Reply LinkEther Source #
Instance details Defined in System.Linux.RTNetlink.Link Associated Types type ReplyHeader LinkEther :: Type Source # Methods fromNLMessage :: NLMessage (ReplyHeader LinkEther) -> Maybe LinkEther Source #
Reply LinkName Source #
Instance details Defined in System.Linux.RTNetlink.Link Associated Types type ReplyHeader LinkName :: Type Source # Methods fromNLMessage :: NLMessage (ReplyHeader LinkName) -> Maybe LinkName Source #
Reply LinkIndex Source #
Instance details Defined in System.Linux.RTNetlink.Link Associated Types type ReplyHeader LinkIndex :: Type Source # Methods fromNLMessage :: NLMessage (ReplyHeader LinkIndex) -> Maybe LinkIndex Source #
Reply IfInet6Address Source #
Instance details Defined in System.Linux.RTNetlink.Address Associated Types type ReplyHeader IfInet6Address :: Type Source # Methods fromNLMessage :: NLMessage (ReplyHeader IfInet6Address) -> Maybe IfInet6Address Source #
Reply IfInetAddress Source #
Instance details Defined in System.Linux.RTNetlink.Address Associated Types type ReplyHeader IfInetAddress :: Type Source # Methods fromNLMessage :: NLMessage (ReplyHeader IfInetAddress) -> Maybe IfInetAddress Source #
Reply IfLabel Source #
Instance details Defined in System.Linux.RTNetlink.Address Associated Types type ReplyHeader IfLabel :: Type Source # Methods fromNLMessage :: NLMessage (ReplyHeader IfLabel) -> Maybe IfLabel Source #
Reply IfScope Source #
Instance details Defined in System.Linux.RTNetlink.Address Associated Types type ReplyHeader IfScope :: Type Source # Methods fromNLMessage :: NLMessage (ReplyHeader IfScope) -> Maybe IfScope Source #
Reply IfLifetime Source #
Instance details Defined in System.Linux.RTNetlink.Address Associated Types type ReplyHeader IfLifetime :: Type Source # Methods fromNLMessage :: NLMessage (ReplyHeader IfLifetime) -> Maybe IfLifetime Source #
Reply MulticastAutoJoin Source #
Instance details Defined in System.Linux.RTNetlink.Address Associated Types type ReplyHeader MulticastAutoJoin :: Type Source # Methods fromNLMessage :: NLMessage (ReplyHeader MulticastAutoJoin) -> Maybe MulticastAutoJoin Source #
Reply PrefixRoute Source #
Instance details Defined in System.Linux.RTNetlink.Address Associated Types type ReplyHeader PrefixRoute :: Type Source # Methods fromNLMessage :: NLMessage (ReplyHeader PrefixRoute) -> Maybe PrefixRoute Source #
Reply Permanence Source #
Instance details Defined in System.Linux.RTNetlink.Address Associated Types type ReplyHeader Permanence :: Type Source # Methods fromNLMessage :: NLMessage (ReplyHeader Permanence) -> Maybe Permanence Source #
Reply Preference Source #
Instance details Defined in System.Linux.RTNetlink.Address Associated Types type ReplyHeader Preference :: Type Source # Methods fromNLMessage :: NLMessage (ReplyHeader Preference) -> Maybe Preference Source #
Reply Mip6Homing Source #
Instance details Defined in System.Linux.RTNetlink.Address Associated Types type ReplyHeader Mip6Homing :: Type Source # Methods fromNLMessage :: NLMessage (ReplyHeader Mip6Homing) -> Maybe Mip6Homing Source #
Reply DuplicateAddressDetectionFlags Source #
Instance details Defined in System.Linux.RTNetlink.Address Associated Types type ReplyHeader DuplicateAddressDetectionFlags :: Type Source # Methods fromNLMessage :: NLMessage (ReplyHeader DuplicateAddressDetectionFlags) -> Maybe DuplicateAddressDetectionFlags Source #
Reply DuplicateAddressDetection Source #
Instance details Defined in System.Linux.RTNetlink.Address Associated Types type ReplyHeader DuplicateAddressDetection :: Type Source # Methods fromNLMessage :: NLMessage (ReplyHeader DuplicateAddressDetection) -> Maybe DuplicateAddressDetection Source #
Reply Precedence Source #
Instance details Defined in System.Linux.RTNetlink.Address Associated Types type ReplyHeader Precedence :: Type Source # Methods fromNLMessage :: NLMessage (ReplyHeader Precedence) -> Maybe Precedence Source #
Reply IfPrefix Source #
Instance details Defined in System.Linux.RTNetlink.Address Associated Types type ReplyHeader IfPrefix :: Type Source # Methods fromNLMessage :: NLMessage (ReplyHeader IfPrefix) -> Maybe IfPrefix Source #
Reply IfIndex Source #
Instance details Defined in System.Linux.RTNetlink.Address Associated Types type ReplyHeader IfIndex :: Type Source # Methods fromNLMessage :: NLMessage (ReplyHeader IfIndex) -> Maybe IfIndex Source #
Reply r => Reply (Maybe r) Source #
Instance details Defined in System.Linux.RTNetlink.Message Associated Types type ReplyHeader (Maybe r) :: Type Source # Methods fromNLMessage :: NLMessage (ReplyHeader (Maybe r)) -> Maybe (Maybe r) Source #
(Reply r, Reply s, ReplyHeader r ~ ReplyHeader s) => Reply (Either r s) Source #
Instance details Defined in System.Linux.RTNetlink.Message Associated Types type ReplyHeader (Either r s) :: Type Source # Methods fromNLMessage :: NLMessage (ReplyHeader (Either r s)) -> Maybe (Either r s) Source #
(Reply r, Reply s, ReplyHeader r ~ ReplyHeader s) => Reply (r, s) Source #
Instance details Defined in System.Linux.RTNetlink.Message Associated Types type ReplyHeader (r, s) :: Type Source # Methods fromNLMessage :: NLMessage (ReplyHeader (r, s)) -> Maybe (r, s) Source #