IPWorks MQ 2020 Kotlin Edition

Questions / Feedback?

CancelConsume Method

Cancels an existing consumer.

Syntax

public fun cancelConsume(channelName: String?, consumerTag: String?, noWait: Boolean)

Remarks

This method requests that the server cancel the consumer identified by the given ConsumerTag on the channel specified by ChannelName.

The NoWait parameter, if True, will cause the server to execute the request asynchronously. For asynchronous request handling, the server only sends back a response in case of an error.

An exception is thrown if no channel with the given ChannelName exists, or if the server returns an error because no consumer with the given ConsumerTag exists.

Note that in AMQP, server errors are grouped into "connection errors" and "channel errors", and both are fatal. That is, if the server returns a channel error, it will then close the channel which caused the error; and if it returns a connection error, it will then close the connection. The AMQPClassic component's Error Codes page includes AMQP's various connection and channel errors.

Copyright (c) 2021 /n software inc. - All rights reserved.
IPWorks MQ 2020 Kotlin Edition - Version 20.0 [Build 7941]