package arp

  1. Overview
  2. Docs
Address Resolution Protocol purely in OCaml

Install 

dune-project
 Dependency

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

Authors

  1. H
    Hannes Mehnert <hannes@mehnert.org>

Maintainers

  1. H
    Hannes Mehnert <hannes@mehnert.org>

Sources

arp-4.1.0.tbz
sha256=02f8f1bde52049104d85942f0a9d686be25f117488ae89c40a4e27368b3c865d
sha512=9a602b22cc25becf8cc28248356931ffe4b37dc403881745ea73103165b0b8dab85007ab9e7bc024b59be92fc93165a996ca71a01d132aa79eb7c5b2a1839b90

doc/arp.mirage/Arp/module-type-S/index.html

Module type Arp.SSource

Address resolution protocol, translating network addresses (e.g. IPv4) into link layer addresses (MAC).

Sourcetype t

The type representing the internal state of the ARP layer.

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

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

The type for ARP errors.

Sourceval pp_error : error Fmt.t

pp_error is the pretty-printer for errors.

Sourceval pp : t Fmt.t

Prettyprint cache contents

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

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

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

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

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

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

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