package git-mirage

You can search for identifiers within the package.

in-package search v0.2.0

A package to use ocaml-git with MirageOS backend

Install

Dune Dependency

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

Authors

T

Thomas Gazagnaire

Maintainers

Sources

git-3.8.0.tbz

sha256=f6c628e3628d25686cec4cdff8132f9433e95938bdcb43975778d28d33a0b077

sha512=779bdd7a1657e859ed47b46ef9da007b5f43f4446f8cea831f29fae662efdd33a39aa2ee90b9f8d8b6360f2abb78038a7592633efa26e8adc5d2ae20d86d8015

doc/git-mirage.happy-eyeballs/Git_mirage_happy_eyeballs/TCPV4V6/argument-1-Stack/UDP/index.html

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