package arp

You can search for identifiers within the package.

in-package search v0.2.0

Address Resolution Protocol purely in OCaml

Install

Dune Dependency

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

Authors

H

Hannes Mehnert <hannes@mehnert.org>

Maintainers

H

Hannes Mehnert <hannes@mehnert.org>

Sources

arp-4.0.0.tbz

sha256=0b6061ff637066a0891227429e487044ca16dc0b1b42dbf074587d2222640da5

sha512=101e54c5de0c49ee91f07d4fbf381938689b5391d287609e3a0e98f2d8dc99b5801cfa0bb91da399c47e89305ba924b29801dbe1defb566f768cfbde96bbccc0

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

Module type `Arp.S`Source

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 [>

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