Skip to content

AsyncPublisherProtocol

faststream.broker.types.AsyncPublisherProtocol #

Bases: Protocol

A protocol for an asynchronous publisher.

publish async #

publish(message: SendableMessage, correlation_id: Optional[str] = None, **kwargs: Any) -> Optional[SendableMessage]

Publishes a message asynchronously.

PARAMETER DESCRIPTION
message

The message to be published.

TYPE: SendableMessage

correlation_id

Optional correlation ID for the message.

TYPE: Optional[str] DEFAULT: None

**kwargs

Additional keyword arguments.

TYPE: Any DEFAULT: {}

RETURNS DESCRIPTION
Optional[SendableMessage]

The published message, or None if the message was not published.
Source code in faststream/broker/types.py 
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
async def publish(
    self,
    message: SendableMessage,
    correlation_id: Optional[str] = None,
    **kwargs: Any,
) -> Optional[SendableMessage]:
    """Publishes a message asynchronously.

    Args:
        message: The message to be published.
        correlation_id: Optional correlation ID for the message.
        **kwargs: Additional keyword arguments.

    Returns:
        The published message, or None if the message was not published.

    """
    ...