package dns-forward

You can search for identifiers within the package.

in-package search v0.2.0

package dns-forward

dns-forward
- Dns_forward
  - Comparable
  - Config
    
    Address
    
    Domain
    
    Server
    
    Unix
  - Error
    
    Infix
  - Flow
    
    Client
    
    Server
  - Framing
    
    S
    
    Tcp
    
    Udp
  - Resolver
    
    Make
    
    Client
    
    S
  - Rpc
    
    Client
    
    Nonpersistent
    
    Make
    
    Flow
    
    Framing
    
    Persistent
    
    Make
    
    Flow
    
    Framing
    
    S
    
    Server
    
    Make
    
    Flow
    
    Framing
    
    S
  - Server
    
    Make
    
    Resolver
    
    Server
    
    S

Legend:
Library
Module
Module type
Parameter
Class
Class type

type t

A Remote Procedure Call client which can send requests to a server and receive responses.

type request = Cstruct.t

A complete request

type response = Cstruct.t

A complete response

type address = Config.Address.t

The address of the remote endpoint

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 connect : 
  gen_transaction_id:(int -> int) ->
  ?message_cb:message_cb ->
  address ->
  t Error.t

Connect to the remote server

val rpc : t -> request -> response Error.t

Send a request and await a response. Multiple threads may call this in parallel and it is the implementation's job to associate the right response with the original request.

val disconnect : t -> unit Lwt.t

Disconnect from the server and free all resources.