minos.plugins.rabbitmq.subscriber

Classes

`RabbitMQBrokerSubscriber`	RabbitMQ Broker Subscriber class.
`RabbitMQBrokerSubscriberBuilder`	RabbitMQ Broker Subscriber Builder class.

class RabbitMQBrokerSubscriber[source]

Bases: BrokerSubscriber

RabbitMQ Broker Subscriber class.

__init__(topics, host=None, port=None, user=None, password=None, **kwargs)[source]

Parameters

topics (Iterable[str]) –
host (Optional[str]) –
port (Optional[int]) –
user (Optional[str]) –
password (Optional[str]) –

property already_destroyed: bool

Already Destroy getter.

Returns: A boolean value.

property already_setup: bool

Already Setup getter.

Returns: A boolean value.

async destroy()

Destroy miscellaneous repository things.

Returns: This method does not return anything.
Return type: None

classmethod from_config(config=None, **kwargs)

Build a new instance from config.

Parameters

config (Optional[Union[Config, Path]]) – Config instance. If None is provided, default config is chosen.
kwargs – Additional named arguments.

Returns

A instance of the called class.

Return type

S

classmethod get_builder()

Get the builder class.

Returns: A Builder instance.
Return type: Builder[Ins]

async receive()

Receive a new message.

Returns: A BrokerMessage instance.
Return type: BrokerMessage

classmethod set_builder(builder)

Set a builder class.

Parameters: builder (Union[Builder[Ins], type[minos.common.builders.Builder[~Ins]]]) – The builder class to be set.
Returns: This method does not return anything.
Return type: None

async setup()

Setup miscellaneous repository things.

Returns: This method does not return anything.
Return type: None

property topics: set[str]

Topics getter.

Returns: A list of string values.

class RabbitMQBrokerSubscriberBuilder[source]

Bases: BrokerSubscriberBuilder[RabbitMQBrokerSubscriber], RabbitMQBrokerBuilderMixin

RabbitMQ Broker Subscriber Builder class.

__init__(*args, validator_builder=None, queue_builder=None, filtered_cls=None, queued_cls=None, **kwargs)

Parameters

validator_builder (Optional[Builder]) –
queue_builder (Optional[BrokerSubscriberQueueBuilder]) –
filtered_cls (Optional[type[FilteredBrokerSubscriber]]) –
queued_cls (Optional[type[QueuedBrokerSubscriber]]) –

property already_destroyed: bool

Already Destroy getter.

Returns: A boolean value.

property already_setup: bool

Already Setup getter.

Returns: A boolean value.

build()

Build the instance.

Returns: A QueuedBrokerSubscriber instance.
Return type: BrokerSubscriber

copy()

Get a copy of the instance.

Returns: A Builder instance.
Parameters: self (type[~B]) –
Return type: B

async destroy()

Destroy miscellaneous repository things.

Returns: This method does not return anything.
Return type: None

classmethod from_config(config=None, **kwargs)

Build a new instance from config.

Parameters

config (Optional[Union[Config, Path]]) – Config instance. If None is provided, default config is chosen.
kwargs – Additional named arguments.

Returns

A instance of the called class.

Return type

S

classmethod get_injectable_name()

Get the injectable name.

Returns: A str value.
Return type: str

classmethod new()

Get a new instance.

Returns: A Builder instance.
Return type: B

async setup()

Setup miscellaneous repository things.

Returns: This method does not return anything.
Return type: None

with_cls(cls)

Set class to be built.

Parameters

cls (type) – The class to be set.
self (B) –

Returns

This method return the builder instance.

Return type

B

with_config(config)

Set config.

Parameters: config (Config) – The config to be set.
Returns: This method return the builder instance.

with_filtered_cls(filtered_cls)

Set the filtered class.

Parameters: filtered_cls (type[FilteredBrokerSubscriber]) – A subclass of FilteredBrokerSubscriber.
Returns: This method return the builder instance.

with_group_id(group_id)

Set group_id.

Parameters: group_id (Optional[str]) – The group_id to be set.
Returns: This method return the builder instance.

with_kwargs(kwargs)

Set kwargs.

Parameters: kwargs (dict[str, Any]) – The kwargs to be set.
Returns: This method return the builder instance.

with_queue(queue)

Set the queue builder.

Parameters: queue (Union[type[BrokerSubscriberQueue], BrokerSubscriberQueueBuilder]) – The queue to be set.
Returns: This method return the builder instance.

with_queued_cls(queued_cls)

Set the queued class.

Parameters: queued_cls (type[QueuedBrokerSubscriber]) – A subclass of QueuedBrokerSubscriber.
Returns: This method return the builder instance.

with_remove_topics_on_destroy(remove_topics_on_destroy)

Set remove_topics_on_destroy.

Parameters: remove_topics_on_destroy (bool) – The remove_topics_on_destroy flag to be set.
Returns: This method return the builder instance.

with_topics(topics)

Set topics.

Parameters: topics (Iterable[str]) – The topics to be set.
Returns: This method return the builder instance.

with_validator(validator)

Set the duplicate detector.

Parameters: validator (Union[type[BrokerSubscriberValidator], Builder[BrokerSubscriberValidator]]) – The duplicate detector to be set.
Returns: This method return the builder instance.