package async

  1. Overview
  2. Docs
package async
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Persistent_connection.MakeSource

Parameters

module Conn : T

Signature

include Persistent_connection_kernel.S with type conn = Conn.t with type address = Conn.Address.t
Sourcetype t
Sourcetype address = Conn.Address.t

The address of a service to which one can connect. E.g. Host_and_port.t is a reasonable choice when making a TCP connection.

Sourcetype conn = Conn.t

A connection, perhaps embellished with additional information upon connection.

Sourcemodule Event : sig ... end

connected returns the first available connection from the time it is called. When currently connected, the returned deferred is already determined. If closed has been called, then the returned deferred is never determined.

Sourceval connected_or_failed_to_connect : t -> conn Core_kernel.Or_error.t Async_kernel.Deferred.t

connected_or_failed_to_connect is immediately determined as Ok _ if t is already connected. Otherwise it becomes determined the next time t becomes connected or fails to connect or when t is closed.

Sourceval current_connection : t -> conn option

The current connection, if any.

close t closes the current connection and stops it from trying to reconnect. After the deferred it returns becomes determined, the last connection has been closed and no others will be attempted.

Note: no close calls are ever generated internally in response to the connection being closed by the other side.

Sourceval close : t -> unit Async_kernel.Deferred.t

close t closes the connection. The returned deferred becomes determined once any resources needed to maintain the connection have been released.

Sourceval is_closed : t -> bool

is_closed t returns true if close has ever been called (even if the returned deferred has not yet been fulfilled).

Note that some modules implementing Closable may call close internally upon noticing that the connection was closed by the other side. The interface of such a module ought to say that this is the case.

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

close_finished t becomes determined at the same time as the result of the first call to close. close_finished differs from close in that it does not have the side effect of initiating a close.

Sourceval create : server_name:string -> ?log:Async.Log.t -> ?on_event:(Event.t -> unit Async.Deferred.t) -> ?retry_delay:(unit -> Core.Time.Span.t) -> ?random_state:Core.Random.State.t -> ?time_source:Async.Time_source.t -> connect:(address -> conn Core.Or_error.t Async.Deferred.t) -> (unit -> address Core.Or_error.t Async.Deferred.t) -> t
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct