package mirage-protocols

You can search for identifiers within the package.

in-package search v0.2.0

mirage-protocols
- Mirage_protocols
  - ARP
  - Arp
  - ETHIF
  - Ethif
  - ICMP
  - ICMPV4
  - IP
  - IPV4
  - IPV6
  - Ip
  - TCP
  - Tcp
  - UDP

Legend:
Library
Module
Module type
Parameter
Class
Class type

type error = private [>

| Ethif.error

]

The type for ethernet interface errors.

val pp_error : error Fmt.t

pp_error is the pretty-printer for errors.

type buffer

The type for memory buffers.

type netif

The type for ethernet network interfaces.

type macaddr

The type for unique MAC identifiers.

include Mirage_device.S

type +'a io

type t

val disconnect : t -> unit io

val write : t -> buffer -> (unit, error) Pervasives.result io

write nf buf outputs buf to netfront nf.

val writev : t -> buffer list -> (unit, error) Pervasives.result io

writev nf bufs output a list of buffers to netfront nf as a single packet.

val mac : t -> macaddr

mac nf is the MAC address of nf.

val input : 
  arpv4:(buffer -> unit io) ->
  ipv4:(buffer -> unit io) ->
  ipv6:(buffer -> unit io) ->
  t ->
  buffer ->
  unit io

listen nf fn is a blocking operation that calls fn buf with every packet that is read from the interface. The function can be stopped by calling disconnect in the device layer.