minos.networks.brokers.subscribers.queued.queues.abc

Classes

`BrokerSubscriberQueue`	Broker Subscriber Queue class.
`BrokerSubscriberQueueBuilder`	Broker Subscriber Queue Builder class.

class BrokerSubscriberQueue[source]

Bases: BrokerQueue, ABC

Broker Subscriber Queue class.

__init__(topics, **kwargs)[source]

Parameters: topics (Iterable[str]) –

property topics: set[str]

Topics getter.

Returns: A list of string values.

property already_destroyed: bool

Already Destroy getter.

Returns: A boolean value.

property already_setup: bool

Already Setup getter.

Returns: A boolean value.

async dequeue()

Dequeue method.

Return type: BrokerMessage

async destroy()

Destroy miscellaneous repository things.

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

async enqueue(message)

Enqueue method.

Parameters: message (BrokerMessage) –
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]

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

class BrokerSubscriberQueueBuilder[source]

Bases: Builder[BrokerSubscriberQueueCls], Generic[BrokerSubscriberQueueCls]

Broker Subscriber Queue Builder class.

with_topics(topics)[source]

Set topics.

Parameters

topics (Iterable[str]) – The topics to be set.
self (B) –

Returns

This method return the builder instance.

Return type

B

__init__(instance_cls=None, *args, **kwargs)

Parameters: instance_cls (Optional[type[~Instance]]) –

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 Instance instance.
Return type: Instance

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 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.
self (B) –

Returns

This method return the builder instance.

Return type

B

with_kwargs(kwargs)

Set kwargs.

Parameters

kwargs (dict[str, Any]) – The kwargs to be set.
self (B) –

Returns

This method return the builder instance.

Return type

B