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 (15)

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/Dns_client/Make/argument-1-T/index.html

Parameter Make.T

type context

A context is a network connection initialized by T.connect

type +'a io

io is the type of an effect. 'err is a polymorphic variant.

type io_addr

An address for a given context type, usually this will consist of IP address + a TCP/IP or UDP/IP port number, but for some context types it can carry additional information for purposes of cryptographic verification.

type stack

A stack with which to connect.

type t

The abstract state of a DNS client.

val create : ?nameservers:(Dns.proto * io_addr list) -> timeout:int64 -> stack -> t

create ~nameservers ~timeout stack creates the state record of the DNS client. We use timeout (ns) as a cumulative time budget for connect and request timeouts.

val nameservers : t -> Dns.proto * io_addr list

The address of a nameservers that is supposed to work with the underlying context, can be used if the user does not want to bother with configuring their own.

val rng : int -> Cstruct.t

rng t is a random number generator.

val clock : unit -> int64

clock t is the monotonic clock.

val connect : t -> (context, [> `Msg of string ]) result io

connect addr is a new connection (context) to addr, or an error.

val send_recv : context -> Cstruct.t -> (Cstruct.t, [> `Msg of string ]) result io

send_recv context buffer sends buffer to the context upstream, and then reads a buffer.

val close : context -> unit io

close context closes the context, freeing up resources.

val bind : 'a io -> ('a -> 'b io) -> 'b io

a.k.a. >>=

val lift : 'a -> 'a io