package ethernet

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Parameters
Signature

package ethernet

ethernet
- Ethernet
  - Make
    
    N
- Ethernet_packet
  - Marshal
  - Unmarshal
- Ethernet_wire

Legend:
Library
Module
Module type
Parameter
Class
Class type

Parameters

module N : Mirage_net_lwt.S

Signature

include Mirage_protocols_lwt.ETHERNET

type 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) Stdlib.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.

val connect : N.t -> t Lwt.t

connect netif connects an ethernet layer on top of the raw network device netif.