package dns-client

  1. Overview
  2. Docs
DNS resolver API

Install 

dune-project
 Dependency

github.com Readme Changelog BSD-2-Clause License Edit opam file Versions (12)

Authors

  1. J
    Joe Hill

Maintainers

  1. T
    team AT robur dot coop

Sources

dns-6.3.0.tbz
sha256=dc40237a737d1088b83ec5c26437af9843c3692e316c449b71b07ba458307351
sha512=4716559298ab5c5c47bcb94f3614ea3309033a710469ca2a16e1eda8012b596897a9f26007ed8fb360e6119cf94e88c4ae7e74137863959a4c54aa9983277020

doc/dns-client.mirage/Dns_client_mirage/Make/argument-5-S/UDP/index.html

Module S.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.

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.