package dns-forward

You can search for identifiers within the package.

in-package search v0.2.0

dns-forward
- Dns_forward
  - Comparable
  - Config
    
    Address
    
    Map
    
    Set
    
    Domain
    
    Map
    
    Set
    
    Server
    
    Map
    
    Set
    
    Unix
  - Error
    
    Infix
  - Flow
    
    Client
    
    Server
  - Framing
    
    S
    
    Tcp
    
    Flow
    
    Udp
    
    Flow
  - Resolver
    
    Make
    
    Client
    
    Clock
    
    Time
    
    S
  - Rpc
    
    Client
    
    Make
    
    Flow
    
    Framing
    
    Time
    
    S
    
    Server
    
    Make
    
    Flow
    
    Framing
    
    Time
    
    S
  - Server
    
    Make
    
    Resolver
    
    Server
    
    S

Legend:
Library
Module
Module type
Parameter
Class
Class type

type t

type clock

type address = Config.Address.t

type message_cb =
  ?src:address ->
  ?dst:address ->
  buf:Cstruct.t ->
  unit ->
  unit Lwt.t

A callback called per message, which permits recording and analysis. If an address is unknown (e.g. it is selected by the kernel when routing the packets) then the corresponding argument will be omitted

val create : 
  ?local_names_cb:(Dns.Packet.question -> Dns.Packet.rr list option Lwt.t) ->
  ?message_cb:message_cb ->
  Config.t ->
  clock ->
  t Lwt.t

Construct a resolver given some configuration

val destroy : t -> unit Lwt.t

Destroy and free all resources associated with the resolver

val answer : Cstruct.t -> t -> Cstruct.t Error.t

Process a query by first checking whether the name can be satisfied locally via the local_names_cb and failing that, sending it to upstream servers according to the resolver configuration. The call will block forever if no server with a timeout is chosen; the client should be prepared to timeout and cancel the thread.