minos.networks.routers

Classes

`BrokerRouter`	Broker Router class.
`HttpRouter`	Http Router base class.
`PeriodicRouter`	Periodic Router class.
`RestHttpRouter`	Rest Http Router class.
`Router`	Router base class.

class Router[source]

Bases: ABC, SetupMixin

Router base class.

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

Parameters: config (Config) –

routes

Get the routes stored on the router.

Returns: A dict with decorators as keys and callbacks as values.

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

async setup()

Setup miscellaneous repository things.

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

class HttpRouter[source]

Bases: Router, ABC

Http Router base class.

routes: dict[minos.networks.decorators.definitions.http.abc.HttpEnrouteDecorator, Callable]

Get the routes stored on the router.

Returns: A dict with decorators as keys and callbacks as values.

__init__(config, **kwargs)

Parameters: config (Config) –

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

async setup()

Setup miscellaneous repository things.

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

class RestHttpRouter[source]

Bases: HttpRouter

Rest Http Router class.

__init__(config, **kwargs)

Parameters: config (Config) –

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

routes: dict[minos.networks.decorators.definitions.http.abc.HttpEnrouteDecorator, Callable]

Get the routes stored on the router.

Returns: A dict with decorators as keys and callbacks as values.

async setup()

Setup miscellaneous repository things.

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

class BrokerRouter[source]

Bases: Router

Broker Router class.

__init__(config, **kwargs)

Parameters: config (Config) –

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

routes

Get the routes stored on the router.

Returns: A dict with decorators as keys and callbacks as values.

async setup()

Setup miscellaneous repository things.

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

class PeriodicRouter[source]

Bases: Router

Periodic Router class.

__init__(config, **kwargs)

Parameters: config (Config) –

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

routes

Get the routes stored on the router.

Returns: A dict with decorators as keys and callbacks as values.

async setup()

Setup miscellaneous repository things.

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