System.Linux.Netlink.GeNetlink.Control

This module provides utility functions and datatypes for the genetlink control protocol. This has to be used by implementations of netlink families based on genetlink to lookup their current id, since that is determined at runtime.

Documentation

data CtrlAttribute

Attributes defined by the control family

Constructors

CTRL_ATTR_UNSPEC ByteString

CTRL_ATTR_FAMILY_ID Word16

CTRL_ATTR_FAMILY_NAME String

CTRL_ATTR_VERSION Word32

CTRL_ATTR_HDRSIZE Word32

CTRL_ATTR_MAXATTR Word32

CTRL_ATTR_OPS [CtrlAttrOpData]

CTRL_ATTR_MCAST_GROUPS [CtrlAttrMcastGroup]

CTRL_ATTR_UNKNOWN Int ByteString

Instances

Eq CtrlAttribute

Methods

(==) :: CtrlAttribute -> CtrlAttribute -> Bool

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

Show CtrlAttribute

Methods

showsPrec :: Int -> CtrlAttribute -> ShowS

show :: CtrlAttribute -> String

showList :: [CtrlAttribute] -> ShowS

data CtrlAttrMcastGroup

Datatype for multicast groups as returned by the control protocol

Constructors

CAMG

Fields

• grpName :: String
• grpId :: Word32

Instances

Eq CtrlAttrMcastGroup

Methods

(==) :: CtrlAttrMcastGroup -> CtrlAttrMcastGroup -> Bool

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

Show CtrlAttrMcastGroup

Methods

showsPrec :: Int -> CtrlAttrMcastGroup -> ShowS

show :: CtrlAttrMcastGroup -> String

showList :: [CtrlAttrMcastGroup] -> ShowS

data CtrlPacket

Typesafe control packet

Constructors

CtrlPacket

Fields

• ctrlHeader :: Header
• ctrlGeHeader :: GenlHeader
• ctrlAttributes :: [CtrlAttribute]

Instances

Eq CtrlPacket

Methods

(==) :: CtrlPacket -> CtrlPacket -> Bool

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

Show CtrlPacket

Methods

showsPrec :: Int -> CtrlPacket -> ShowS

show :: CtrlPacket -> String

showList :: [CtrlPacket] -> ShowS

type CTRLPacket = GenlPacket NoData

typedef for control messages

ctrlPacketFromGenl :: CTRLPacket -> Maybe CtrlPacket

Convert "normal" Packets into typesafe CtrlPackets

data CtrlAttrOpData

Datatype for AttrOpData as returned by the control protocol

Constructors

CAO

Fields

• opId :: Word32
• opFlags :: Word32

Instances

Eq CtrlAttrOpData

Methods

(==) :: CtrlAttrOpData -> CtrlAttrOpData -> Bool

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

Show CtrlAttrOpData

Methods

showsPrec :: Int -> CtrlAttrOpData -> ShowS

show :: CtrlAttrOpData -> String

showList :: [CtrlAttrOpData] -> ShowS

ctrlPackettoGenl :: CtrlPacket -> CTRLPacket

Convert the typesafe CtrPacket into a CTRLPacket so it can be sent

getFamilyId :: NetlinkSocket -> String -> IO Word16

Get the id for a netlink family by name

getFamilyIdS :: NetlinkSocket -> String -> IO (Maybe Word16)

A safe version of getFamilyId

getFamilyWithMulticasts :: NetlinkSocket -> String -> IO (Word16, [CtrlAttrMcastGroup])

get the id and multicast groups of a netlink family by name

getFamilyWithMulticastsS :: NetlinkSocket -> String -> IO (Maybe (Word16, [CtrlAttrMcastGroup]))

A safe version of getFamilyWithMulticasts

getMulticastGroups :: NetlinkSocket -> Word16 -> IO [CtrlAttrMcastGroup]

get the mutlicast groups of a netlink family by id

getMulticast :: String -> [CtrlAttrMcastGroup] -> Maybe Word32

Get id of multicast group by name

getFamilie :: NetlinkSocket -> String -> IO (Maybe CtrlPacket)

Get the CtrlPacket describing a single family

getFamilies :: NetlinkSocket -> IO [CtrlPacket]

Get CtrlPackets for every currently registered GeNetlink family