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

dune-project

Dependency

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

Authors

Maintainers

A

anil@recoil.org

Sources

tcpip-8.2.0.tbz

sha256=916e688aba897676c444db8129f4963ad739f8d1be631d9e009c6228b4b7d6ed

sha512=a8f5fa8f7e96758075c93211132839950477b756fba490207a7d630f2766757bbb44bbdd02e2b1f2b4a7d83d4d8b10d34cb03903bbd516e7d7c1a9a987eb1915

doc/tcpip.udp/Udp/Make/index.html

Module `Udp.Make`Source

Parameters

module IP : Tcpip.Ip.S

module R : Mirage_crypto_rng_mirage.S

Signature

include Tcpip.Udp.S with type ipaddr = IP.ipaddr

Sourcetype error

The type for UDP errors.

Sourceval pp_error : error Fmt.t

pp is the pretty-printer for errors.

Sourcetype ipaddr = IP.ipaddr

The type for an IP address representations.

Sourcetype t

The type representing the internal state of the UDP layer.

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

Source

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.

Sourceval 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

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

unlisten t ~port stops any listeners on port.

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

input t demultiplexes incoming datagrams based on their destination port.

Source

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.

Sourceval connect : IP.t -> t Lwt.t

On This Page

Parameters
Signature