TsgcWSPClient_AMQP › Methods

TsgcWSPClient_AMQP Methods

Public methods grouped by purpose, followed by the full alphabetical list.

Connection

Name	Description
Close	Closes the AMQP connection. Overloaded: clean close with no arguments, or explicit close passing reply-code/text/class/method.
CloseEx	Closes the AMQP connection synchronously and returns True when the broker acknowledged the close.

Channels

Name	Description
OpenChannel	Opens a new AMQP channel with the specified name (channel.open).
OpenChannelEx	Opens a new AMQP channel synchronously, waiting for channel.open-ok.
CloseChannel	Closes an AMQP channel (channel.close).
CloseChannelEx	Closes an AMQP channel synchronously and returns True when the broker acknowledged the close.
EnableChannel	Resumes message flow on a previously-paused channel (channel.flow active=true).
EnableChannelEx	Resumes message flow on a channel synchronously and returns True on broker confirmation.
DisableChannel	Pauses message flow on a channel (channel.flow active=false).
DisableChannelEx	Pauses message flow on a channel synchronously and returns True on broker confirmation.

Exchanges

Name	Description
DeclareExchange	Declares an exchange on the broker (exchange.declare).
DeclareExchangeEx	Declares an exchange synchronously, waiting for exchange.declare-ok.
DeleteExchange	Deletes an exchange (exchange.delete).
DeleteExchangeEx	Deletes an exchange synchronously and returns True on exchange.delete-ok.

Queues

Name	Description
DeclareQueue	Declares a queue on the broker (queue.declare).
DeclareQueueEx	Declares a queue synchronously, waiting for queue.declare-ok.
BindQueue	Binds a queue to an exchange using a routing key (queue.bind).
BindQueueEx	Binds a queue to an exchange and waits for the broker confirmation, returning success as a Boolean.
UnBindQueue	Removes a binding between a queue and an exchange (queue.unbind).
UnBindQueueEx	Removes a binding synchronously and returns True on queue.unbind-ok.
PurgeQueue	Removes all pending messages from a queue (queue.purge).
PurgeQueueEx	Purges a queue synchronously and returns True on queue.purge-ok.
DeleteQueue	Deletes a queue (queue.delete).
DeleteQueueEx	Deletes a queue synchronously and returns True on queue.delete-ok.

Consumers

Name	Description
Consume	Registers a consumer on a queue (basic.consume).
ConsumeEx	Registers a consumer synchronously and returns True on basic.consume-ok.
CancelConsume	Cancels a registered consumer (basic.cancel).
CancelConsumeEx	Cancels a consumer synchronously and returns True on basic.cancel-ok.

Publishing

Name	Description
PublishMessage	Publishes a message to an exchange (basic.publish). Overloaded for string or stream bodies.
AckMessage	Acknowledges receipt of one or more delivered messages (basic.ack).
RejectMessage	Rejects a delivered message (basic.reject), optionally returning it to the queue.

Recovery

Name	Description
Recover	Asks the broker to redeliver all un-ACKed messages on the channel (basic.recover with synchronous reply).
RecoverEx	Synchronous redeliver-all request that returns True when the broker confirms the recover.
RecoverAsync	Asynchronous redeliver-all request (basic.recover-async), no broker confirmation.

Transactions

Name	Description
SelectTransaction	Starts a transaction on the channel (tx.select).
SelectTransactionEx	Starts a transaction synchronously and returns True on tx.select-ok.
CommitTransaction	Commits the current transaction on a channel (tx.commit).
CommitTransactionEx	Commits the transaction synchronously and returns True on tx.commit-ok.
RollbackTransaction	Rolls back the current transaction on a channel (tx.rollback).
RollbackTransactionEx	Rolls back the transaction synchronously and returns True on tx.rollback-ok.

Advanced

Name	Description
WriteData	Low-level method that writes raw data straight onto the underlying WebSocket transport. Overloaded for string or stream input.

All Methods (alphabetical)

Name	Description
AckMessage	Acknowledges receipt of one or more delivered messages (basic.ack).
BindQueue	Binds a queue to an exchange using a routing key (queue.bind).
BindQueueEx	Binds a queue to an exchange and waits for the broker confirmation, returning success as a Boolean.
CancelConsume	Cancels a registered consumer (basic.cancel).
CancelConsumeEx	Cancels a consumer synchronously and returns True on basic.cancel-ok.
Close	Closes the AMQP connection. Overloaded: clean close with no arguments, or explicit close passing reply-code/text/class/method.
CloseChannel	Closes an AMQP channel (channel.close).
CloseChannelEx	Closes an AMQP channel synchronously and returns True when the broker acknowledged the close.
CloseEx	Closes the AMQP connection synchronously and returns True when the broker acknowledged the close.
CommitTransaction	Commits the current transaction on a channel (tx.commit).
CommitTransactionEx	Commits the transaction synchronously and returns True on tx.commit-ok.
Consume	Registers a consumer on a queue (basic.consume).
ConsumeEx	Registers a consumer synchronously and returns True on basic.consume-ok.
DeclareExchange	Declares an exchange on the broker (exchange.declare).
DeclareExchangeEx	Declares an exchange synchronously, waiting for exchange.declare-ok.
DeclareQueue	Declares a queue on the broker (queue.declare).
DeclareQueueEx	Declares a queue synchronously, waiting for queue.declare-ok.
DeleteExchange	Deletes an exchange (exchange.delete).
DeleteExchangeEx	Deletes an exchange synchronously and returns True on exchange.delete-ok.
DeleteQueue	Deletes a queue (queue.delete).
DeleteQueueEx	Deletes a queue synchronously and returns True on queue.delete-ok.
DisableChannel	Pauses message flow on a channel (channel.flow active=false).
DisableChannelEx	Pauses message flow on a channel synchronously and returns True on broker confirmation.
EnableChannel	Resumes message flow on a previously-paused channel (channel.flow active=true).
EnableChannelEx	Resumes message flow on a channel synchronously and returns True on broker confirmation.
OpenChannel	Opens a new AMQP channel with the specified name (channel.open).
OpenChannelEx	Opens a new AMQP channel synchronously, waiting for channel.open-ok.
PublishMessage	Publishes a message to an exchange (basic.publish). Overloaded for string or stream bodies.
PurgeQueue	Removes all pending messages from a queue (queue.purge).
PurgeQueueEx	Purges a queue synchronously and returns True on queue.purge-ok.
Recover	Asks the broker to redeliver all un-ACKed messages on the channel (basic.recover with synchronous reply).
RecoverAsync	Asynchronous redeliver-all request (basic.recover-async), no broker confirmation.
RecoverEx	Synchronous redeliver-all request that returns True when the broker confirms the recover.
RejectMessage	Rejects a delivered message (basic.reject), optionally returning it to the queue.
RollbackTransaction	Rolls back the current transaction on a channel (tx.rollback).
RollbackTransactionEx	Rolls back the transaction synchronously and returns True on tx.rollback-ok.
SelectTransaction	Starts a transaction on the channel (tx.select).
SelectTransactionEx	Starts a transaction synchronously and returns True on tx.select-ok.
UnBindQueue	Removes a binding between a queue and an exchange (queue.unbind).
UnBindQueueEx	Removes a binding synchronously and returns True on queue.unbind-ok.
WriteData	Low-level method that writes raw data straight onto the underlying WebSocket transport. Overloaded for string or stream input.