TsgcWSPClient_AMQPMethods › DeleteQueueEx

DeleteQueueEx Method

Deletes a queue synchronously and returns True on queue.delete-ok.

Syntax

function DeleteQueueEx(const aChannel, aQueue: string; aIfUnused: Boolean = false; aIfEmpty: Boolean = false; aNoWait: Boolean = false; aTimeout: Integer = CS_AMQP_DEFAULT_TIMEOUT): Boolean;

Parameters

NameTypeDescription
aChannelconst stringName of the open AMQP channel on which the operation is issued.
aQueueconst stringName of the queue.
aIfUnusedBooleanWhen True the operation proceeds only if the object has no bindings/consumers.
aIfEmptyBooleanWhen True the queue is deleted only if it contains no messages.
aNoWaitBooleanWhen True the client does not wait for the broker to confirm the operation.
aTimeoutIntegerMaximum time in milliseconds to wait for the broker confirmation before returning False.

Return Value

True when the broker acknowledged the delete within aTimeout. (Boolean)

Remarks

Extended synchronous variant of DeleteQueue. Returns only after the broker has acknowledged the delete or aTimeout has elapsed.

Example

sgcWSPClient_AMQP1.DeleteQueueEx('ch1', 'orders', True, True);

Back to Methods