amqp_framing.h File Reference

Go to the source code of this file.

Data Structures
struct	amqp_connection_start_t
	connection.start method fields More...
struct	amqp_connection_start_ok_t
	connection.start-ok method fields More...
struct	amqp_connection_secure_t
	connection.secure method fields More...
struct	amqp_connection_secure_ok_t
	connection.secure-ok method fields More...
struct	amqp_connection_tune_t
	connection.tune method fields More...
struct	amqp_connection_tune_ok_t
	connection.tune-ok method fields More...
struct	amqp_connection_open_t
	connection.open method fields More...
struct	amqp_connection_open_ok_t
	connection.open-ok method fields More...
struct	amqp_connection_close_t
	connection.close method fields More...
struct	amqp_connection_close_ok_t
	connection.close-ok method fields More...
struct	amqp_connection_blocked_t
	connection.blocked method fields More...
struct	amqp_connection_unblocked_t
	connection.unblocked method fields More...
struct	amqp_channel_open_t
	channel.open method fields More...
struct	amqp_channel_open_ok_t
	channel.open-ok method fields More...
struct	amqp_channel_flow_t
	channel.flow method fields More...
struct	amqp_channel_flow_ok_t
	channel.flow-ok method fields More...
struct	amqp_channel_close_t
	channel.close method fields More...
struct	amqp_channel_close_ok_t
	channel.close-ok method fields More...
struct	amqp_access_request_t
	access.request method fields More...
struct	amqp_access_request_ok_t
	access.request-ok method fields More...
struct	amqp_exchange_declare_t
	exchange.declare method fields More...
struct	amqp_exchange_declare_ok_t
	exchange.declare-ok method fields More...
struct	amqp_exchange_delete_t
	exchange.delete method fields More...
struct	amqp_exchange_delete_ok_t
	exchange.delete-ok method fields More...
struct	amqp_exchange_bind_t
	exchange.bind method fields More...
struct	amqp_exchange_bind_ok_t
	exchange.bind-ok method fields More...
struct	amqp_exchange_unbind_t
	exchange.unbind method fields More...
struct	amqp_exchange_unbind_ok_t
	exchange.unbind-ok method fields More...
struct	amqp_queue_declare_t
	queue.declare method fields More...
struct	amqp_queue_declare_ok_t
	queue.declare-ok method fields More...
struct	amqp_queue_bind_t
	queue.bind method fields More...
struct	amqp_queue_bind_ok_t
	queue.bind-ok method fields More...
struct	amqp_queue_purge_t
	queue.purge method fields More...
struct	amqp_queue_purge_ok_t
	queue.purge-ok method fields More...
struct	amqp_queue_delete_t
	queue.delete method fields More...
struct	amqp_queue_delete_ok_t
	queue.delete-ok method fields More...
struct	amqp_queue_unbind_t
	queue.unbind method fields More...
struct	amqp_queue_unbind_ok_t
	queue.unbind-ok method fields More...
struct	amqp_basic_qos_t
	basic.qos method fields More...
struct	amqp_basic_qos_ok_t
	basic.qos-ok method fields More...
struct	amqp_basic_consume_t
	basic.consume method fields More...
struct	amqp_basic_consume_ok_t
	basic.consume-ok method fields More...
struct	amqp_basic_cancel_t
	basic.cancel method fields More...
struct	amqp_basic_cancel_ok_t
	basic.cancel-ok method fields More...
struct	amqp_basic_publish_t
	basic.publish method fields More...
struct	amqp_basic_return_t
	basic.return method fields More...
struct	amqp_basic_deliver_t
	basic.deliver method fields More...
struct	amqp_basic_get_t
	basic.get method fields More...
struct	amqp_basic_get_ok_t
	basic.get-ok method fields More...
struct	amqp_basic_get_empty_t
	basic.get-empty method fields More...
struct	amqp_basic_ack_t
	basic.ack method fields More...
struct	amqp_basic_reject_t
	basic.reject method fields More...
struct	amqp_basic_recover_async_t
	basic.recover-async method fields More...
struct	amqp_basic_recover_t
	basic.recover method fields More...
struct	amqp_basic_recover_ok_t
	basic.recover-ok method fields More...
struct	amqp_basic_nack_t
	basic.nack method fields More...
struct	amqp_tx_select_t
	tx.select method fields More...
struct	amqp_tx_select_ok_t
	tx.select-ok method fields More...
struct	amqp_tx_commit_t
	tx.commit method fields More...
struct	amqp_tx_commit_ok_t
	tx.commit-ok method fields More...
struct	amqp_tx_rollback_t
	tx.rollback method fields More...
struct	amqp_tx_rollback_ok_t
	tx.rollback-ok method fields More...
struct	amqp_confirm_select_t
	confirm.select method fields More...
struct	amqp_confirm_select_ok_t
	confirm.select-ok method fields More...
struct	amqp_connection_properties_t
	connection class properties More...
struct	amqp_channel_properties_t
	channel class properties More...
struct	amqp_access_properties_t
	access class properties More...
struct	amqp_exchange_properties_t
	exchange class properties More...
struct	amqp_queue_properties_t
	queue class properties More...
struct	amqp_basic_properties_t
	basic class properties More...
struct	amqp_tx_properties_t
	tx class properties More...
struct	amqp_confirm_properties_t
	confirm class properties More...

Macros
#define	AMQP_PROTOCOL_VERSION_MAJOR   0
	AMQP protocol version major.
#define	AMQP_PROTOCOL_VERSION_MINOR   9
	AMQP protocol version minor.
#define	AMQP_PROTOCOL_VERSION_REVISION   1
	AMQP protocol version revision.
#define	AMQP_PROTOCOL_PORT   5672
	Default AMQP Port.
#define	AMQP_FRAME_METHOD   1
	Constant: FRAME-METHOD.
#define	AMQP_FRAME_HEADER   2
	Constant: FRAME-HEADER.
#define	AMQP_FRAME_BODY   3
	Constant: FRAME-BODY.
#define	AMQP_FRAME_HEARTBEAT   8
	Constant: FRAME-HEARTBEAT.
#define	AMQP_FRAME_MIN_SIZE   4096
	Constant: FRAME-MIN-SIZE.
#define	AMQP_FRAME_END   206
	Constant: FRAME-END.
#define	AMQP_REPLY_SUCCESS   200
	Constant: REPLY-SUCCESS.
#define	AMQP_CONTENT_TOO_LARGE   311
	Constant: CONTENT-TOO-LARGE.
#define	AMQP_NO_ROUTE   312
	Constant: NO-ROUTE.
#define	AMQP_NO_CONSUMERS   313
	Constant: NO-CONSUMERS.
#define	AMQP_ACCESS_REFUSED   403
	Constant: ACCESS-REFUSED.
#define	AMQP_NOT_FOUND   404
	Constant: NOT-FOUND.
#define	AMQP_RESOURCE_LOCKED   405
	Constant: RESOURCE-LOCKED.
#define	AMQP_PRECONDITION_FAILED   406
	Constant: PRECONDITION-FAILED.
#define	AMQP_CONNECTION_FORCED   320
	Constant: CONNECTION-FORCED.
#define	AMQP_INVALID_PATH   402
	Constant: INVALID-PATH.
#define	AMQP_FRAME_ERROR   501
	Constant: FRAME-ERROR.
#define	AMQP_SYNTAX_ERROR   502
	Constant: SYNTAX-ERROR.
#define	AMQP_COMMAND_INVALID   503
	Constant: COMMAND-INVALID.
#define	AMQP_CHANNEL_ERROR   504
	Constant: CHANNEL-ERROR.
#define	AMQP_UNEXPECTED_FRAME   505
	Constant: UNEXPECTED-FRAME.
#define	AMQP_RESOURCE_ERROR   506
	Constant: RESOURCE-ERROR.
#define	AMQP_NOT_ALLOWED   530
	Constant: NOT-ALLOWED.
#define	AMQP_NOT_IMPLEMENTED   540
	Constant: NOT-IMPLEMENTED.
#define	AMQP_INTERNAL_ERROR   541
	Constant: INTERNAL-ERROR.
#define	AMQP_CONNECTION_START_METHOD   ((amqp_method_number_t) 0x000A000A)
	connection.start method id
#define	AMQP_CONNECTION_START_OK_METHOD   ((amqp_method_number_t) 0x000A000B)
	connection.start-ok method id
#define	AMQP_CONNECTION_SECURE_METHOD   ((amqp_method_number_t) 0x000A0014)
	connection.secure method id
#define	AMQP_CONNECTION_SECURE_OK_METHOD   ((amqp_method_number_t) 0x000A0015)
	connection.secure-ok method id
#define	AMQP_CONNECTION_TUNE_METHOD   ((amqp_method_number_t) 0x000A001E)
	connection.tune method id
#define	AMQP_CONNECTION_TUNE_OK_METHOD   ((amqp_method_number_t) 0x000A001F)
	connection.tune-ok method id
#define	AMQP_CONNECTION_OPEN_METHOD   ((amqp_method_number_t) 0x000A0028)
	connection.open method id
#define	AMQP_CONNECTION_OPEN_OK_METHOD   ((amqp_method_number_t) 0x000A0029)
	connection.open-ok method id
#define	AMQP_CONNECTION_CLOSE_METHOD   ((amqp_method_number_t) 0x000A0032)
	connection.close method id
#define	AMQP_CONNECTION_CLOSE_OK_METHOD   ((amqp_method_number_t) 0x000A0033)
	connection.close-ok method id
#define	AMQP_CONNECTION_BLOCKED_METHOD   ((amqp_method_number_t) 0x000A003C)
	connection.blocked method id
#define	AMQP_CONNECTION_UNBLOCKED_METHOD   ((amqp_method_number_t) 0x000A003D)
	connection.unblocked method id
#define	AMQP_CHANNEL_OPEN_METHOD   ((amqp_method_number_t) 0x0014000A)
	channel.open method id
#define	AMQP_CHANNEL_OPEN_OK_METHOD   ((amqp_method_number_t) 0x0014000B)
	channel.open-ok method id
#define	AMQP_CHANNEL_FLOW_METHOD   ((amqp_method_number_t) 0x00140014)
	channel.flow method id
#define	AMQP_CHANNEL_FLOW_OK_METHOD   ((amqp_method_number_t) 0x00140015)
	channel.flow-ok method id
#define	AMQP_CHANNEL_CLOSE_METHOD   ((amqp_method_number_t) 0x00140028)
	channel.close method id
#define	AMQP_CHANNEL_CLOSE_OK_METHOD   ((amqp_method_number_t) 0x00140029)
	channel.close-ok method id
#define	AMQP_ACCESS_REQUEST_METHOD   ((amqp_method_number_t) 0x001E000A)
	access.request method id
#define	AMQP_ACCESS_REQUEST_OK_METHOD   ((amqp_method_number_t) 0x001E000B)
	access.request-ok method id
#define	AMQP_EXCHANGE_DECLARE_METHOD   ((amqp_method_number_t) 0x0028000A)
	exchange.declare method id
#define	AMQP_EXCHANGE_DECLARE_OK_METHOD   ((amqp_method_number_t) 0x0028000B)
	exchange.declare-ok method id
#define	AMQP_EXCHANGE_DELETE_METHOD   ((amqp_method_number_t) 0x00280014)
	exchange.delete method id
#define	AMQP_EXCHANGE_DELETE_OK_METHOD   ((amqp_method_number_t) 0x00280015)
	exchange.delete-ok method id
#define	AMQP_EXCHANGE_BIND_METHOD   ((amqp_method_number_t) 0x0028001E)
	exchange.bind method id
#define	AMQP_EXCHANGE_BIND_OK_METHOD   ((amqp_method_number_t) 0x0028001F)
	exchange.bind-ok method id
#define	AMQP_EXCHANGE_UNBIND_METHOD   ((amqp_method_number_t) 0x00280028)
	exchange.unbind method id
#define	AMQP_EXCHANGE_UNBIND_OK_METHOD   ((amqp_method_number_t) 0x00280033)
	exchange.unbind-ok method id
#define	AMQP_QUEUE_DECLARE_METHOD   ((amqp_method_number_t) 0x0032000A)
	queue.declare method id
#define	AMQP_QUEUE_DECLARE_OK_METHOD   ((amqp_method_number_t) 0x0032000B)
	queue.declare-ok method id
#define	AMQP_QUEUE_BIND_METHOD   ((amqp_method_number_t) 0x00320014)
	queue.bind method id
#define	AMQP_QUEUE_BIND_OK_METHOD   ((amqp_method_number_t) 0x00320015)
	queue.bind-ok method id
#define	AMQP_QUEUE_PURGE_METHOD   ((amqp_method_number_t) 0x0032001E)
	queue.purge method id
#define	AMQP_QUEUE_PURGE_OK_METHOD   ((amqp_method_number_t) 0x0032001F)
	queue.purge-ok method id
#define	AMQP_QUEUE_DELETE_METHOD   ((amqp_method_number_t) 0x00320028)
	queue.delete method id
#define	AMQP_QUEUE_DELETE_OK_METHOD   ((amqp_method_number_t) 0x00320029)
	queue.delete-ok method id
#define	AMQP_QUEUE_UNBIND_METHOD   ((amqp_method_number_t) 0x00320032)
	queue.unbind method id
#define	AMQP_QUEUE_UNBIND_OK_METHOD   ((amqp_method_number_t) 0x00320033)
	queue.unbind-ok method id
#define	AMQP_BASIC_QOS_METHOD   ((amqp_method_number_t) 0x003C000A)
	basic.qos method id
#define	AMQP_BASIC_QOS_OK_METHOD   ((amqp_method_number_t) 0x003C000B)
	basic.qos-ok method id
#define	AMQP_BASIC_CONSUME_METHOD   ((amqp_method_number_t) 0x003C0014)
	basic.consume method id
#define	AMQP_BASIC_CONSUME_OK_METHOD   ((amqp_method_number_t) 0x003C0015)
	basic.consume-ok method id
#define	AMQP_BASIC_CANCEL_METHOD   ((amqp_method_number_t) 0x003C001E)
	basic.cancel method id
#define	AMQP_BASIC_CANCEL_OK_METHOD   ((amqp_method_number_t) 0x003C001F)
	basic.cancel-ok method id
#define	AMQP_BASIC_PUBLISH_METHOD   ((amqp_method_number_t) 0x003C0028)
	basic.publish method id
#define	AMQP_BASIC_RETURN_METHOD   ((amqp_method_number_t) 0x003C0032)
	basic.return method id
#define	AMQP_BASIC_DELIVER_METHOD   ((amqp_method_number_t) 0x003C003C)
	basic.deliver method id
#define	AMQP_BASIC_GET_METHOD   ((amqp_method_number_t) 0x003C0046)
	basic.get method id
#define	AMQP_BASIC_GET_OK_METHOD   ((amqp_method_number_t) 0x003C0047)
	basic.get-ok method id
#define	AMQP_BASIC_GET_EMPTY_METHOD   ((amqp_method_number_t) 0x003C0048)
	basic.get-empty method id
#define	AMQP_BASIC_ACK_METHOD   ((amqp_method_number_t) 0x003C0050)
	basic.ack method id
#define	AMQP_BASIC_REJECT_METHOD   ((amqp_method_number_t) 0x003C005A)
	basic.reject method id
#define	AMQP_BASIC_RECOVER_ASYNC_METHOD   ((amqp_method_number_t) 0x003C0064)
	basic.recover-async method id
#define	AMQP_BASIC_RECOVER_METHOD   ((amqp_method_number_t) 0x003C006E)
	basic.recover method id
#define	AMQP_BASIC_RECOVER_OK_METHOD   ((amqp_method_number_t) 0x003C006F)
	basic.recover-ok method id
#define	AMQP_BASIC_NACK_METHOD   ((amqp_method_number_t) 0x003C0078)
	basic.nack method id
#define	AMQP_TX_SELECT_METHOD   ((amqp_method_number_t) 0x005A000A)
	tx.select method id
#define	AMQP_TX_SELECT_OK_METHOD   ((amqp_method_number_t) 0x005A000B)
	tx.select-ok method id
#define	AMQP_TX_COMMIT_METHOD   ((amqp_method_number_t) 0x005A0014)
	tx.commit method id
#define	AMQP_TX_COMMIT_OK_METHOD   ((amqp_method_number_t) 0x005A0015)
	tx.commit-ok method id
#define	AMQP_TX_ROLLBACK_METHOD   ((amqp_method_number_t) 0x005A001E)
	tx.rollback method id
#define	AMQP_TX_ROLLBACK_OK_METHOD   ((amqp_method_number_t) 0x005A001F)
	tx.rollback-ok method id
#define	AMQP_CONFIRM_SELECT_METHOD   ((amqp_method_number_t) 0x0055000A)
	confirm.select method id
#define	AMQP_CONFIRM_SELECT_OK_METHOD   ((amqp_method_number_t) 0x0055000B)
	confirm.select-ok method id
#define	AMQP_CONNECTION_CLASS   (0x000A)
	connection class id
#define	AMQP_CHANNEL_CLASS   (0x0014)
	channel class id
#define	AMQP_ACCESS_CLASS   (0x001E)
	access class id
#define	AMQP_EXCHANGE_CLASS   (0x0028)
	exchange class id
#define	AMQP_QUEUE_CLASS   (0x0032)
	queue class id
#define	AMQP_BASIC_CLASS   (0x003C)
	basic class id
#define	AMQP_BASIC_CONTENT_TYPE_FLAG   (1 << 15)
	basic.content-type property flag
#define	AMQP_BASIC_CONTENT_ENCODING_FLAG   (1 << 14)
	basic.content-encoding property flag
#define	AMQP_BASIC_HEADERS_FLAG   (1 << 13)
	basic.headers property flag
#define	AMQP_BASIC_DELIVERY_MODE_FLAG   (1 << 12)
	basic.delivery-mode property flag
#define	AMQP_BASIC_PRIORITY_FLAG   (1 << 11)
	basic.priority property flag
#define	AMQP_BASIC_CORRELATION_ID_FLAG   (1 << 10)
	basic.correlation-id property flag
#define	AMQP_BASIC_REPLY_TO_FLAG   (1 << 9)
	basic.reply-to property flag
#define	AMQP_BASIC_EXPIRATION_FLAG   (1 << 8)
	basic.expiration property flag
#define	AMQP_BASIC_MESSAGE_ID_FLAG   (1 << 7)
	basic.message-id property flag
#define	AMQP_BASIC_TIMESTAMP_FLAG   (1 << 6)
	basic.timestamp property flag
#define	AMQP_BASIC_TYPE_FLAG   (1 << 5)
	basic.type property flag
#define	AMQP_BASIC_USER_ID_FLAG   (1 << 4)
	basic.user-id property flag
#define	AMQP_BASIC_APP_ID_FLAG   (1 << 3)
	basic.app-id property flag
#define	AMQP_BASIC_CLUSTER_ID_FLAG   (1 << 2)
	basic.cluster-id property flag
#define	AMQP_TX_CLASS   (0x005A)
	tx class id
#define	AMQP_CONFIRM_CLASS   (0x0055)
	confirm class id

Functions
char const *	amqp_constant_name (int constantNumber)
	Get constant name string from constant. More...
amqp_boolean_t	amqp_constant_is_hard_error (int constantNumber)
	Checks to see if a constant is a hard error. More...
char const *	amqp_method_name (amqp_method_number_t methodNumber)
	Get method name string from method number. More...
amqp_boolean_t	amqp_method_has_content (amqp_method_number_t methodNumber)
	Check whether a method has content. More...
int	amqp_decode_method (amqp_method_number_t methodNumber, amqp_pool_t *pool, amqp_bytes_t encoded, void **decoded)
	Decodes a method from AMQP wireformat. More...
int	amqp_decode_properties (uint16_t class_id, amqp_pool_t *pool, amqp_bytes_t encoded, void **decoded)
	Decodes a header frame properties structure from AMQP wireformat. More...
int	amqp_encode_method (amqp_method_number_t methodNumber, void *decoded, amqp_bytes_t encoded)
	Encodes a method structure in AMQP wireformat. More...
int	amqp_encode_properties (uint16_t class_id, void *decoded, amqp_bytes_t encoded)
	Encodes a properties structure in AMQP wireformat. More...
amqp_channel_open_ok_t *	amqp_channel_open (amqp_connection_state_t state, amqp_channel_t channel)
	amqp_channel_open More...
amqp_channel_flow_ok_t *	amqp_channel_flow (amqp_connection_state_t state, amqp_channel_t channel, amqp_boolean_t active)
	amqp_channel_flow More...
amqp_exchange_declare_ok_t *	amqp_exchange_declare (amqp_connection_state_t state, amqp_channel_t channel, amqp_bytes_t exchange, amqp_bytes_t type, amqp_boolean_t passive, amqp_boolean_t durable, amqp_boolean_t auto_delete, amqp_boolean_t internal, amqp_table_t arguments)
	amqp_exchange_declare More...
amqp_exchange_delete_ok_t *	amqp_exchange_delete (amqp_connection_state_t state, amqp_channel_t channel, amqp_bytes_t exchange, amqp_boolean_t if_unused)
	amqp_exchange_delete More...
amqp_exchange_bind_ok_t *	amqp_exchange_bind (amqp_connection_state_t state, amqp_channel_t channel, amqp_bytes_t destination, amqp_bytes_t source, amqp_bytes_t routing_key, amqp_table_t arguments)
	amqp_exchange_bind More...
amqp_exchange_unbind_ok_t *	amqp_exchange_unbind (amqp_connection_state_t state, amqp_channel_t channel, amqp_bytes_t destination, amqp_bytes_t source, amqp_bytes_t routing_key, amqp_table_t arguments)
	amqp_exchange_unbind More...
amqp_queue_declare_ok_t *	amqp_queue_declare (amqp_connection_state_t state, amqp_channel_t channel, amqp_bytes_t queue, amqp_boolean_t passive, amqp_boolean_t durable, amqp_boolean_t exclusive, amqp_boolean_t auto_delete, amqp_table_t arguments)
	amqp_queue_declare More...
amqp_queue_bind_ok_t *	amqp_queue_bind (amqp_connection_state_t state, amqp_channel_t channel, amqp_bytes_t queue, amqp_bytes_t exchange, amqp_bytes_t routing_key, amqp_table_t arguments)
	amqp_queue_bind More...
amqp_queue_purge_ok_t *	amqp_queue_purge (amqp_connection_state_t state, amqp_channel_t channel, amqp_bytes_t queue)
	amqp_queue_purge More...
amqp_queue_delete_ok_t *	amqp_queue_delete (amqp_connection_state_t state, amqp_channel_t channel, amqp_bytes_t queue, amqp_boolean_t if_unused, amqp_boolean_t if_empty)
	amqp_queue_delete More...
amqp_queue_unbind_ok_t *	amqp_queue_unbind (amqp_connection_state_t state, amqp_channel_t channel, amqp_bytes_t queue, amqp_bytes_t exchange, amqp_bytes_t routing_key, amqp_table_t arguments)
	amqp_queue_unbind More...
amqp_basic_qos_ok_t *	amqp_basic_qos (amqp_connection_state_t state, amqp_channel_t channel, uint32_t prefetch_size, uint16_t prefetch_count, amqp_boolean_t global)
	amqp_basic_qos More...
amqp_basic_consume_ok_t *	amqp_basic_consume (amqp_connection_state_t state, amqp_channel_t channel, amqp_bytes_t queue, amqp_bytes_t consumer_tag, amqp_boolean_t no_local, amqp_boolean_t no_ack, amqp_boolean_t exclusive, amqp_table_t arguments)
	amqp_basic_consume More...
amqp_basic_cancel_ok_t *	amqp_basic_cancel (amqp_connection_state_t state, amqp_channel_t channel, amqp_bytes_t consumer_tag)
	amqp_basic_cancel More...
amqp_basic_recover_ok_t *	amqp_basic_recover (amqp_connection_state_t state, amqp_channel_t channel, amqp_boolean_t requeue)
	amqp_basic_recover More...
amqp_tx_select_ok_t *	amqp_tx_select (amqp_connection_state_t state, amqp_channel_t channel)
	amqp_tx_select More...
amqp_tx_commit_ok_t *	amqp_tx_commit (amqp_connection_state_t state, amqp_channel_t channel)
	amqp_tx_commit More...
amqp_tx_rollback_ok_t *	amqp_tx_rollback (amqp_connection_state_t state, amqp_channel_t channel)
	amqp_tx_rollback More...
amqp_confirm_select_ok_t *	amqp_confirm_select (amqp_connection_state_t state, amqp_channel_t channel)
	amqp_confirm_select More...

Function Documentation

amqp_basic_cancel_ok_t* amqp_basic_cancel	(	amqp_connection_state_t	state,
		amqp_channel_t	channel,
		amqp_bytes_t	consumer_tag
	)

amqp_basic_cancel

Parameters

[in]	state	connection state
[in]	channel	the channel to do the RPC on
[in]	consumer_tag	consumer_tag

Returns

amqp_basic_cancel_ok_t

amqp_basic_consume_ok_t* amqp_basic_consume	(	amqp_connection_state_t	state,
		amqp_channel_t	channel,
		amqp_bytes_t	queue,
		amqp_bytes_t	consumer_tag,
		amqp_boolean_t	no_local,
		amqp_boolean_t	no_ack,
		amqp_boolean_t	exclusive,
		amqp_table_t	arguments
	)

amqp_basic_consume

Parameters

[in]	state	connection state
[in]	channel	the channel to do the RPC on
[in]	queue	queue
[in]	consumer_tag	consumer_tag
[in]	no_local	no_local
[in]	no_ack	no_ack
[in]	exclusive	exclusive
[in]	arguments	arguments

Returns

amqp_basic_consume_ok_t

amqp_basic_qos_ok_t* amqp_basic_qos	(	amqp_connection_state_t	state,
		amqp_channel_t	channel,
		uint32_t	prefetch_size,
		uint16_t	prefetch_count,
		amqp_boolean_t	global
	)

amqp_basic_qos

Parameters

[in]	state	connection state
[in]	channel	the channel to do the RPC on
[in]	prefetch_size	prefetch_size
[in]	prefetch_count	prefetch_count
[in]	global	global

Returns

amqp_basic_qos_ok_t

amqp_basic_recover_ok_t* amqp_basic_recover	(	amqp_connection_state_t	state,
		amqp_channel_t	channel,
		amqp_boolean_t	requeue
	)

amqp_basic_recover

Parameters

[in]	state	connection state
[in]	channel	the channel to do the RPC on
[in]	requeue	requeue

Returns

amqp_basic_recover_ok_t

amqp_channel_flow_ok_t* amqp_channel_flow	(	amqp_connection_state_t	state,
		amqp_channel_t	channel,
		amqp_boolean_t	active
	)

amqp_channel_flow

Parameters

[in]	state	connection state
[in]	channel	the channel to do the RPC on
[in]	active	active

Returns

amqp_channel_flow_ok_t

amqp_channel_open_ok_t* amqp_channel_open	(	amqp_connection_state_t	state,
		amqp_channel_t	channel
	)

amqp_channel_open

Parameters

[in]	state	connection state
[in]	channel	the channel to do the RPC on

Returns

amqp_channel_open_ok_t

amqp_confirm_select_ok_t* amqp_confirm_select	(	amqp_connection_state_t	state,
		amqp_channel_t	channel
	)

amqp_confirm_select

Parameters

[in]	state	connection state
[in]	channel	the channel to do the RPC on

Returns

amqp_confirm_select_ok_t

amqp_boolean_t amqp_constant_is_hard_error

(

int

constantNumber

)

Checks to see if a constant is a hard error.

A hard error occurs when something severe enough happens that the connection must be closed.

Parameters

[in]

constantNumber

the error constant

Returns

true if its a hard error, false otherwise

char const* amqp_constant_name

(

int

constantNumber

)

Get constant name string from constant.

Parameters

[in]

constantNumber

constant to get the name of

Returns

string describing the constant. String is managed by the library and should not be free()'d by the program

int amqp_decode_method	(	amqp_method_number_t	methodNumber,
		amqp_pool_t *	pool,
		amqp_bytes_t	encoded,
		void **	decoded
	)

Decodes a method from AMQP wireformat.

Parameters

[in]	methodNumber	the method number for the decoded parameter
[in]	pool	the memory pool to allocate the decoded method from
[in]	encoded	the encoded byte string buffer
[out]	decoded	pointer to the decoded method struct

Returns

0 on success, an error code otherwise

int amqp_decode_properties	(	uint16_t	class_id,
		amqp_pool_t *	pool,
		amqp_bytes_t	encoded,
		void **	decoded
	)

Decodes a header frame properties structure from AMQP wireformat.

Parameters

[in]	class_id	the class id for the decoded parameter
[in]	pool	the memory pool to allocate the decoded properties from
[in]	encoded	the encoded byte string buffer
[out]	decoded	pointer to the decoded properties struct

Returns

0 on success, an error code otherwise

int amqp_encode_method	(	amqp_method_number_t	methodNumber,
		void *	decoded,
		amqp_bytes_t	encoded
	)

Encodes a method structure in AMQP wireformat.

Parameters

[in]	methodNumber	the method number for the decoded parameter
[in]	decoded	the method structure (e.g., amqp_connection_start_t)
[in]	encoded	an allocated byte buffer for the encoded method structure to be written to. If the buffer isn't large enough to hold the encoded method, an error code will be returned.

Returns

0 on success, an error code otherwise.

int amqp_encode_properties	(	uint16_t	class_id,
		void *	decoded,
		amqp_bytes_t	encoded
	)

Encodes a properties structure in AMQP wireformat.

Parameters

[in]	class_id	the class id for the decoded parameter
[in]	decoded	the properties structure (e.g., amqp_basic_properties_t)
[in]	encoded	an allocated byte buffer for the encoded properties to written to. If the buffer isn't large enough to hold the encoded method, an an error code will be returned

Returns

0 on success, an error code otherwise.

amqp_exchange_bind_ok_t* amqp_exchange_bind	(	amqp_connection_state_t	state,
		amqp_channel_t	channel,
		amqp_bytes_t	destination,
		amqp_bytes_t	source,
		amqp_bytes_t	routing_key,
		amqp_table_t	arguments
	)

amqp_exchange_bind

Parameters

[in]	state	connection state
[in]	channel	the channel to do the RPC on
[in]	destination	destination
[in]	source	source
[in]	routing_key	routing_key
[in]	arguments	arguments

Returns

amqp_exchange_bind_ok_t

amqp_exchange_declare_ok_t* amqp_exchange_declare	(	amqp_connection_state_t	state,
		amqp_channel_t	channel,
		amqp_bytes_t	exchange,
		amqp_bytes_t	type,
		amqp_boolean_t	passive,
		amqp_boolean_t	durable,
		amqp_boolean_t	auto_delete,
		amqp_boolean_t	internal,
		amqp_table_t	arguments
	)

amqp_exchange_declare

Parameters

[in]	state	connection state
[in]	channel	the channel to do the RPC on
[in]	exchange	exchange
[in]	type	type
[in]	passive	passive
[in]	durable	durable
[in]	auto_delete	auto_delete
[in]	internal	internal
[in]	arguments	arguments

Returns

amqp_exchange_declare_ok_t

amqp_exchange_delete_ok_t* amqp_exchange_delete	(	amqp_connection_state_t	state,
		amqp_channel_t	channel,
		amqp_bytes_t	exchange,
		amqp_boolean_t	if_unused
	)

amqp_exchange_delete

Parameters

[in]	state	connection state
[in]	channel	the channel to do the RPC on
[in]	exchange	exchange
[in]	if_unused	if_unused

Returns

amqp_exchange_delete_ok_t

amqp_exchange_unbind_ok_t* amqp_exchange_unbind	(	amqp_connection_state_t	state,
		amqp_channel_t	channel,
		amqp_bytes_t	destination,
		amqp_bytes_t	source,
		amqp_bytes_t	routing_key,
		amqp_table_t	arguments
	)

amqp_exchange_unbind

Parameters

[in]	state	connection state
[in]	channel	the channel to do the RPC on
[in]	destination	destination
[in]	source	source
[in]	routing_key	routing_key
[in]	arguments	arguments

Returns

amqp_exchange_unbind_ok_t

amqp_boolean_t amqp_method_has_content

(

amqp_method_number_t

methodNumber

)

Check whether a method has content.

A method that has content will receive the method frame a properties frame, then 1 to N body frames

Parameters

[in]

methodNumber

the method number

Returns

true if method has content, false otherwise

char const* amqp_method_name

(

amqp_method_number_t

methodNumber

)

Get method name string from method number.

Parameters

[in]

methodNumber

the method number

Returns

method name string. String is managed by the library and should not be freed()'d by the program

amqp_queue_bind_ok_t* amqp_queue_bind	(	amqp_connection_state_t	state,
		amqp_channel_t	channel,
		amqp_bytes_t	queue,
		amqp_bytes_t	exchange,
		amqp_bytes_t	routing_key,
		amqp_table_t	arguments
	)

amqp_queue_bind

Parameters

[in]	state	connection state
[in]	channel	the channel to do the RPC on
[in]	queue	queue
[in]	exchange	exchange
[in]	routing_key	routing_key
[in]	arguments	arguments

Returns

amqp_queue_bind_ok_t

amqp_queue_declare_ok_t* amqp_queue_declare	(	amqp_connection_state_t	state,
		amqp_channel_t	channel,
		amqp_bytes_t	queue,
		amqp_boolean_t	passive,
		amqp_boolean_t	durable,
		amqp_boolean_t	exclusive,
		amqp_boolean_t	auto_delete,
		amqp_table_t	arguments
	)

amqp_queue_declare

Parameters

[in]	state	connection state
[in]	channel	the channel to do the RPC on
[in]	queue	queue
[in]	passive	passive
[in]	durable	durable
[in]	exclusive	exclusive
[in]	auto_delete	auto_delete
[in]	arguments	arguments

Returns

amqp_queue_declare_ok_t

amqp_queue_delete_ok_t* amqp_queue_delete	(	amqp_connection_state_t	state,
		amqp_channel_t	channel,
		amqp_bytes_t	queue,
		amqp_boolean_t	if_unused,
		amqp_boolean_t	if_empty
	)

amqp_queue_delete

Parameters

[in]	state	connection state
[in]	channel	the channel to do the RPC on
[in]	queue	queue
[in]	if_unused	if_unused
[in]	if_empty	if_empty

Returns

amqp_queue_delete_ok_t

amqp_queue_purge_ok_t* amqp_queue_purge	(	amqp_connection_state_t	state,
		amqp_channel_t	channel,
		amqp_bytes_t	queue
	)

amqp_queue_purge

Parameters

[in]	state	connection state
[in]	channel	the channel to do the RPC on
[in]	queue	queue

Returns

amqp_queue_purge_ok_t

amqp_queue_unbind_ok_t* amqp_queue_unbind	(	amqp_connection_state_t	state,
		amqp_channel_t	channel,
		amqp_bytes_t	queue,
		amqp_bytes_t	exchange,
		amqp_bytes_t	routing_key,
		amqp_table_t	arguments
	)

amqp_queue_unbind

Parameters

[in]	state	connection state
[in]	channel	the channel to do the RPC on
[in]	queue	queue
[in]	exchange	exchange
[in]	routing_key	routing_key
[in]	arguments	arguments

Returns

amqp_queue_unbind_ok_t

amqp_tx_commit_ok_t* amqp_tx_commit	(	amqp_connection_state_t	state,
		amqp_channel_t	channel
	)

amqp_tx_commit

Parameters

[in]	state	connection state
[in]	channel	the channel to do the RPC on

Returns

amqp_tx_commit_ok_t

amqp_tx_rollback_ok_t* amqp_tx_rollback	(	amqp_connection_state_t	state,
		amqp_channel_t	channel
	)

amqp_tx_rollback

Parameters

[in]	state	connection state
[in]	channel	the channel to do the RPC on

Returns

amqp_tx_rollback_ok_t

amqp_tx_select_ok_t* amqp_tx_select	(	amqp_connection_state_t	state,
		amqp_channel_t	channel
	)

amqp_tx_select

Parameters

[in]	state	connection state
[in]	channel	the channel to do the RPC on

Returns

amqp_tx_select_ok_t