pip_services3_commons.run.ICleanable module

pip_services3_commons.run.ICleanable

Interface for cleanable components

copyright

Conceptual Vision Consulting LLC 2018-2019, see AUTHORS for more details.

license

MIT, see LICENSE for more details.

class pip_services3_commons.run.ICleanable.ICleanable

Bases: abc.ABC

Interface for components that should clean their state. Cleaning state most often is used during testing. But there may be situations when it can be done in production.

clear(correlation_id: Optional[str, None])

Clears component state.

Parameters

correlation_id – (optional) transaction id to trace execution through call chain.