Network protocol module type definitions for MirageOS
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lwt
pkg
src
.gitignore
.travis.yml
CHANGES.md
LICENSE.md
Makefile
README.md
mirage-protocols-lwt.opam
mirage-protocols.opam

README.md

mirage-protocols — MirageOS signatures for network protocols

mirage-protocols provides a set of module types which libraries intended to be used as MirageOS network implementations should implement.

The set of protocols defined is:

Mirage_protocols.ETHIF and Mirage_protocols_lwt.ETHIF Mirage_protocols.ARP and Mirage_protocols_lwt.ARP Mirage_protocols.IP and Mirage_protocols_lwt.IP, via Mirage_protocols_lwt.IPV4 and Mirage_protocols_lwt.IPV6 Mirage_protocols.ICMP and Mirage_protocols_lwt.ICMP, via Mirage_protocols_lwt.ICMPV4 Mirage_protocols.UDP and Mirage_protocols_lwt.UDP, via Mirage_protocols_lwt.UDPV4 and Mirage_protocols_lwt.UDPV6 Mirage_protocols.TCP and Mirage_protocols_lwt.TCP, via Mirage_protocols_lwt.TCPV4 and Mirage_protocols_lwt.TCPV6

mirage-protocols is distributed under the ISC license.

Installation

mirage-protocols can be installed with opam:

opam install mirage-protocols

If you don't use opam consult the opam file for build instructions.

Documentation

The documentation and API reference is generated from the source interfaces. It can be consulted online or via odig doc mirage-protocols.