package conduit

You can search for identifiers within the package.

in-package search v0.2.0

package conduit

conduit
- Conduit
  - IO
- Conduit_trie
- Resolver
  - Make
    
    IO
  - S
conduit.lwt
- Resolver_lwt
  - IO
  - S
conduit.lwt-unix
conduit.mirage
- Conduit_mirage
  - Context
  - Handler
  - S
    
    With_tcp
  - VCHAN
  - With_tcp
  - XS
- Resolver_mirage
  - Make
  - Make_with_stack
    
    R
  - S

Legend:
Library
Module
Module type
Parameter
Class
Class type

type buffer = buffer

The type for memory buffers.

type ip = ipv4

The type for IPv4/6 stacks for this stack to connect to.

type ipaddr = ipv4addr

The type for an IP address representations.

type ipinput

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

type error = [

| `Unknown of string
(*
an undiagnosed error
*)

]

The type for IO operation errors.

include V1.DEVICE
  with type error := error
   and type id := ip
  with type +'a io = 'a io
  with type t = udpv4

type +'a io = 'a io

The type for potentially blocking I/O operation

type t = udpv4

The type representing the internal state of the device

val disconnect : t -> unit io

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

type callback = src:ipaddr -> dst:ipaddr -> src_port:int -> buffer -> unit io

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 : 
  ?source_port:int ->
  dest_ip:ipaddr ->
  dest_port:int ->
  t ->
  buffer ->
  unit io

write ~source_port ~dest_ip ~dest_port udp data is a thread that writes data from an optional source_port to a dest_ip and dest_port IPv4 address pair.