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-2.0.0.tbz
sha256=ecacfd0f17bdf2ba261049d2b3cc03aa473eec4a9d77b0a83c0ce2c402c512bb
sha512=9f24a36f934824581d5af9886bdd22e82a1ba0ce174d752d43de9b527392140c19b65a93b18b3ca07c441f84315fefff7002a71eebf573ce1b747e74de861a9d

doc/charrua-client.mirage/Dhcp_ipv4/Make/argument-3-Arp/index.html

Parameter Make.Arp

type t

The type representing the internal state of the ARP layer.

val disconnect : t -> unit Lwt.t

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

type error = private [>
  1. | `Timeout
]

The type for ARP errors.

val pp_error : error Fmt.t

pp_error is the pretty-printer for errors.

val pp : t Fmt.t

Prettyprint cache contents

val get_ips : t -> Ipaddr.V4.t list

get_ips arp gets the bound IP address list in the arp value.

val set_ips : t -> Ipaddr.V4.t list -> unit Lwt.t

set_ips arp sets the bound IP address list, which will transmit a GARP packet also.

val remove_ip : t -> Ipaddr.V4.t -> unit Lwt.t

remove_ip arp ip removes ip to the bound IP address list in the arp value, which will transmit a GARP packet for any remaining IPs in the bound IP address list after the removal.

val add_ip : t -> Ipaddr.V4.t -> unit Lwt.t

add_ip arp ip adds ip to the bound IP address list in the arp value, which will transmit a GARP packet also.

val query : t -> Ipaddr.V4.t -> (Macaddr.t, error) result Lwt.t

query arp ip queries the cache in arp for an ARP entry corresponding to ip, which may result in the sender sleeping waiting for a response.

val input : t -> Cstruct.t -> unit Lwt.t

input arp frame will handle an ARP frame. If it is a response, it will update its cache, otherwise will try to satisfy the request.