Hans.IP4.Packet

Documentation

newtype IP4

Constructors

IP4 Word32

Instances

Eq IP4

Methods

(==) :: IP4 -> IP4 -> Bool

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

Ord IP4

Methods

compare :: IP4 -> IP4 -> Ordering

(<) :: IP4 -> IP4 -> Bool

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

(>) :: IP4 -> IP4 -> Bool

(>=) :: IP4 -> IP4 -> Bool

max :: IP4 -> IP4 -> IP4

min :: IP4 -> IP4 -> IP4

Read IP4

Methods

readsPrec :: Int -> ReadS IP4

readList :: ReadS [IP4]

readPrec :: ReadPrec IP4

readListPrec :: ReadPrec [IP4]

Show IP4

Methods

showsPrec :: Int -> IP4 -> ShowS

show :: IP4 -> String

showList :: [IP4] -> ShowS

Generic IP4

Associated Types

type Rep IP4 :: * -> *

Methods

from :: IP4 -> Rep IP4 x

to :: Rep IP4 x -> IP4

Serialize IP4

Methods

put :: Putter IP4

get :: Get IP4

Hashable IP4

Methods

hashWithSalt :: Int -> IP4 -> Int

hash :: IP4 -> Int

Checksum IP4

Methods

extendChecksum :: IP4 -> PartialChecksum -> PartialChecksum

CodecAtom IP4

Methods

getAtom :: Get IP4

putAtom :: IP4 -> Put

atomSize :: IP4 -> Int

Option IP4

Methods

getOption :: Get IP4

putOption :: IP4 -> Put

NetworkAddr IP4

Methods

toAddr :: IP4 -> Addr

fromAddr :: Addr -> Maybe IP4

isWildcardAddr :: IP4 -> Bool

wildcardAddr :: IP4 -> IP4

isBroadcastAddr :: IP4 -> Bool

broadcastAddr :: IP4 -> IP4

Network IP4

Methods

pseudoHeader :: IP4 -> IP4 -> NetworkProtocol -> Int -> PartialChecksum

lookupRoute :: HasNetworkStack ns => ns -> IP4 -> IO (Maybe (RouteInfo IP4))

sendDatagram' :: HasNetworkStack ns => ns -> Device -> IP4 -> IP4 -> IP4 -> Bool -> NetworkProtocol -> ByteString -> IO ()

type Rep IP4

type Rep IP4 = D1 (MetaData "IP4" "Hans.IP4.Packet" "hans-3.0.2-GPIpvDF0acQKMmo8PFxkX0" True) (C1 (MetaCons "IP4" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Word32)))

getIP4 :: Get IP4

putIP4 :: Putter IP4

packIP4 :: Word8 -> Word8 -> Word8 -> Word8 -> IP4

unpackIP4 :: IP4 -> (Word8, Word8, Word8, Word8)

showIP4 :: IP4 -> ShowS

readIP4 :: ReadS IP4

pattern BroadcastIP4 :: IP4

pattern CurrentNetworkIP4 :: IP4

pattern WildcardIP4 :: IP4

data IP4Mask

Constructors

IP4Mask !IP4 !Int

Between 0 and 32

Instances

Eq IP4Mask

Methods

(==) :: IP4Mask -> IP4Mask -> Bool

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

Read IP4Mask

Methods

readsPrec :: Int -> ReadS IP4Mask

readList :: ReadS [IP4Mask]

readPrec :: ReadPrec IP4Mask

readListPrec :: ReadPrec [IP4Mask]

Show IP4Mask

Methods

showsPrec :: Int -> IP4Mask -> ShowS

show :: IP4Mask -> String

showList :: [IP4Mask] -> ShowS

CodecAtom IP4Mask

Methods

getAtom :: Get IP4Mask

putAtom :: IP4Mask -> Put

atomSize :: IP4Mask -> Int

hostmask :: Int -> Word32

netmask :: Int -> Word32

maskRange :: IP4Mask -> (IP4, IP4)

maskBits :: IP4Mask -> Int

maskAddr :: IP4Mask -> IP4

clearHostBits :: IP4Mask -> IP4

setHostBits :: IP4Mask -> IP4

broadcastAddress :: IP4Mask -> IP4

readIP4Mask :: ReadS IP4Mask

showIP4Mask :: IP4Mask -> ShowS

ip4PseudoHeader :: IP4 -> IP4 -> NetworkProtocol -> Int -> PartialChecksum

source address | +--------+--------+--------+--------+ | destination address | +--------+--------+--------+--------+ | zero |protocol| length | +--------+--------+--------+--------+

type IP4Ident = Word16

data IP4Header

Constructors

IP4Header

Fields

• ip4TypeOfService :: !Word8
• ip4Ident :: !IP4Ident
• ip4Fragment_ :: !Word16

  This includes the flags, and the fragment offset.

• ip4TimeToLive :: !Word8
• ip4Protocol :: !NetworkProtocol
• ip4Checksum :: !Word16
• ip4SourceAddr :: !IP4
• ip4DestAddr :: !IP4
• ip4Options :: ![IP4Option]

Instances

Eq IP4Header

Methods

(==) :: IP4Header -> IP4Header -> Bool

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

Show IP4Header

Methods

showsPrec :: Int -> IP4Header -> ShowS

show :: IP4Header -> String

showList :: [IP4Header] -> ShowS

emptyIP4Header :: IP4Header

ip4DCSP :: Lens' IP4Header Word8

ip4ECN :: Lens' IP4Header Word8

ip4Fragment :: Lens' IP4Header Word16

ip4DontFragment :: Lens' IP4Header Bool

ip4MoreFragments :: Lens' IP4Header Bool

ip4FragmentOffset :: Lens' IP4Header Word16

The fragment offset, in bytes.

noMoreFragments :: IP4Header -> IP4Header

moreFragments :: IP4Header -> IP4Header

addOffset :: Word16 -> IP4Header -> IP4Header

setIdent :: IP4Ident -> IP4Header -> IP4Header

ip4PacketSize :: IP4Header -> ByteString -> Int

Calculate the size of an IP4 packet

ip4HeaderSize :: IP4Header -> Int

Calculate the size of an IP4 header

splitPacket :: Int -> IP4Header -> ByteString -> [(IP4Header, ByteString)]

Fragment a single IP packet into one or more, given an MTU to fit into.

fragmentPacket :: Int64 -> IP4Header -> ByteString -> [(IP4Header, ByteString)]

Given a fragment size and a packet, fragment the packet into multiple smaller ones.

ip4VersionIHL :: Int -> Word8

Compute the value of the version/header length byte.

getIP4Packet :: Get (IP4Header, Int, Int)

Version| IHL |Type of Service| Total Length | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Identification |Flags| Fragment Offset | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Time to Live | Protocol | Header Checksum | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Source Address | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Destination Address | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

putIP4Header :: IP4Header -> Int -> Put

renderIP4Options :: [IP4Option] -> (ByteString, Int)

getIP4Options :: Int -> Get [IP4Option]

data IP4Option

Constructors

IP4Option

Fields

• ip4OptionCopied :: !Bool
• ip4OptionClass :: !Word8
• ip4OptionNum :: !Word8
• ip4OptionData :: !ShortByteString

Instances

Eq IP4Option

Methods

(==) :: IP4Option -> IP4Option -> Bool

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

Show IP4Option

Methods

showsPrec :: Int -> IP4Option -> ShowS

show :: IP4Option -> String

showList :: [IP4Option] -> ShowS

ip4OptionSize :: IP4Option -> Int

getIP4Option :: Get IP4Option

ip4OptionType :: Bool -> Word8 -> Word8 -> Word8

putIP4Option :: Putter IP4Option

data ArpPacket

Arp packets, specialized to IP4 and Mac addresses.

Constructors

ArpPacket

Fields

• arpOper :: !ArpOper
• arpSHA :: !Mac
• arpSPA :: !IP4
• arpTHA :: !Mac
• arpTPA :: !IP4

Instances

Eq ArpPacket

Methods

(==) :: ArpPacket -> ArpPacket -> Bool

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

Show ArpPacket

Methods

showsPrec :: Int -> ArpPacket -> ShowS

show :: ArpPacket -> String

showList :: [ArpPacket] -> ShowS

getArpPacket :: Get ArpPacket

Parse an Arp packet, given a way to parse hardware and protocol addresses.

renderArpPacket :: ArpPacket -> ByteString

putArpPacket :: Putter ArpPacket

Render an Arp packet, given a way to render hardware and protocol addresses.

type ArpOper = Word16

pattern ArpRequest :: forall a. (Num a, Eq a) => a

pattern ArpReply :: forall a. (Num a, Eq a) => a

getArpOper :: Get ArpOper

Parse an Arp operation.

putArpOper :: Putter ArpOper

Render an Arp operation.