package tcpip

  1. Overview
  2. Docs
OCaml TCP/IP networking stack, used in MirageOS

Install 

dune-project
 Dependency

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

Authors

  1. A
    Anil Madhavapeddy
  2. B
    Balraj Singh
  3. R
    Richard Mortier
  4. N
    Nicolas Ojeda Bar
  5. T
    Thomas Gazagnaire
  6. V
    Vincent Bernardoff
  7. M
    Magnus Skjegstad
  8. M
    Mindy Preston
  9. T
    Thomas Leonard
  10. D
    David Scott
  11. G
    Gabor Pali
  12. H
    Hannes Mehnert
  13. H
    Haris Rotsos
  14. K
    Kia
  15. L
    Luke Dunstan
  16. P
    Pablo Polvorin
  17. T
    Tim Cuthbertson
  18. L
    lnmx
  19. P
    pqwy

Maintainers

  1. A
    anil@recoil.org

Sources

tcpip-8.0.0.tbz
sha256=36b4c156be16702ba4c6d781a2da8ba1462b22370d15570e1116056cbf025233
sha512=56a1aab616349152beff7d0a504db15dc3d0010cb36322ce06b7abb43bd9d1a6ec0daa23fd6632fcc758c89737ba48046bb591d4a70021e273b80e716b55c44f

doc/tcpip.ipv4/Routing/Make/argument-2-A/index.html

Parameter Make.A

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.