mirage-protocols-lwt

MirageOS signatures for network protocols
IN THIS PACKAGE
type error#row

The type for ethernet interface errors.

and error = private [>
| Mirage_protocols.Ethernet.error
]

The type for ethernet interface errors.

val pp_error : error Fmt.t

pp_error is the pretty-printer for errors.

type buffer = Cstruct.t

The type for memory buffers.

type macaddr = Macaddr.t

The type for unique MAC identifiers.

include Mirage_device.S with type 'a io = 'a Lwt.t
type 'a io = 'a Lwt.t

The type for potentially blocking I/O operation

type t

The type representing the internal state of the device

val disconnect : t -> unit io

Disconnect from the device. While this might take some time to complete, it can never result in an error.

val write : t -> ?src:macaddr -> macaddr -> Mirage_protocols.Ethernet.proto -> ?size:int -> ( buffer -> int ) -> ( unit, error ) Pervasives.result io

write eth ~src dst proto ~size payload outputs an ethernet frame which header is filled by eth, and its payload is the buffer from the call to payload. Payload gets a buffer of size (defaults to mtu) to fill with their payload. If size exceeds mtu, an error is returned.

val mac : t -> macaddr

mac eth is the MAC address of eth.

val mtu : t -> int

mtu eth is the Maximum Transmission Unit of the eth i.e. the maximum size of the payload, excluding the ethernet frame header.

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

input ~arpv4 ~ipv4 ~ipv6 eth buffer decodes the buffer and demultiplexes it depending on the protocol to the callback.