package dns-server

You can search for identifiers within the package.

in-package search v0.2.0

DNS server, primary and secondary

Install

dune-project

Dependency

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

Authors

H

Hannes Mehnert <hannes@mehnert.org>

Maintainers

T

team AT robur dot coop

Sources

dns-10.2.0.tbz

sha256=ad27c09256f9848658ee625d69140c898c24694aca43550bfb6fee5bc83e74e8

sha512=d5d6a0580d55485cbe46841fb8d5acd7de801bf6ce980f31888836425e39f23f3ff2e909c5f195b15a36166ae97ecd68d24429318028ae8d1ea9322df2f5a65d

doc/dns-server.mirage/Dns_server_mirage/Make/argument-1-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.

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.