TsgcWSPClient_AMQPMethods › CancelConsume

CancelConsume Method

Cancels a registered consumer (basic.cancel).

Syntax

procedure CancelConsume(const aChannel, aConsumerTag: string; aNoWait: Boolean = false);

Parameters

NameTypeDescription
aChannelconst stringName of the open AMQP channel on which the operation is issued.
aConsumerTagconst stringConsumer identifier returned by Consume / ConsumeEx.
aNoWaitBooleanWhen True the client does not wait for the broker to confirm the operation.

Remarks

Stops the broker from sending further deliveries to the given consumer tag. Messages already in flight may still be delivered until the cancel is processed.

Example

sgcWSPClient_AMQP1.CancelConsume('ch1', 'tag-1');

Back to Methods