notice

This is unreleased documentation for Rasa Open Source Documentation Master/Unreleased version.
For the latest released documentation, see the latest version (2.x).

Version: Master/Unreleased

rasa.core.brokers.broker

EventBroker Objects

class EventBroker()

Base class for any event broker implementation.

create

@staticmethod
async def create(obj: Union["EventBroker", EndpointConfig, None], loop: Optional[AbstractEventLoop] = None) -> Optional["EventBroker"]

Factory to create an event broker.

from_endpoint_config

@classmethod
async def from_endpoint_config(cls, broker_config: EndpointConfig, event_loop: Optional[AbstractEventLoop] = None) -> "EventBroker"

Creates an EventBroker from the endpoint configuration.

Arguments:

  • broker_config - The configuration for the broker.
  • event_loop - The current event loop or None.

Returns:

An EventBroker object.

publish

def publish(event: Dict[Text, Any]) -> None

Publishes a json-formatted Rasa Core event into an event queue.

is_ready

def is_ready() -> bool

Determine whether or not the event broker is ready.

Returns:

True by default, but this may be overridden by subclasses.

close

async def close() -> None

Close the connection to an event broker.