package mirage-protocols

  1. Overview
  2. Docs
MirageOS signatures for network protocols

Install 

dune-project
 Dependency

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

Authors

  1. M
    Mindy Preston <meetup@yomimono.org>

Maintainers

  1. M
    Mindy Preston <meetup@yomimono.org>

Sources

mirage-protocols-v7.0.0.tbz
sha256=5659c450015b05b97448f1ee394858e383d62e26ffd88fd4fd0c5c4cd376c0f0
sha512=fd0ab477605933fbab6693b83067d64196ba52e4e968cc5a5449e059e65dde12bfba543eeb39f2562bfe5d5c25b5268e73dee24fd55e0ad390a6c6795d932ac4

doc/mirage-protocols/Mirage_protocols/module-type-UDPV6/index.html

Module type Mirage_protocols.UDPV6Source

UDPv6 layer

Sourcetype error

The type for UDP errors.

Sourceval pp_error : error Fmt.t

pp is the pretty-printer for errors.

Sourcetype ipaddr = Ipaddr.V6.t

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.

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

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.

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