Skip to content

WatcherContext

faststream.broker.push_back_watcher.WatcherContext #

WatcherContext(
    message: Union[
        SyncStreamMessage[MsgType], StreamMessage[MsgType]
    ],
    watcher: BaseWatcher,
    **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

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: `{}`

Source code in faststream/broker/push_back_watcher.py

def __init__(
    self,
    message: Union[SyncStreamMessage[MsgType], StreamMessage[MsgType]],
    watcher: BaseWatcher,
    **extra_ack_args: Any,
) -> None:
    """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.

    """
    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