api documentation for amqplib (v0.5.1)

An AMQP 0-9-1 (e.g., RabbitMQ) library and client.

table of contents

  1. module amqplib
    1. function amqplib.connect (url, connOptions)
    2. object amqplib.api_args
    3. object amqplib.bitset
    4. object amqplib.callback_api
    5. object amqplib.callback_model
    6. object amqplib.channel
    7. object amqplib.channel_model
    8. object amqplib.codec
    9. object amqplib.connection
    10. object amqplib.credentials
    11. object amqplib.defs
    12. object amqplib.error
    13. object amqplib.format
    14. object amqplib.frame
    15. object amqplib.heartbeat
    16. object amqplib.mux
  2. module amqplib.api_args
    1. function amqplib.api_args.ack (tag, allUpTo)
    2. function amqplib.api_args.assertExchange (exchange, type, options)
    3. function amqplib.api_args.assertQueue (queue, options)
    4. function amqplib.api_args.bindExchange (dest, source, pattern, argt)
    5. function amqplib.api_args.bindQueue (queue, source, pattern, argt)
    6. function amqplib.api_args.cancel (consumerTag)
    7. function amqplib.api_args.checkExchange (exchange)
    8. function amqplib.api_args.checkQueue (queue)
    9. function amqplib.api_args.consume (queue, options)
    10. function amqplib.api_args.deleteExchange (exchange, options)
    11. function amqplib.api_args.deleteQueue (queue, options)
    12. function amqplib.api_args.get (queue, options)
    13. function amqplib.api_args.nack (tag, allUpTo, requeue)
    14. function amqplib.api_args.prefetch (count, global)
    15. function amqplib.api_args.publish (exchange, routingKey, options)
    16. function amqplib.api_args.purgeQueue (queue)
    17. function amqplib.api_args.recover ()
    18. function amqplib.api_args.reject (tag, requeue)
    19. function amqplib.api_args.unbindExchange (dest, source, pattern, argt)
    20. function amqplib.api_args.unbindQueue (queue, source, pattern, argt)
  3. module amqplib.bitset
    1. function amqplib.bitset.BitSet (size)
  4. module amqplib.callback_api
    1. function amqplib.callback_api.connect (url, options, cb)
    2. object amqplib.callback_api.credentials
  5. module amqplib.callback_model
    1. function amqplib.callback_model.CallbackModel (connection)
    2. function amqplib.callback_model.Channel (connection)
    3. function amqplib.callback_model.ConfirmChannel (connection)
  6. module amqplib.channel
    1. function amqplib.channel.BaseChannel (connection)
    2. function amqplib.channel.Channel (connection)
    3. function amqplib.channel.acceptMessage (continuation)
  7. module amqplib.channel_model
    1. function amqplib.channel_model.Channel (connection)
    2. function amqplib.channel_model.ChannelModel (connection)
    3. function amqplib.channel_model.ConfirmChannel (connection)
  8. module amqplib.codec
    1. function amqplib.codec.decodeFields (slice)
    2. function amqplib.codec.encodeTable (buffer, val, offset)
  9. module amqplib.connect
    1. function amqplib.connect (url, socketOptions, openCallback)
  10. module amqplib.connection
    1. function amqplib.connection.Connection (underlying)
    2. function amqplib.connection.isFatalError (error)
  11. module amqplib.credentials
    1. function amqplib.credentials.external ()
    2. function amqplib.credentials.plain (user, passwd)
  12. module amqplib.defs
    1. function amqplib.defs.decode (id, buf)
    2. function amqplib.defs.encodeMethod (id, channel, fields)
    3. function amqplib.defs.encodeProperties (id, channel, size, fields)
    4. function amqplib.defs.info (id)
    5. number amqplib.defs.AccessRequest
    6. number amqplib.defs.AccessRequestOk
    7. number amqplib.defs.BasicAck
    8. number amqplib.defs.BasicCancel
    9. number amqplib.defs.BasicCancelOk
    10. number amqplib.defs.BasicConsume
    11. number amqplib.defs.BasicConsumeOk
    12. number amqplib.defs.BasicDeliver
    13. number amqplib.defs.BasicGet
    14. number amqplib.defs.BasicGetEmpty
    15. number amqplib.defs.BasicGetOk
    16. number amqplib.defs.BasicNack
    17. number amqplib.defs.BasicProperties
    18. number amqplib.defs.BasicPublish
    19. number amqplib.defs.BasicQos
    20. number amqplib.defs.BasicQosOk
    21. number amqplib.defs.BasicRecover
    22. number amqplib.defs.BasicRecoverAsync
    23. number amqplib.defs.BasicRecoverOk
    24. number amqplib.defs.BasicReject
    25. number amqplib.defs.BasicReturn
    26. number amqplib.defs.ChannelClose
    27. number amqplib.defs.ChannelCloseOk
    28. number amqplib.defs.ChannelFlow
    29. number amqplib.defs.ChannelFlowOk
    30. number amqplib.defs.ChannelOpen
    31. number amqplib.defs.ChannelOpenOk
    32. number amqplib.defs.ConfirmSelect
    33. number amqplib.defs.ConfirmSelectOk
    34. number amqplib.defs.ConnectionBlocked
    35. number amqplib.defs.ConnectionClose
    36. number amqplib.defs.ConnectionCloseOk
    37. number amqplib.defs.ConnectionOpen
    38. number amqplib.defs.ConnectionOpenOk
    39. number amqplib.defs.ConnectionSecure
    40. number amqplib.defs.ConnectionSecureOk
    41. number amqplib.defs.ConnectionStart
    42. number amqplib.defs.ConnectionStartOk
    43. number amqplib.defs.ConnectionTune
    44. number amqplib.defs.ConnectionTuneOk
    45. number amqplib.defs.ConnectionUnblocked
    46. number amqplib.defs.ExchangeBind
    47. number amqplib.defs.ExchangeBindOk
    48. number amqplib.defs.ExchangeDeclare
    49. number amqplib.defs.ExchangeDeclareOk
    50. number amqplib.defs.ExchangeDelete
    51. number amqplib.defs.ExchangeDeleteOk
    52. number amqplib.defs.ExchangeUnbind
    53. number amqplib.defs.ExchangeUnbindOk
    54. number amqplib.defs.FRAME_OVERHEAD
    55. number amqplib.defs.QueueBind
    56. number amqplib.defs.QueueBindOk
    57. number amqplib.defs.QueueDeclare
    58. number amqplib.defs.QueueDeclareOk
    59. number amqplib.defs.QueueDelete
    60. number amqplib.defs.QueueDeleteOk
    61. number amqplib.defs.QueuePurge
    62. number amqplib.defs.QueuePurgeOk
    63. number amqplib.defs.QueueUnbind
    64. number amqplib.defs.QueueUnbindOk
    65. number amqplib.defs.TxCommit
    66. number amqplib.defs.TxCommitOk
    67. number amqplib.defs.TxRollback
    68. number amqplib.defs.TxRollbackOk
    69. number amqplib.defs.TxSelect
    70. number amqplib.defs.TxSelectOk
    71. object amqplib.defs.constant_strs
    72. object amqplib.defs.constants
    73. object amqplib.defs.methodInfoAccessRequest
    74. object amqplib.defs.methodInfoAccessRequestOk
    75. object amqplib.defs.methodInfoBasicAck
    76. object amqplib.defs.methodInfoBasicCancel
    77. object amqplib.defs.methodInfoBasicCancelOk
    78. object amqplib.defs.methodInfoBasicConsume
    79. object amqplib.defs.methodInfoBasicConsumeOk
    80. object amqplib.defs.methodInfoBasicDeliver
    81. object amqplib.defs.methodInfoBasicGet
    82. object amqplib.defs.methodInfoBasicGetEmpty
    83. object amqplib.defs.methodInfoBasicGetOk
    84. object amqplib.defs.methodInfoBasicNack
    85. object amqplib.defs.methodInfoBasicPublish
    86. object amqplib.defs.methodInfoBasicQos
    87. object amqplib.defs.methodInfoBasicQosOk
    88. object amqplib.defs.methodInfoBasicRecover
    89. object amqplib.defs.methodInfoBasicRecoverAsync
    90. object amqplib.defs.methodInfoBasicRecoverOk
    91. object amqplib.defs.methodInfoBasicReject
    92. object amqplib.defs.methodInfoBasicReturn
    93. object amqplib.defs.methodInfoChannelClose
    94. object amqplib.defs.methodInfoChannelCloseOk
    95. object amqplib.defs.methodInfoChannelFlow
    96. object amqplib.defs.methodInfoChannelFlowOk
    97. object amqplib.defs.methodInfoChannelOpen
    98. object amqplib.defs.methodInfoChannelOpenOk
    99. object amqplib.defs.methodInfoConfirmSelect
    100. object amqplib.defs.methodInfoConfirmSelectOk
    101. object amqplib.defs.methodInfoConnectionBlocked
    102. object amqplib.defs.methodInfoConnectionClose
    103. object amqplib.defs.methodInfoConnectionCloseOk
    104. object amqplib.defs.methodInfoConnectionOpen
    105. object amqplib.defs.methodInfoConnectionOpenOk
    106. object amqplib.defs.methodInfoConnectionSecure
    107. object amqplib.defs.methodInfoConnectionSecureOk
    108. object amqplib.defs.methodInfoConnectionStart
    109. object amqplib.defs.methodInfoConnectionStartOk
    110. object amqplib.defs.methodInfoConnectionTune
    111. object amqplib.defs.methodInfoConnectionTuneOk
    112. object amqplib.defs.methodInfoConnectionUnblocked
    113. object amqplib.defs.methodInfoExchangeBind
    114. object amqplib.defs.methodInfoExchangeBindOk
    115. object amqplib.defs.methodInfoExchangeDeclare
    116. object amqplib.defs.methodInfoExchangeDeclareOk
    117. object amqplib.defs.methodInfoExchangeDelete
    118. object amqplib.defs.methodInfoExchangeDeleteOk
    119. object amqplib.defs.methodInfoExchangeUnbind
    120. object amqplib.defs.methodInfoExchangeUnbindOk
    121. object amqplib.defs.methodInfoQueueBind
    122. object amqplib.defs.methodInfoQueueBindOk
    123. object amqplib.defs.methodInfoQueueDeclare
    124. object amqplib.defs.methodInfoQueueDeclareOk
    125. object amqplib.defs.methodInfoQueueDelete
    126. object amqplib.defs.methodInfoQueueDeleteOk
    127. object amqplib.defs.methodInfoQueuePurge
    128. object amqplib.defs.methodInfoQueuePurgeOk
    129. object amqplib.defs.methodInfoQueueUnbind
    130. object amqplib.defs.methodInfoQueueUnbindOk
    131. object amqplib.defs.methodInfoTxCommit
    132. object amqplib.defs.methodInfoTxCommitOk
    133. object amqplib.defs.methodInfoTxRollback
    134. object amqplib.defs.methodInfoTxRollbackOk
    135. object amqplib.defs.methodInfoTxSelect
    136. object amqplib.defs.methodInfoTxSelectOk
    137. object amqplib.defs.propertiesInfoBasicProperties
  13. module amqplib.error
    1. function amqplib.error.IllegalOperationError (msg, stack)
    2. function amqplib.error.stackCapture (reason)
  14. module amqplib.format
    1. function amqplib.format.closeMessage (close)
    2. function amqplib.format.inspect (frame, showFields)
    3. function amqplib.format.methodName (id)
  15. module amqplib.frame
    1. function amqplib.frame.decodeFrame (frame)
    2. function amqplib.frame.makeBodyFrame (channel, payload)
    3. function amqplib.frame.parseFrame (bin, max)
    4. object amqplib.frame.HEARTBEAT
    5. object amqplib.frame.HEARTBEAT_BUF
    6. string amqplib.frame.PROTOCOL_HEADER
  16. module amqplib.heartbeat
    1. function amqplib.heartbeat.Heart (interval, checkSend, checkRecv)
    2. number amqplib.heartbeat.UNITS_TO_MS
  17. module amqplib.mux
    1. function amqplib.mux.Mux (downstream)

module amqplib

function amqplib.connect (url, connOptions)

module amqplib.api_args

function amqplib.api_args.ack (tag, allUpTo)

function amqplib.api_args.assertExchange (exchange, type, options)

function amqplib.api_args.assertQueue (queue, options)

function amqplib.api_args.bindExchange (dest, source, pattern, argt)

function amqplib.api_args.bindQueue (queue, source, pattern, argt)

function amqplib.api_args.cancel (consumerTag)

function amqplib.api_args.checkExchange (exchange)

function amqplib.api_args.checkQueue (queue)

function amqplib.api_args.consume (queue, options)

function amqplib.api_args.deleteExchange (exchange, options)

function amqplib.api_args.deleteQueue (queue, options)

function amqplib.api_args.get (queue, options)

function amqplib.api_args.nack (tag, allUpTo, requeue)

function amqplib.api_args.prefetch (count, global)

function amqplib.api_args.publish (exchange, routingKey, options)

function amqplib.api_args.purgeQueue (queue)

function amqplib.api_args.recover ()

function amqplib.api_args.reject (tag, requeue)

function amqplib.api_args.unbindExchange (dest, source, pattern, argt)

function amqplib.api_args.unbindQueue (queue, source, pattern, argt)

module amqplib.bitset

function amqplib.bitset.BitSet (size)

module amqplib.callback_api

function amqplib.callback_api.connect (url, options, cb)

module amqplib.callback_model

function amqplib.callback_model.CallbackModel (connection)

function amqplib.callback_model.Channel (connection)

function amqplib.callback_model.ConfirmChannel (connection)

module amqplib.channel

function amqplib.channel.BaseChannel (connection)

function amqplib.channel.Channel (connection)

function amqplib.channel.acceptMessage (continuation)

module amqplib.channel_model

function amqplib.channel_model.Channel (connection)

function amqplib.channel_model.ChannelModel (connection)

function amqplib.channel_model.ConfirmChannel (connection)

module amqplib.codec

function amqplib.codec.decodeFields (slice)

function amqplib.codec.encodeTable (buffer, val, offset)

module amqplib.connect

function amqplib.connect (url, socketOptions, openCallback)

module amqplib.connection

function amqplib.connection.Connection (underlying)

function amqplib.connection.isFatalError (error)

module amqplib.credentials

function amqplib.credentials.external ()

function amqplib.credentials.plain (user, passwd)

module amqplib.defs

function amqplib.defs.decode (id, buf)

function amqplib.defs.encodeMethod (id, channel, fields)

function amqplib.defs.encodeProperties (id, channel, size, fields)

function amqplib.defs.info (id)

module amqplib.error

function amqplib.error.IllegalOperationError (msg, stack)

function amqplib.error.stackCapture (reason)

module amqplib.format

function amqplib.format.closeMessage (close)

function amqplib.format.inspect (frame, showFields)

function amqplib.format.methodName (id)

module amqplib.frame

function amqplib.frame.decodeFrame (frame)

function amqplib.frame.makeBodyFrame (channel, payload)

function amqplib.frame.parseFrame (bin, max)

module amqplib.heartbeat

function amqplib.heartbeat.Heart (interval, checkSend, checkRecv)

module amqplib.mux

function amqplib.mux.Mux (downstream)

[ this document was created with utility2 ]