Hans.Device.Types

Documentation

type DeviceName = ByteString

data ChecksumOffload

Constructors

ChecksumOffload

Fields

• coIP4 :: !Bool
• coUdp :: !Bool
• coTcp :: !Bool
• coIcmp4 :: !Bool

Instances

Show ChecksumOffload

Methods

showsPrec :: Int -> ChecksumOffload -> ShowS

show :: ChecksumOffload -> String

showList :: [ChecksumOffload] -> ShowS

defaultChecksumOffload :: ChecksumOffload

data DeviceConfig

Static configuration data for creating a device.

Constructors

DeviceConfig

Fields

• dcSendQueueLen :: !Int

  How large the send queue should be.

• dcTxOffload :: !ChecksumOffload
• dcRxOffload :: !ChecksumOffload
• dcMtu :: !Int

Instances

Show DeviceConfig

Methods

showsPrec :: Int -> DeviceConfig -> ShowS

show :: DeviceConfig -> String

showList :: [DeviceConfig] -> ShowS

HasDeviceConfig DeviceConfig

Methods

deviceConfig :: Getting r DeviceConfig DeviceConfig

class HasDeviceConfig cfg where

Minimal complete definition

deviceConfig

Methods

deviceConfig :: Getting r cfg DeviceConfig

Instances

HasDeviceConfig Device

Methods

deviceConfig :: Getting r Device DeviceConfig

HasDeviceConfig DeviceConfig

Methods

deviceConfig :: Getting r DeviceConfig DeviceConfig

HasDeviceConfig (RouteInfo addr)

Methods

deviceConfig :: Getting r (RouteInfo addr) DeviceConfig

txOffload :: HasDeviceConfig cfg => Getting r cfg ChecksumOffload

The TX checksum offload config.

rxOffload :: HasDeviceConfig cfg => Getting r cfg ChecksumOffload

The RX checksum offload config.

defaultDeviceConfig :: DeviceConfig

data Device

Constructors

Device

Fields

• devName :: !DeviceName

  The name of this device

• devMac :: !Mac

  The mac address associated with this device

• devConfig :: !DeviceConfig

  Static configuration information for this device

• devSendQueue :: !(BoundedChan ByteString)

  Outgoing message queue for this device

• devStart :: !(IO ())

  Start packet flow

• devStop :: !(IO ())

  Stop packet flow

• devCleanup :: !(IO ())

  Cleanup resources associated with a Device

• devStats :: !DeviceStats

  Statistics about this device

Instances

Eq Device

Methods

(==) :: Device -> Device -> Bool

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

Ord Device

Methods

compare :: Device -> Device -> Ordering

(<) :: Device -> Device -> Bool

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

(>) :: Device -> Device -> Bool

(>=) :: Device -> Device -> Bool

max :: Device -> Device -> Device

min :: Device -> Device -> Device

HasDeviceConfig Device

Methods

deviceConfig :: Getting r Device DeviceConfig

data DeviceException

Constructors

FailedToOpen !DeviceName

Instances

Show DeviceException

Methods

showsPrec :: Int -> DeviceException -> ShowS

show :: DeviceException -> String

showList :: [DeviceException] -> ShowS

Exception DeviceException

Methods

toException :: DeviceException -> SomeException

fromException :: SomeException -> Maybe DeviceException

displayException :: DeviceException -> String

type Stat = IORef Int

incrementStat :: Stat -> IO ()

addStat :: Stat -> Int -> IO ()

data StatGroup

Constructors

StatGroup

Fields

• _statBytes :: !Stat
• _statPackets :: !Stat
• _statErrors :: !Stat
• _statDropped :: !Stat

statBytes :: Getting r StatGroup Stat

statPackets :: Getting r StatGroup Stat

statErrors :: Getting r StatGroup Stat

statDropped :: Getting r StatGroup Stat

newStatGroup :: IO StatGroup

dumpStatGroup :: String -> StatGroup -> IO ()

data DeviceStats

Constructors

DeviceStats

Fields

• _statTX :: !StatGroup
• _statRX :: !StatGroup

statTX :: Getting r DeviceStats StatGroup

statRX :: Getting r DeviceStats StatGroup

newDeviceStats :: IO DeviceStats

dumpStats :: DeviceStats -> IO ()

updateDropped :: Getting Stat DeviceStats StatGroup -> DeviceStats -> IO ()

Add one to the count of dropped packets for this device.

updateError :: Getting Stat DeviceStats StatGroup -> DeviceStats -> IO ()

Add one to the error count for this device.

updateBytes :: Getting Stat DeviceStats StatGroup -> DeviceStats -> Int -> IO ()

Update information about bytes received.

updatePackets :: Getting Stat DeviceStats StatGroup -> DeviceStats -> IO ()

Update information about bytes received.