package amqp-client-async

You can search for identifiers within the package.

in-package search v0.2.0

amqp-client-async
- Amqp_client_async
  - Amqp
  - Channel
    
    Transaction
  - Connection
  - Constants
  - Exchange
  - Framing
  - Message
  - Protocol_helpers
  - Queue
  - Rpc
    
    Client
    
    Server
  - Spec
    
    Basic
    
    Ack
    
    Cancel
    
    Cancel_ok
    
    Consume
    
    Consume_ok
    
    Content
    
    Deliver
    
    Get
    
    Get_empty
    
    Get_ok
    
    Nack
    
    Publish
    
    Qos
    
    Qos_ok
    
    Recover
    
    Recover_async
    
    Recover_ok
    
    Reject
    
    Return
    
    Channel
    
    Close
    
    Close_ok
    
    Flow
    
    Flow_ok
    
    Open
    
    Open_ok
    
    Confirm
    
    Select
    
    Select_ok
    
    Connection
    
    Blocked
    
    Close
    
    Close_ok
    
    Open
    
    Open_ok
    
    Secure
    
    Secure_ok
    
    Start
    
    Start_ok
    
    Tune
    
    Tune_ok
    
    Unblocked
    
    Exchange
    
    Bind
    
    Bind_ok
    
    Declare
    
    Declare_ok
    
    Delete
    
    Delete_ok
    
    Unbind
    
    Unbind_ok
    
    Queue
    
    Bind
    
    Bind_ok
    
    Declare
    
    Declare_ok
    
    Delete
    
    Delete_ok
    
    Purge
    
    Purge_ok
    
    Unbind
    
    Unbind_ok
    
    Tx
    
    Commit
    
    Commit_ok
    
    Rollback
    
    Rollback_ok
    
    Select
    
    Select_ok
  - Thread
    
    Deferred
    
    List
    
    Ivar
    
    Log
    
    Pipe
    
    Reader
    
    Writer
    
    Reader
    
    Scheduler
    
    Tcp
    
    Writer

Legend:
Library
Module
Module type
Parameter
Class
Class type

type t

Connection

val connect : 
  id:string ->
  ?virtual_host:string ->
  ?port:int ->
  ?credentials:(string * string) ->
  ?heartbeat:int ->
  string ->
  t Thread.Deferred.t

Connect to an Amqp server.

connect ~id:"test" localhost connects to localhost using default guest credentials, with identity "test"

parameter id
an identifier of the connection used for tracing and debugging

parameter credentials
a tuple of username * password. The credentials are transmitted in plain text

parameter virtual_host
Named of the virtual host. Virtual must be defined on the amqp-server prior to connecting them. Default "/"

parameter port
The port to connect to

parameter heartbeat
Delay between heartbeats in seconds. Lower the number to detect connection loss faster.
If an error occurs an exception is raised. To capture and handle exceptions it is advised to detach a monitor Core.Async.Monitor and handle raised exceptions.
The most important exception is Connection_closed. As the connection is stateful (channels are tied to connections e.g), the connection cannot be re-established without redoing all initalization.

val connect_uri : id:string -> string -> t Thread.Deferred.t

Connect to amqp using an uri.

connect_uri ~id:"test" "amqp://localhost/" connects to amqp server on localhost using default port and default username/password.

The uri must be on the form: ampq://user:password@hostname:port/vhost?params. Currently only 'heartbeat_interval=<sec>' parameter is used.

val open_channel : 
  id:string ->
  'a Channel.confirms ->
  t ->
  'a Channel.t Thread.Deferred.t

Open a new channel.

parameter id
identifies the channel for tracing and debugging

val close : t -> unit Thread.Deferred.t

val on_closed : t -> unit Thread.Deferred.t

on_closed becomes ready when the connection has been closed.