Moduleiproute-1.7.15Haskell2010

Data.IP.RouteTable

IP routing table is a tree of IPRange to search one of them on the longest match base. It is a kind of TRIE with one way branching removed. Both IPv4 and IPv6 are supported.

For more information, see: http://www.mew.org/~kazu/proj/iproute/

1 type
1 class
11 values

Packageiproute-1.7.15
Exports13
LanguageHaskell2010
LicenceBSD-3-Clause
SourceRouteTable.hs

Documentation

0 declarations

Routable class

classclass Addr a => Routable a where

A class to contain IPv4 and IPv6.

Methods

intToTBit :: Int -> a
The intToTBit function takes Int and returns an Routable address whose only n-th bit is set.
isZero :: a -> a -> Bool
The isZero function takes an Routable address and an test bit Routable address and returns True is the bit is unset, otherwise returns False.

Instances2Routable

Routable IPv4Defined in iproute-1.7.15 · Data.IP.RouteTable.Internal
Routable IPv6Defined in iproute-1.7.15 · Data.IP.RouteTable.Internal

Type for IP routing table

datadata IPRTable k a

The Tree structure for IP routing table based on TRIE with one way branching removed. This is an abstract data type, so you cannot touch its inside. Please use insert or lookup, instead.

Instances11Generic1, Functor, Foldable, Traversable, Eq, Show, …

Generic1 (IPRTable k)Defined in iproute-1.7.15 · Data.IP.RouteTable.Internal
Functor (IPRTable k)Defined in iproute-1.7.15 · Data.IP.RouteTable.Internal
Foldable (IPRTable k)Defined in iproute-1.7.15 · Data.IP.RouteTable.Internal
Traversable (IPRTable k)Defined in iproute-1.7.15 · Data.IP.RouteTable.Internal
(Eq k, Eq a) => Eq (IPRTable k a)Defined in iproute-1.7.15 · Data.IP.RouteTable.Internal
(Show k, Show a) => Show (IPRTable k a)Defined in iproute-1.7.15 · Data.IP.RouteTable.Internal
Generic (IPRTable k a)Defined in iproute-1.7.15 · Data.IP.RouteTable.Internal
Routable k => Semigroup (IPRTable k a)Defined in iproute-1.7.15 · Data.IP.RouteTable.Internal
Note that Semigroup and Monoid instances are right-biased. That is, if both arguments have the same key, the value from the right argument will be used. Since: 1.7.5
Routable k => Monoid (IPRTable k a)Defined in iproute-1.7.15 · Data.IP.RouteTable.Internal
Since: 1.7.5
type Rep (IPRTable k a) = D1 ('MetaData "IPRTable" "Data.IP.RouteTable.Internal" "iproute-1.7.15-3X50rHbdFZS8qgLxLNnKxb" 'False) (C1 ('MetaCons "Nil" 'PrefixI 'False) U1 :+: C1 ('MetaCons "Node" 'PrefixI 'False) ((S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (AddrRange k)) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 k)) :*: (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe a)) :*: (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (IPRTable k a)) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (IPRTable k a))))))Defined in iproute-1.7.15 · Data.IP.RouteTable.Internal
type Rep1 (IPRTable k) = D1 ('MetaData "IPRTable" "Data.IP.RouteTable.Internal" "iproute-1.7.15-3X50rHbdFZS8qgLxLNnKxb" 'False) (C1 ('MetaCons "Nil" 'PrefixI 'False) U1 :+: C1 ('MetaCons "Node" 'PrefixI 'False) ((S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (AddrRange k)) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 k)) :*: (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec1 Maybe) :*: (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec1 (IPRTable k)) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec1 (IPRTable k))))))Defined in iproute-1.7.15 · Data.IP.RouteTable.Internal

Functions to manipulate an IP routing table

valueempty :: Routable k => IPRTable k a

The empty function returns an empty IP routing table.

Example1 expression

>>> (empty :: IPRTable IPv4 ()) == fromList []True

valueinsert :: Routable k => AddrRange k -> a -> IPRTable k a -> IPRTable k a

The insert function inserts a value with a key of AddrRange to IPRTable and returns a new IPRTable.

Example1 expression

>>> (insert ("127.0.0.1" :: AddrRange IPv4) () empty) == fromList [("127.0.0.1",())]True

valuedelete :: Routable k => AddrRange k -> IPRTable k a -> IPRTable k a

The delete function deletes a value by a key of AddrRange from IPRTable and returns a new IPRTable.

Example1 expression

>>> delete "127.0.0.1" (insert "127.0.0.1" () empty) == (empty :: IPRTable IPv4 ())True

valuelookup :: Routable k => AddrRange k -> IPRTable k a -> Maybe a

The lookup function looks up IPRTable with a key of AddrRange. If a routing information in IPRTable matches the key, its value is returned.

Example8 expressions

>>> let v4 = ["133.4.0.0/16","133.5.0.0/16","133.5.16.0/24","133.5.23.0/24"] :: [AddrRange IPv4]>>> let rt = fromList $ zip v4 v4>>> lookup "127.0.0.1" rtNothing>>> lookup "133.3.0.1" rtNothing>>> lookup "133.4.0.0" rtJust 133.4.0.0/16>>> lookup "133.4.0.1" rtJust 133.4.0.0/16>>> lookup "133.5.16.0" rtJust 133.5.16.0/24>>> lookup "133.5.16.1" rtJust 133.5.16.0/24

valuelookupKeyValue

:: Routable k
=> AddrRange k
-> IPRTable k a
-> Maybe (AddrRange k, a)

The lookupKeyValue function looks up IPRTable with a key of AddrRange. If a routing information in IPRTable matches the key, both key and value are returned.

Example5 expressions

>>> :set -XOverloadedStrings>>> let rt = fromList ([("192.168.0.0/24", 1), ("10.10.0.0/16", 2)] :: [(AddrRange IPv4, Int)])>>> lookupKeyValue "127.0.0.1" rtNothing>>> lookupKeyValue "192.168.0.1" rtJust (192.168.0.0/24,1)>>> lookupKeyValue "10.10.0.1" rtJust (10.10.0.0/16,2)

valuelookupAll :: Routable k => AddrRange k -> IPRTable k a -> [(AddrRange k, a)]

lookupAll is a version of lookup that returns all entries matching the given key, not just the longest match.

Example5 expressions

>>> :set -XOverloadedStrings>>> let rt = fromList ([("192.168.0.0/24", 1), ("10.10.0.0/16", 2), ("10.0.0.0/8", 3)] :: [(AddrRange IPv4, Int)])>>> lookupAll "127.0.0.1" rt[]>>> lookupAll "192.168.0.1" rt[(192.168.0.0/24,1)]>>> lookupAll "10.10.0.1" rt[(10.10.0.0/16,2),(10.0.0.0/8,3)]

valuefindMatch

:: (Alternative m, Routable k)
=> AddrRange k
-> IPRTable k a
-> m (AddrRange k, a)

The findMatch function looks up IPRTable with a key of AddrRange. If the key matches routing informations in IPRTable, they are returned.

Example3 expressions

>>> let v4 = ["133.4.0.0/16","133.5.0.0/16","133.5.16.0/24","133.5.23.0/24"] :: [AddrRange IPv4]>>> let rt = fromList $ zip v4 $ repeat ()>>> findMatch "133.4.0.0/15" rt :: [(AddrRange IPv4,())][(133.4.0.0/16,()),(133.5.0.0/16,()),(133.5.16.0/24,()),(133.5.23.0/24,())]

valuefromList :: Routable k => [(AddrRange k, a)] -> IPRTable k a

The fromList function creates a new IP routing table from a list of a pair of IPrange and value.

valuetoList :: Routable k => IPRTable k a -> [(AddrRange k, a)]

The toList function creates a list of a pair of AddrRange and value from an IP routing table.

valuefoldlWithKey :: (b -> AddrRange k -> a -> b) -> b -> IPRTable k a -> b

O(n). Fold the keys and values in the IPRTable using the given left-associative binary operator. This function is equivalent to Data.Map.foldlWithKey with necessary to IPRTable changes. Since: 1.7.5

valuefoldrWithKey :: (AddrRange k -> a -> b -> b) -> b -> IPRTable k a -> b

O(n). Fold the keys and values in the IPRTable using the given right-associative binary operator. This function is equivalent to Data.Map.foldrWithKey with necessary to IPRTable changes. Since: 1.7.5