Skip to content

BaseProtocolMixin

Full path: schola.core.protocols.base.BaseProtocolMixin

schola.core.protocols.base.BaseProtocolMixin

BaseProtocolMixin

BaseProtocolMixin

Bases: object

Mixin class for protocol implementations.

This class provides additional functionality that can be mixed into protocol implementations via multiple inheritance.

Methods

ItemDescription
__init__()
on_closeHook called when the protocol is being closed.
on_startHook called when the protocol is starting.

Attributes

ItemDescription
mixin_propertiesGet mixin-specific properties.

mixin_properties

mixin_properties: Dict[str, Any]

Get mixin-specific properties.


on_close

on_close()

Hook called when the protocol is being closed.

Override this method to perform cleanup specific to the mixin.

Returns

None


on_start

on_start()

Hook called when the protocol is starting.

Override this method to perform initialization specific to the mixin.

Returns

None