System.Linux.RTNetlink.Packet

Low-level headers

data NLMsgHdr

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

Defined in System.Linux.RTNetlink.Packet

Methods

(==) :: NLMsgHdr -> NLMsgHdr -> Bool

(/=) :: NLMsgHdr -> NLMsgHdr -> Bool

Show NLMsgHdr

Defined in System.Linux.RTNetlink.Packet

Methods

showsPrec :: Int -> NLMsgHdr -> ShowS

show :: NLMsgHdr -> String

showList :: [NLMsgHdr] -> ShowS

Serialize NLMsgHdr

Defined in System.Linux.RTNetlink.Packet

Methods

put :: Putter NLMsgHdr

get :: Get NLMsgHdr

Sized NLMsgHdr

Defined in System.Linux.RTNetlink.Packet

Methods

size :: Integral i => NLMsgHdr -> i

sizeAligned :: Integral a => a -> NLMsgHdr -> a

nlMsgHdrIsError :: ByteString -> Bool

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

splitMessages :: ByteString -> [ByteString]

Split a ByteString into multiple messages using their NLMsgHdrs.

Attributes

data Attribute

ADT representing a possibly nested netlink attribute.

Constructors

Attribute AttributeType ByteString

Simple attribute.

AttributeNest AttributeType [Attribute]

Nested attribute.

AttributePart AttributeType ByteString ByteString

Composable attribute.

Instances

Eq Attribute

Defined in System.Linux.RTNetlink.Packet

Methods

(==) :: Attribute -> Attribute -> Bool

(/=) :: Attribute -> Attribute -> Bool

Ord Attribute

Defined in System.Linux.RTNetlink.Packet

Methods

compare :: Attribute -> Attribute -> Ordering

(<) :: Attribute -> Attribute -> Bool

(<=) :: Attribute -> Attribute -> Bool

(>) :: Attribute -> Attribute -> Bool

(>=) :: Attribute -> Attribute -> Bool

max :: Attribute -> Attribute -> Attribute

min :: Attribute -> Attribute -> Attribute

Show Attribute

Defined in System.Linux.RTNetlink.Packet

Methods

showsPrec :: Int -> Attribute -> ShowS

show :: Attribute -> String

showList :: [Attribute] -> ShowS

Serialize Attribute

Defined in System.Linux.RTNetlink.Packet

Methods

put :: Putter Attribute

get :: Get Attribute

Sized Attribute

Defined in System.Linux.RTNetlink.Packet

Methods

size :: Integral i => Attribute -> i

sizeAligned :: Integral a => a -> Attribute -> a

newtype AttributeList

A collection of netlink attributes.

Constructors

AttributeList [Attribute]

Instances

Eq AttributeList

Defined in System.Linux.RTNetlink.Packet

Methods

(==) :: AttributeList -> AttributeList -> Bool

(/=) :: AttributeList -> AttributeList -> Bool

Show AttributeList

Defined in System.Linux.RTNetlink.Packet

Methods

showsPrec :: Int -> AttributeList -> ShowS

show :: AttributeList -> String

showList :: [AttributeList] -> ShowS

Semigroup AttributeList

Defined in System.Linux.RTNetlink.Packet

Methods

(<>) :: AttributeList -> AttributeList -> AttributeList

sconcat :: NonEmpty AttributeList -> AttributeList

stimes :: Integral b => b -> AttributeList -> AttributeList

Monoid AttributeList

Defined in System.Linux.RTNetlink.Packet

Methods

mempty :: AttributeList

mappend :: AttributeList -> AttributeList -> AttributeList

mconcat :: [AttributeList] -> AttributeList

Serialize AttributeList

Defined in System.Linux.RTNetlink.Packet

Methods

put :: Putter AttributeList

get :: Get AttributeList

Sized AttributeList

Defined in System.Linux.RTNetlink.Packet

Methods

size :: Integral i => AttributeList -> i

sizeAligned :: Integral a => a -> AttributeList -> a

type AttributeType = Word16

Type identifier for an Attribute.

attributeType :: Attribute -> AttributeType

Get the type of an Attribute.

attributeData :: Attribute -> Maybe ByteString

Get the data from a simple Attribute.

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

Search for an Attribute in a possibly nested list using the AttributeType to look for at each level. Unfortunately, the kernel does not presently seem to set NLA_F_NESTED on nested attribute types. Until this is changed in the kernel, we need to traverse nested elements manually.

findAttributeData :: [AttributeType] -> AttributeList -> Maybe ByteString

Search for an Attribute and return its data field.

findAttributeDecode :: Serialize a => [AttributeType] -> AttributeList -> Maybe a

Search for an Attribute; decode and return its data field.

findAttributeGet :: Get a -> [AttributeType] -> AttributeList -> Maybe a

Search for an Attribute, run a getter on it, and return the result.

findAttributeCString :: [AttributeType] -> AttributeList -> Maybe ByteString

Search for an Attribute and return its data field, minus any null bytes.

cStringAttr :: AttributeType -> ByteString -> Attribute

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

word32Attr :: AttributeType -> Word32 -> Attribute

Construct an Attribute with a 32-bit word in host byte-order as data.

word32AttrPart :: AttributeType -> Word32 -> Word32 -> Attribute

Composable Attribute with a 32-bit word in host byte-order as data. The second Word32 argument is a mask of bits we care about so that this attribute can be combined with others of the same type.

word16Attr :: AttributeType -> Word16 -> Attribute

Construct an Attribute with a 16-bit word in host byte-order as data.

word16AttrPart :: AttributeType -> Word16 -> Word16 -> Attribute

Composable Attribute with a 16-bit word in host byte-order as data. The second Word16 argument is a mask of bits we care about so that this attribute can be combined with others of the same type.

Sized data

class Sized s where

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

Size of data.

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

Size of data with alignment padding added.

Instances

Sized ()

Defined in System.Linux.RTNetlink.Packet

Methods

size :: Integral i => () -> i

sizeAligned :: Integral a => a -> () -> a

Sized ByteString

Defined in System.Linux.RTNetlink.Packet

Methods

size :: Integral i => ByteString -> i

sizeAligned :: Integral a => a -> ByteString -> a

Sized AttributeList

Defined in System.Linux.RTNetlink.Packet

Methods

size :: Integral i => AttributeList -> i

sizeAligned :: Integral a => a -> AttributeList -> a

Sized Attribute

Defined in System.Linux.RTNetlink.Packet

Methods

size :: Integral i => Attribute -> i

sizeAligned :: Integral a => a -> Attribute -> a

Sized NLMsgHdr

Defined in System.Linux.RTNetlink.Packet

Methods

size :: Integral i => NLMsgHdr -> i

sizeAligned :: Integral a => a -> NLMsgHdr -> a

Sized NLMsgErr

Defined in System.Linux.RTNetlink.Message

Methods

size :: Integral i => NLMsgErr -> i

sizeAligned :: Integral a => a -> NLMsgErr -> a

Sized IfInfoMsg

Defined in System.Linux.RTNetlink.Link

Methods

size :: Integral i => IfInfoMsg -> i

sizeAligned :: Integral a => a -> IfInfoMsg -> a

Sized IfAddrMsg

Defined in System.Linux.RTNetlink.Address

Methods

size :: Integral i => IfAddrMsg -> i

sizeAligned :: Integral a => a -> IfAddrMsg -> a

Sized header => Sized (NLMessage header)

Defined in System.Linux.RTNetlink.Message

Methods

size :: Integral i => NLMessage header -> i

sizeAligned :: Integral a => a -> NLMessage header -> a

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

Pad a ByteString to a given alignment.

Monoidal bit flags

data ChangeFlags a

A flags bitfield encoded as a set of changes to an initial value, which can can be combined using the Monoid instance. This Monoid instance is *not* commutative. Flags set or cleared on the right will override those on the left.

Constructors

ChangeFlags

Fields

• cfFlags :: a

  Flag bits

• cfMask :: a

  Mask of flag bits to use. Other bits will be ignored.

Instances

Bits a => Eq (ChangeFlags a)

Defined in System.Linux.RTNetlink.Packet

Methods

(==) :: ChangeFlags a -> ChangeFlags a -> Bool

(/=) :: ChangeFlags a -> ChangeFlags a -> Bool

Show a => Show (ChangeFlags a)

Defined in System.Linux.RTNetlink.Packet

Methods

showsPrec :: Int -> ChangeFlags a -> ShowS

show :: ChangeFlags a -> String

showList :: [ChangeFlags a] -> ShowS

(Bits a, FiniteBits a) => Semigroup (ChangeFlags a)

Defined in System.Linux.RTNetlink.Packet

Methods

(<>) :: ChangeFlags a -> ChangeFlags a -> ChangeFlags a

sconcat :: NonEmpty (ChangeFlags a) -> ChangeFlags a

stimes :: Integral b => b -> ChangeFlags a -> ChangeFlags a

(Bits a, FiniteBits a) => Monoid (ChangeFlags a)

Defined in System.Linux.RTNetlink.Packet

Methods

mempty :: ChangeFlags a

mappend :: ChangeFlags a -> ChangeFlags a -> ChangeFlags a

mconcat :: [ChangeFlags a] -> ChangeFlags a

applyChangeFlags :: Bits a => ChangeFlags a -> a -> a

Apply a change to an existing flags bitfield.

applyChangeFlags' :: Bits a => ChangeFlags a -> a

Apply a change to the all-zeroes bit field.

setChangeFlags :: Bits a => a -> ChangeFlags a

Set cfFlags and cfMask to the same value.