package tcpip

You can search for identifiers within the package.

in-package search v0.2.0

OCaml TCP/IP networking stack, used in MirageOS

Install

sha256=916e688aba897676c444db8129f4963ad739f8d1be631d9e009c6228b4b7d6ed

sha512=a8f5fa8f7e96758075c93211132839950477b756fba490207a7d630f2766757bbb44bbdd02e2b1f2b4a7d83d4d8b10d34cb03903bbd516e7d7c1a9a987eb1915

type t

The type representing the internal state of the ICMP layer.

val disconnect : t -> unit Lwt.t

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

type ipaddr = Ipaddr.V4.t

The type for IP addresses.

type error

The type for ICMP errors.

val pp_error : error Fmt.t

pp_error is the pretty-printer for errors.

val input : t -> src:ipaddr -> dst:ipaddr -> Cstruct.t -> unit Lwt.t

input t src dst buffer reacts to the ICMP message in buffer.

val write : 
  t ->
  ?src:ipaddr ->
  dst:ipaddr ->
  ?ttl:int ->
  Cstruct.t ->
  (unit, error) result Lwt.t

write t ~src ~dst ~ttl buffer sends the ICMP message in buffer to dst over IP. Passes the time-to-live (ttl) to the IP stack if given.