package amqp-client-lwt

You can search for identifiers within the package.

in-package search v0.2.0

amqp-client-lwt
- Library amqp-client-lwt
  - Amqp_client_lwt
    
    Amqp
    
    Channel
    
    Connection
    
    Exchange
    
    Message
    
    Queue
    
    Rpc
    
    Types
    
    Channel
    
    Transaction
    
    Connection
    
    Constants
    
    Exchange
    
    Framing
    
    Message
    
    Protocol_helpers
    
    Protocol
    
    Io
    
    Queue
    
    Rpc
    
    Client
    
    Server
    
    Spec
    
    Confirm
    
    Select_ok
    
    Select
    
    Tx
    
    Select_ok
    
    Select
    
    Commit_ok
    
    Commit
    
    Rollback_ok
    
    Rollback
    
    Basic
    
    Content
    
    Qos_ok
    
    Qos
    
    Consume_ok
    
    Consume
    
    Cancel_ok
    
    Cancel
    
    Publish
    
    Return
    
    Deliver
    
    Get_ok
    
    Get_empty
    
    Get
    
    Ack
    
    Reject
    
    Recover_async
    
    Recover
    
    Recover_ok
    
    Nack
    
    Queue
    
    Declare_ok
    
    Declare
    
    Bind_ok
    
    Bind
    
    Unbind_ok
    
    Unbind
    
    Purge_ok
    
    Purge
    
    Delete_ok
    
    Delete
    
    Exchange
    
    Declare_ok
    
    Declare
    
    Delete_ok
    
    Delete
    
    Bind_ok
    
    Bind
    
    Unbind_ok
    
    Unbind
    
    Channel
    
    Open_ok
    
    Open
    
    Flow_ok
    
    Flow
    
    Close_ok
    
    Close
    
    Connection
    
    Start_ok
    
    Start
    
    Secure_ok
    
    Secure
    
    Tune_ok
    
    Tune
    
    Open_ok
    
    Open
    
    Close_ok
    
    Close
    
    Blocked
    
    Unblocked
    
    Thread
    
    Deferred
    
    List
    
    Ivar
    
    Reader
    
    Writer
    
    Tcp
    
    Log
    
    Pipe
    
    Writer
    
    Reader
    
    Scheduler
- Sources
  - amqp-client-lwt
    
    amqp.ml
    
    amqp_client_lwt.ml
    
    channel.ml
    
    connection.ml
    
    constants.ml
    
    exchange.ml
    
    framing.ml
    
    message.ml
    
    protocol_helpers.ml
    
    queue.ml
    
    rpc.ml
    
    spec.ml
    
    thread.ml

Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module `Amqp_client_lwt.Channel`Source

Operations on channels

Sourcetype _ t

Sourcetype 'a confirms

Sourcetype no_confirm = [

| `Ok

]

Sourcetype with_confirm = [

| `Ok
| `Failed

]

Sourceval no_confirm : no_confirm confirms

Sourceval with_confirm : with_confirm confirms

Source

val create : 
  id:string ->
  'a confirms ->
  Framing.t ->
  Framing.channel_no ->
  'a t Thread.Deferred.t

Create a new channel. Use Connection.open_channel rather than this method directly

Sourceval close : _ t -> unit Thread.Deferred.t

Close the channel

Sourceval on_closed : _ t -> unit Thread.Deferred.t

on_closed becomes determined after then channel is closed.

If there are no consumers of this when the channel is close Connection_closed will be raised to the governing exception handler (the parent monitor in async, or Lwt.async_exception_hook in lwt).

Source

val on_return : 
  _ t ->
  (Spec.Basic.Return.t * (Spec.Basic.Content.t * string)) Thread.Pipe.Reader.t

Receive all returned messages. Reutnred message will be send to all readers returned from call to this function. Listening for returned messages are useful in e.g. rpc to know that message delivery failed and then stop waiting for a response.

Note that channels in ack mode there is no need to listen for returned messages, as message delivery will fail synchoniously.

Sourceval id : _ t -> string

Get the id of the channel

Sourceval channel_no : _ t -> int

Get the channel_no of the connection

Sourceval set_prefetch : ?count:int -> ?size:int -> _ t -> unit Thread.Deferred.t

Set prefetch counters for a channel.

parameter count
Maximum messages inflight (un-acked)

parameter size
Maximum amount of bytes inflight

Note. if using rabbitmq, the prefetch limits are set per consumer on the channel, rather than per channel (across consumers)

Source

val set_global_prefetch : 
  ?count:int ->
  ?size:int ->
  _ t ->
  unit Thread.Deferred.t

Set global prefetch counters.

parameter count
Maximum messages inflight (un-acked)

parameter size
Maximum amount of bytes inflight

Note: if using rabbitmq, the prefetch limits are set per channel (across consumers), If not, the global prefetch settings is applied globally - across consumers and channels.

Sourceval flush : _ t -> unit Thread.Deferred.t

Flush the channel, making sure all messages have been sent

Sourcemodule Transaction : sig ... end

Transactions. Transactions can be made per channel.

package amqp-client-lwt

Module Amqp_client_lwt.ChannelSource

Module `Amqp_client_lwt.Channel`Source