Index of modules


A
Addr [Ip]
Addr [Eth]
Ethernet addresses are implemented as bitstring internally but the abstract type Eth.Addr.t has a batter printer (which support such thing as vendor decoding).
Arp
Address Resolution Protocol.
Atomic [Metric]

B
BitHash [Tools]
Browser
A simple web browser.

C
Cidr [Ip]
CIDR addresses are a concise way to write network addresses, with network IP then netmask length, like: 192.168.0.0/16.
Clock
This module creates an alarm-clock that schedule registered events.
Counter [Metric]

D
Dhcp
Dynamic Host Configuration Protocol.
Dhcpd
DHCP server
Dlt [Pcap]
Data Link Types are constant values indicating what protocol and hardware technology some captured packets were taken from.
Dns
Domain Name System

E
Eth
Ethernet protocol implementation.

H
HashedBits [Tools]
Host
Simple hosts with a single Eth network interface with a full IP stack.
Html
HyperText Markup Language.
Http
HyperText Transfert Protocol
Hub
A Repeater (or HUB) is a device that receives Eth frames and blindly mirrors them to several locations (but the one from which the frame came from)
HwProto [Arp]
Arp Protocol Types.
HwType [Arp]
Arp identifiers for MAC types.

I
Icmp
Internet Control Message Protocol (ICMP), (un)packing and tools.
Icmp6
Internet Control Message Protocol (ICMP), (un)packing and tools.
Inner [Dhcp.MsgType]
Inner [Arp.HwType]
Interval [Clock]
Ip
Everything related to IPv4 packets: (un)packing, addresses, transceiver...
Ip6
Everything related to IPv4 packets: (un)packing, addresses, transceiver...

L
Localhost
A special host that access the physical network through the OS network stack.
Log
Logging facility

M
MakePort [Tcp]
MakePrivate [Tools]
Map [Clock]
Metric
Facility to count events/measure performances.
MsgType [Icmp6]
MsgType [Icmp]
MsgType [Dhcp]
Myadmin
An HTTP server for monitoring/editing the virtual network.

N
Nat [Router]
Network Address Translation (N.A.T.) is the process of replacing on the fly non routable addresses used within a LAN by a unique routable address, so that hosts from the LAN can communicate with the outside world by sharing the only routable IP address.
Net [Sim]
A network is a set of equipments, and some optionaly named "plugs" where to attach another network to form a new one.
Net
Easily composable network library.

O
Op [Arp]
ARP Operations Codes
Opache
A simple HTTP server.
OrdArray [Tools]
An OrdArray is a container for an ordered set of bounded size.
Outer [Icmp6.MsgType]
Outer [Icmp.MsgType]

P
Packet
Packet scrutiny
Payload [Tools]
Pcap
This module holds all functions related to libpcap, packet sniffing, packet injection and pcap file reading and writing.
Pdu [Vlan]
Pack/Unpack a 802.1q tunnel
Pdu [Udp]
Pdu [Tcp]
Pdu [Sll]
Pack/Unpack a SLL frame.
Pdu [Pcap]
Packets harvested with libpcap will come with additional informations such as caplen, timestamp etc.
Pdu [Packet]
Pack/Unpack the whole protocol stack that fits entirely within a packet.
Pdu [Ip6]
Pdu [Ip]
(Un)Packing an IP packet.
Pdu [Icmp6]
This module handle ICMPv6 messages (un)packing.
Pdu [Icmp]
This module handle ICMP messages (un)packing.
Pdu [Http]
Pdu [Eth]
Pack/Unpack an Ethernet frame.
Pdu [Dns]
Pdu [Dhcp]
Pdu [Arp]
Pack/Unpack an ARP message
Peg
Simple Parsing Expression Grammar that allow restart.
Persist
Simple serialization module
Plan [Browser]
Plug [Sim.Net]
A plug is a named entry/exit point to a networks.
Port [Udp]
Port [Tcp]
Proto [Ip]
Internet protocols, as in /etc/protocols.

Q
QType [Dns]

R
R [Hub.Switch]
Repeater [Hub]
A Repeater (or HUB) is a device that receives Eth frames and blindly mirrors them to several locations (but the one from which the frame came from)
Router
A router is a device with N IP/Eth devices and a routing table with rules on interface number, Ip addresses, proto, ports.
Router
Equipment for routing/nating traffic

S
SeqNum [Tcp]
Sim
This module puts together all the modules required to build networks and run a simulation.
Sll
Linux Cooked Capture (aka SLL)
Streambuf [Tcp.TRX]
Switch [Hub]
A Switch is a device that will forward Ethernet frames based on the observed location of the destination.

T
TRX [Vlan]
A Vlan TRX accepts raw packets (presumably from some Eth.TRX), unpack them and forward the payload to a callback; and it can be given some payload to tunnel and it will tag it and pass it presumably to an Eth.TRX.
TRX [Udp]
TRX [Tcp]
TRX [Ip6]
TRX [Ip]
TRX [Http]
Once build (as a poster or server), the Http.TRX handle the whole connection(s).
TRX [Eth]
An Ethernet TRX will convert from payload to Ethernet frames (resolving destinations using ARP), for a single Arp.HwProto.t.
TRXtop [Http]
Special kind of transceiver, useful when it's on top of a TRX stack, that receive and tx Pdu.t messages (instead of bitstring).
Tap [Hub]
A Tap is a 2 port repeater wich mirror each packet to a user function.
Tcp
Transmission Control Protocol.
Time [Clock]
Time.t represents a given timestamp (ie.
Timed [Metric]
Tools
Various functions/types prevalent in the library.

U
Udp
User Data Protocol.
Url
Uniform Resource Locator

V
Vlan
Ethernet 802.1q Virtual Lan.