package mirage-protocols

  1. Overview
  2. Docs

Module type Mirage_protocols.ETHERNETSource

Ethernet (IEEE 802.3) is a widely used data link layer. The hardware is usually a twisted pair or fibre connection, on the software side it consists of an Ethernet header where source and destination mac addresses, and a type field, indicating the type of the next layer, are present. The Ethernet layer consists of network card mac address and MTU information, and provides decapsulation and encapsulation.

Sourcetype error = private [>
  1. | Ethernet.error
]

The type for ethernet interface errors.

Sourceval pp_error : error Fmt.t

pp_error is the pretty-printer for errors.

Sourcetype t

The type representing the internal state of the ethernet layer.

Sourceval disconnect : t -> unit Lwt.t

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

Sourceval write : t -> ?src:Macaddr.t -> Macaddr.t -> Ethernet.proto -> ?size:int -> (Cstruct.t -> int) -> (unit, error) result Lwt.t

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.

Sourceval mac : t -> Macaddr.t

mac eth is the MAC address of eth.

Sourceval 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.

Sourceval input : arpv4:(Cstruct.t -> unit Lwt.t) -> ipv4:(Cstruct.t -> unit Lwt.t) -> ipv6:(Cstruct.t -> unit Lwt.t) -> t -> Cstruct.t -> unit Lwt.t

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