Copyright	(c) Formaltech Inc. 2017
License	BSD3
Maintainer	[email protected]
Stability	experimental
Portability	Linux
Safe Haskell	None
Language	Haskell2010

System.Linux.RTNetlink.Packet

Contents

Low-level headers
Attributes
Sized data

Description

Synopsis

Low-level headers

data NLMsgHdr Source #

ADT corresponding to struct nlmsghdr from linux/netlink.h.

Constructors

NLMsgHdr
Fields nlMsgLength :: Word32 Total message length (`nlmsg_len`). nlMsgType :: Word16 Message type (`nlmsg_type`). nlMsgFlags :: Word16 Top-level flags (`nlmsg_flags`). nlMsgSeqNum :: Word32 Sequence number (`nlmsg_seq`). nlMsgPid :: Word32 Destination address (`nlmsg_pid`).

Instances

Eq NLMsgHdr Source #
Methods (==) :: NLMsgHdr -> NLMsgHdr -> Bool # (/=) :: NLMsgHdr -> NLMsgHdr -> Bool #
Show NLMsgHdr Source #
Methods showsPrec :: Int -> NLMsgHdr -> ShowS # show :: NLMsgHdr -> String # showList :: [NLMsgHdr] -> ShowS #
Serialize NLMsgHdr Source #
Methods put :: Putter NLMsgHdr # get :: Get NLMsgHdr #
Sized NLMsgHdr Source #
Methods size :: Integral i => NLMsgHdr -> i Source # sizeAligned :: Integral a => a -> NLMsgHdr -> a Source #

nlMsgHdrIsError :: ByteString -> Bool Source #

Return True iff the message is an error, assuming the provided ByteString is headed by an NLMsgHdr.

splitMessages :: ByteString -> [ByteString] Source #

Split a ByteString into multiple messages using their NLMsgHdrs.

Attributes

data Attribute Source #

ADT representing a possibly nested netlink attribute.

Constructors

Attribute AttributeType ByteString	Simple attribute.
AttributeNest AttributeType [Attribute]	Nested attribute.

Instances

Eq Attribute Source #
Methods (==) :: Attribute -> Attribute -> Bool # (/=) :: Attribute -> Attribute -> Bool #
Show Attribute Source #
Methods showsPrec :: Int -> Attribute -> ShowS # show :: Attribute -> String # showList :: [Attribute] -> ShowS #
Serialize Attribute Source #
Methods put :: Putter Attribute # get :: Get Attribute #
Sized Attribute Source #
Methods size :: Integral i => Attribute -> i Source # sizeAligned :: Integral a => a -> Attribute -> a Source #

newtype AttributeList Source #

A collection of netlink attributes.

Constructors

AttributeList [Attribute]

Instances

Eq AttributeList Source #
Methods (==) :: AttributeList -> AttributeList -> Bool # (/=) :: AttributeList -> AttributeList -> Bool #
Show AttributeList Source #
Methods showsPrec :: Int -> AttributeList -> ShowS # show :: AttributeList -> String # showList :: [AttributeList] -> ShowS #
Monoid AttributeList Source #
Methods mempty :: AttributeList # mappend :: AttributeList -> AttributeList -> AttributeList # mconcat :: [AttributeList] -> AttributeList #
Serialize AttributeList Source #
Methods put :: Putter AttributeList # get :: Get AttributeList #
Sized AttributeList Source #
Methods size :: Integral i => AttributeList -> i Source # sizeAligned :: Integral a => a -> AttributeList -> a Source #

type AttributeType = Word16 Source #

Type identifier for an Attribute.

attributeType :: Attribute -> AttributeType Source #

Get the type of an Attribute.

attributeData :: Attribute -> Maybe ByteString Source #

Get the data from a simple Attribute.

findAttribute :: [AttributeType] -> AttributeList -> Maybe Attribute Source #

Search for an Attribute in a possibly nested list using the AttributeType to look for at each level.

cStringAttr :: AttributeType -> ByteString -> Attribute Source #

Construct an Attribute with a null-byte-terminated string as data.

word32Attr :: AttributeType -> Word32 -> Attribute Source #

Construct an Attribute with a 32-bit word as data.

word16Attr :: AttributeType -> Word16 -> Attribute Source #

Construct an Attribute with a 16-bit word as data.

Sized data

class Sized s where Source #

Typeclass for data with a defined size. This lets us get sizes to use for constructing headers.

Minimal complete definition

size

Methods

size :: Integral i => s -> i Source #

Size of data.

sizeAligned :: Integral a => a -> s -> a Source #

Size of data with alignment padding added.

Instances

Sized () Source #
Methods size :: Integral i => () -> i Source # sizeAligned :: Integral a => a -> () -> a Source #
Sized ByteString Source #
Methods size :: Integral i => ByteString -> i Source # sizeAligned :: Integral a => a -> ByteString -> a Source #
Sized AttributeList Source #
Methods size :: Integral i => AttributeList -> i Source # sizeAligned :: Integral a => a -> AttributeList -> a Source #
Sized Attribute Source #
Methods size :: Integral i => Attribute -> i Source # sizeAligned :: Integral a => a -> Attribute -> a Source #
Sized NLMsgHdr Source #
Methods size :: Integral i => NLMsgHdr -> i Source # sizeAligned :: Integral a => a -> NLMsgHdr -> a Source #
Sized NLMsgErr Source #
Methods size :: Integral i => NLMsgErr -> i Source # sizeAligned :: Integral a => a -> NLMsgErr -> a Source #
Sized IfAddrMsg Source #
Methods size :: Integral i => IfAddrMsg -> i Source # sizeAligned :: Integral a => a -> IfAddrMsg -> a Source #
Sized IfInfoMsg Source #
Methods size :: Integral i => IfInfoMsg -> i Source # sizeAligned :: Integral a => a -> IfInfoMsg -> a Source #
Sized header => Sized (NLMessage header) Source #
Methods size :: Integral i => NLMessage header -> i Source # sizeAligned :: Integral a => a -> NLMessage header -> a Source #

putAligned :: Integral a => a -> Putter ByteString Source #

Pad a ByteString to a given alignment.