package happy-eyeballs-lwt

You can search for identifiers within the package.

in-package search v0.2.0

happy-eyeballs-lwt
- Happy_eyeballs_lwt

Legend:
Library
Module
Module type
Parameter
Class
Class type

type t

The type of the abstract state of happy eyeballs.

val create : unit -> t

create () creates an initial state of happy eyeballs.

val connect_host : 
  t ->
  [ `host ] Domain_name.t ->
  int list ->
  ((Ipaddr.t * int) * Lwt_unix.file_descr, [ `Msg of string ]) Stdlib.result
    Lwt.t

connect_host t host ports establishes a connection to host on ports (tried in sequence).

raises Failure
if ports is empty.

val connect_ip : 
  ?shuffle:bool ->
  t ->
  Ipaddr.t list ->
  int list ->
  ((Ipaddr.t * int) * Lwt_unix.file_descr, [ `Msg of string ]) Stdlib.result
    Lwt.t

connect_ip ~shuffle t ips ports establishes a connection to ips on ports. If shuffle is provided and true (default: falsE), the list of ips will be mixed before connection attempts.

raises Failure
if ips is the empty list, or ports is the empty list.

val connect : 
  t ->
  string ->
  int list ->
  ((Ipaddr.t * int) * Lwt_unix.file_descr, [ `Msg of string ]) Stdlib.result
    Lwt.t

connect t host ports establishes a connection to host on ports, which may be a host name, or an IP address.

raises Failure
if ports is the empty list.