package mirage-protocols

You can search for identifiers within the package.

in-package search v0.2.0

mirage-protocols
- Mirage_protocols
  - ARP
  - Arp
  - ETHERNET
  - Ethernet
  - ICMP
  - ICMPV4
  - ICMPV6
  - IP
  - IPV4
  - IPV6
  - Ip
  - Keepalive
  - TCP
  - TCPV4
  - TCPV6
  - Tcp
  - UDP
  - UDPV4
  - UDPV6
- Mirage_protocols_lwt

Legend:
Library
Module
Module type
Parameter
Class
Class type

User datagram protocol layer: connectionless message-oriented communication.

type error

The type for UDP errors.

val pp_error : error Fmt.t

pp is the pretty-printer for errors.

type ipaddr

The type for an IP address representations.

type ipinput

The type for input function continuation to pass onto the underlying IP layer. This will normally be a NOOP for a conventional kernel, but a direct implementation will parse the buffer.

include Mirage_device.S

type t

val disconnect : t -> unit Lwt.t

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 input : listeners:(dst_port:int -> callback option) -> t -> ipinput

input listeners t demultiplexes incoming datagrams based on their destination port. The listeners callback will either return a concrete handler or a None, which results in the datagram being dropped.

val write : 
  ?src:ipaddr ->
  ?src_port:int ->
  ?ttl:int ->
  dst:ipaddr ->
  dst_port:int ->
  t ->
  Cstruct.t ->
  (unit, error) Stdlib.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.