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/index.html

Module Dns_client_mirage.MakeSource

Parameters

module T : Mirage_time.S

Signature

Sourcemodule Transport : Dns_client.S with type io_addr = [ `Plaintext of Ipaddr.t * int | `Tls of Tls.Config.client * Ipaddr.t * int ] and type +'a io = 'a Lwt.t with type stack = S.t
include sig ... end
Sourceval create : ?size:int -> ?edns:[ `Auto | `Manual of Dns.Edns.t | `None ] -> ?nameservers:(Dns.proto * Transport.io_addr list) -> ?timeout:int64 -> Transport.stack -> t
Sourceval nameservers : t -> Dns.proto * Transport.io_addr list
Sourceval getaddrinfo : t -> 'response Dns.Rr_map.key -> 'a Domain_name.t -> ('response, [> `Msg of string ]) result Transport.io
Sourceval gethostbyname : t -> [ `host ] Domain_name.t -> (Ipaddr.V4.t, [> `Msg of string ]) result Transport.io
Sourceval gethostbyname6 : t -> [ `host ] Domain_name.t -> (Ipaddr.V6.t, [> `Msg of string ]) result Transport.io
Sourceval get_resource_record : t -> 'response Dns.Rr_map.key -> 'a Domain_name.t -> ('response, [> `Msg of string | `No_data of [ `raw ] Domain_name.t * Dns.Soa.t | `No_domain of [ `raw ] Domain_name.t * Dns.Soa.t ]) result Transport.io
Sourceval get_raw_reply : t -> 'response Dns.Rr_map.key -> 'a Domain_name.t -> (Dns.Packet.reply, [> `Msg of string | `Partial ]) result Transport.io
Sourceval nameserver_of_string : string -> (Transport.io_addr, [> `Msg of string ]) result

nameserver_of_string authenticators str returns a Transport.io_addr from the given string. The format is:

  • tcp:<ipaddr>(:port)? for a simple nameserver and we will communicate with it via the TCP/IP protocol
  • tls:<ipaddr>(:port)?(!authenticator)? for a nameserver and we will communicate with it via the TCP/IP protocol plus the TLS encrypted layer. The user can verify the nameserver via an authenticator (see X509.Authenticator.of_string for the format of it). By default, Ca_certs_nss.authenticator is used.
Sourceval connect : ?nameservers:string list -> ?timeout:int64 -> Transport.stack -> t Lwt.t

connect ?nameservers ?timeout stack creates a DNS entity which is able to resolve domain-name. It expects few optional arguments:

  • nameservers a list of nameservers used to resolve domain-names
  • timeout (in nanoseconds), passed to create