channel_mode Property

What mode the channel is operating in.

Syntax

def get_channel_mode(channel_index: int) -> int: ...

Default Value

0

Remarks

What mode the channel is operating in.

This property reflects what mode the channel is operating in. Possible values are:

• cmtNormal (0 - default): Normal mode.
• cmtTransactional (1): Transaction mode.
• cmtPublishConfirms (2): Publish confirmations mode.

All channels are in normal mode when they are created; there's nothing special about a channel in normal mode.

Channels can be put in transaction mode using the enable_transaction_mode method. While a channel is in transaction mode, all messages published and acknowledgements sent over it will be part of a transaction, and the server will wait to process them until the transaction is either committed or rolled back.

Channels can be put in publish confirmations mode using the enable_publish_confirms method. While a channel is in publish confirmations mode, the server will acknowledge each message published by the class. The class will wait to fire the on_message_out event until it receives this acknowledgement. (Note that this mode is only available when the RabbitMQCompatible configuration setting is enabled.)

Note: Switching a channel to transaction or publish confirmations mode is a permanent action; the channel will then remain in that mode for the remainder of its lifetime.

The channel_index parameter specifies the index of the item in the array. The size of the array is controlled by the channel_count property.

This property is read-only.