Skip to content

WatcherContext

faststream.broker.push_back_watcher.WatcherContext #

WatcherContext(
    watcher: BaseWatcher,
    message: Union[
        SyncStreamMessage[MsgType], StreamMessage[MsgType]
    ],
    **extra_ack_args: Any
)

A class representing a context for a watcher.

METHOD DESCRIPTION
__aenter__

called when entering the context

__aexit__

called when exiting the context

__ack

acknowledges the message

__nack

negatively acknowledges the message

__reject

rejects the message

Note

The above docstring is autogenerated by docstring-gen library (https://docstring-gen.airt.ai)

Initialize a new instance of the class.

PARAMETER DESCRIPTION
watcher

An instance of BaseWatcher.

TYPE: BaseWatcher

message

An instance of SyncStreamMessage or StreamMessage.

TYPE: Union[SyncStreamMessage[MsgType], StreamMessage[MsgType]]

**extra_ack_args

Additional arguments for acknowledgement.

TYPE: Any DEFAULT: {}

Note

The above docstring is autogenerated by docstring-gen library (https://docstring-gen.airt.ai)

Source code in faststream/broker/push_back_watcher.py
def __init__(
    self,
    watcher: BaseWatcher,
    message: Union[SyncStreamMessage[MsgType], StreamMessage[MsgType]],
    **extra_ack_args: Any,
):
    """Initialize a new instance of the class.

    Args:
        watcher: An instance of BaseWatcher.
        message: An instance of SyncStreamMessage or StreamMessage.
        **extra_ack_args: Additional arguments for acknowledgement.

    Attributes:
        watcher: An instance of BaseWatcher.
        message: An instance of SyncStreamMessage or StreamMessage.
        extra_ack_args: Additional arguments for acknowledgement.
    !!! note

        The above docstring is autogenerated by docstring-gen library (https://docstring-gen.airt.ai)
    """
    self.watcher = watcher
    self.message = message
    self.extra_ack_args = extra_ack_args or {}

extra_ack_args instance-attribute #

extra_ack_args = extra_ack_args or {}

message instance-attribute #

message = message

watcher instance-attribute #

watcher = watcher

Last update: 2023-11-13