package tcpip

Overview
No Docs

You can search for identifiers within the package.

in-package search v0.2.0

OCaml TCP/IP networking stack, used in MirageOS

Install

dune-project

Dependency

github.com Edit opam file Versions (7)

Authors

Maintainers

A

anil@recoil.org

Sources

tcpip-9.0.0.tbz

sha256=59377ed359080d8da94aec91474a533bad955c12be79827bec853ccb496d659a

sha512=3f2ed5cbd5bdcd9a664e9ee0b7dbfc65b0a698e6c4bb77ee6a85a139b18cdee24415d76fb821466a9aff2e390318a8657b83871768c259557f25684ab6ccf83b

doc/tcpip.stack-direct/Tcpip_stack_direct/MakeV4V6/argument-6-Udp/index.html

Parameter `MakeV4V6.Udp`

type error

The type for UDP errors.

val pp_error : error Fmt.t

pp is the pretty-printer for errors.

type ipaddr = Ipaddr.t

The type for an IP address representations.

type t

The type representing the internal state of the UDP layer.

val disconnect : t -> unit Lwt.t

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

type callback =
  src:ipaddr ->
  dst:ipaddr ->
  src_port:int ->
  Cstruct.t ->
  unit Lwt.t

The type for callback functions that adds the UDP metadata for src and dst IP addresses, the src_port of the connection and the buffer payload of the datagram.

val listen : t -> port:int -> callback -> unit

listen t ~port callback executes callback for each packet received on port.

raises Invalid_argument
if port < 0 or port > 65535

val unlisten : t -> port:int -> unit

unlisten t ~port stops any listeners on port.

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

input t demultiplexes incoming datagrams based on their destination port.

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

write ~src ~src_port ~ttl ~dst ~dst_port udp data is a task that writes data from an optional src and src_port to a dst and dst_port IP address pair. An optional time-to-live (ttl) is passed through to the IP layer.