async_extra v0.9.0 · OCaml Package

include module type of struct include Async_extra.Import.Rpc_kernel.Connection end

type t = Async_rpc_kernel.Rpc.Connection.t

include sig ... end

val sexp_of_t : t -> Sexplib.Sexp.t

module Heartbeat_config =
  Async_extra.Import.Rpc_kernel.Connection.Heartbeat_config

module Client_implementations =
  Async_extra.Import.Rpc_kernel.Connection.Client_implementations

val description : t -> Core_kernel.Info.t

val add_heartbeat_callback : t -> (unit -> unit) -> unit

After add_heartbeat_callback t f, f () will be called on every subsequent heartbeat to t.

val close : 
  ?streaming_responses_flush_timeout:Core_kernel.Time_ns.Span.t ->
  ?reason:Core_kernel.Info.t ->
  t ->
  unit Async_kernel.Deferred.t

close starts closing the connection's transport, and returns a deferred that becomes determined when its close completes. It is ok to call close multiple times on the same t; calls subsequent to the initial call will have no effect, but will return the same deferred as the original call.

Before closing the underlying transport's writer, close waits for all streaming reponses to be Pipe.upstream_flushed with a timeout of streaming_responses_flush_timeout.

The reason for closing the connection will be passed to callers of close_reason.

val close_finished : t -> unit Async_kernel.Deferred.t

close_finished becomes determined after the close of the connection's transport completes, i.e. the same deferred that close returns. close_finished differs from close in that it does not have the side effect of initiating a close.

val close_reason : 
  t ->
  on_close:[ `started | `finished ] ->
  Core_kernel.Info.t Async_kernel.Deferred.t

close_reason ~on_close t becomes determined when close starts or finishes based on on_close, but additionally returns the reason that the connection was closed.

val is_closed : t -> bool

is_closed t returns true iff close t has been called. close may be called internally upon errors or timeouts.

val bytes_to_write : t -> int

bytes_to_write and flushed just call the similarly named functions on the Transport.Writer.t within a connection.

val flushed : t -> unit Async_kernel.Deferred.t

val create : 
  ?implementations:'s Implementations.t ->
  connection_state:(t -> 's) ->
  ?max_message_size:int ->
  ?handshake_timeout:Core.Time.Span.t ->
  ?heartbeat_config:Heartbeat_config.t ->
  ?description:Core.Info.t ->
  Async_extra.Import.Reader.t ->
  Async_extra.Import.Writer.t ->
  (t, Core.Exn.t) Core.Result.t Async_extra.Import.Deferred.t

These functions are mostly the same as the ones with the same names in Async_rpc_kernel.Std.Rpc.Connection; see Connection_intf in that library for documentation. The differences are that:

they take an Async_unix.Std.Reader.t, Async_unix.Std.Writer.t and max_message_size instead of a Transport.t
they use Time instead of Time_ns

val contains_magic_prefix : 
  Async_extra.Import.Reader.t ->
  bool Async_extra.Import.Deferred.t

As of Feb 2017, the RPC protocol started to contain a magic number so that one can identify RPC communication. The bool returned by contains_magic_prefix says whether this magic number was observed.

This operation is a "peek" that does not advanced any pointers associated with the reader. In particular, it makes sense to call create on a reader after calling this function.

val with_close : 
  ?implementations:'s Implementations.t ->
  ?max_message_size:int ->
  ?handshake_timeout:Core.Time.Span.t ->
  ?heartbeat_config:Heartbeat_config.t ->
  connection_state:(t -> 's) ->
  Async_extra.Import.Reader.t ->
  Async_extra.Import.Writer.t ->
  dispatch_queries:(t -> 'a Async_extra.Import.Deferred.t) ->
  on_handshake_error:
    [ `Raise | `Call of Core.Exn.t -> 'a Async_extra.Import.Deferred.t ] ->
  'a Async_extra.Import.Deferred.t

val server_with_close : 
  ?max_message_size:int ->
  ?handshake_timeout:Core.Time.Span.t ->
  ?heartbeat_config:Heartbeat_config.t ->
  Async_extra.Import.Reader.t ->
  Async_extra.Import.Writer.t ->
  implementations:'s Implementations.t ->
  connection_state:(t -> 's) ->
  on_handshake_error:
    [ `Raise
    | `Ignore
    | `Call of Core.Exn.t -> unit Async_extra.Import.Deferred.t ] ->
  unit Async_extra.Import.Deferred.t

type transport_maker =
  Async_extra.Import.Fd.t ->
  max_message_size:int ->
  Transport.t

A function creating a transport from a file descriptor. It is responsible for setting the low-level parameters of the underlying transport.

For instance to setup a transport using Async.{Reader,Writer} and set a buffer age limit on the writer, you can pass this to the functions of this module:

~make_transport:(fun fd ~max_message_size ->
  Rpc.Transport.of_fd fd ~max_message_size ~buffer_age_limit:`Unlimited)

type on_handshake_error = [

| `Raise
| `Ignore
| `Call of Core.Exn.t -> unit

]

val serve : 
  implementations:'s Implementations.t ->
  initial_connection_state:('address -> t -> 's) ->
  where_to_listen:('address, 'listening_on) Tcp.Where_to_listen.t ->
  ?max_connections:int ->
  ?backlog:int ->
  ?max_message_size:int ->
  ?make_transport:transport_maker ->
  ?handshake_timeout:Core.Time.Span.t ->
  ?heartbeat_config:Heartbeat_config.t ->
  ?auth:('address -> bool) ->
  ?on_handshake_error:on_handshake_error ->
  unit ->
  ('address, 'listening_on) Tcp.Server.t Async_extra.Import.Deferred.t

serve implementations ~port ?on_handshake_error () starts a server with the given implementation on port. The optional auth function will be called on all incoming connections with the address info of the client and will disconnect the client immediately if it returns false. This auth mechanism is generic and does nothing other than disconnect the client - any logging or record of the reasons is the responsibility of the auth function itself.

val serve_with_transport : 
  handshake_timeout:Core.Time.Span.t option ->
  heartbeat_config:Heartbeat_config.t option ->
  implementations:'s Implementations.t ->
  description:Core.Info.t ->
  connection_state:(t -> 's) ->
  on_handshake_error:on_handshake_error ->
  Transport.t ->
  unit Async_extra.Import.Deferred.t

val client : 
  host:string ->
  port:int ->
  ?via_local_interface:Async_extra.Import.Unix.Inet_addr.t ->
  ?implementations:_ Client_implementations.t ->
  ?max_message_size:int ->
  ?make_transport:transport_maker ->
  ?handshake_timeout:Core.Time.Span.t ->
  ?heartbeat_config:Heartbeat_config.t ->
  ?description:Core.Info.t ->
  unit ->
  (t, Core.Exn.t) Core.Result.t Async_extra.Import.Deferred.t

client ~host ~port () connects to the server at (host,port) and returns the connection or an Error if a connection could not be made. It is the responsibility of the caller to eventually call close.

In client and with_client, the handshake_timeout encompasses both the TCP connection timeout and the timeout for this module's own handshake.

val with_client : 
  host:string ->
  port:int ->
  ?via_local_interface:Async_extra.Import.Unix.Inet_addr.t ->
  ?implementations:_ Client_implementations.t ->
  ?max_message_size:int ->
  ?make_transport:transport_maker ->
  ?handshake_timeout:Core.Time.Span.t ->
  ?heartbeat_config:Heartbeat_config.t ->
  (t -> 'a Async_extra.Import.Deferred.t) ->
  ('a, Core.Exn.t) Core.Result.t Async_extra.Import.Deferred.t

with_client ~host ~port f connects to the server at (host,port) and runs f until an exception is thrown or until the returned Deferred is fulfilled.

NOTE: As with with_close, you should be careful when using this with Pipe_rpc. See with_close for more information.

package async_extra