package charrua-client

  1. Overview
  2. Docs
DHCP client implementation

Install 

dune-project
 Dependency

github.com Readme Changelog ISC License Edit opam file Versions (5)

Authors

  1. M
    Mindy Preston

Maintainers

  1. M
    Mindy Preston

Sources

charrua-1.6.0.tbz
sha256=1f6f7c1211a45ebbbd56a78b12fdbceaa98efae97ac3bd6f4855da47a3a3ac34
sha512=6ea3cb92efca7c33ee9aa1411223bec9045ece9939657594ebc47ae93408c4d87e8b40812751fc86555061d91ccd338b3fbcfe6059e1dd770303329b5e527a96

doc/charrua-client.mirage/Dhcp_ipv4/Make/argument-5-E/index.html

Parameter Make.E

type nonrec error = private [>
  1. | `Exceeds_mtu
]

The type for ethernet interface errors.

val pp_error : error Fmt.t

pp_error is the pretty-printer for errors.

type t

The type representing the internal state of the ethernet layer.

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

val write : t -> ?src:Macaddr.t -> Macaddr.t -> Ethernet.Packet.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.

val mac : t -> Macaddr.t

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:(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.