IClosable

Interface that allows you to create a component with a method that closes it and frees used resources.

Description

The IClosable interface allows you to create a component with a method that closes it and frees used resources.

Instance methods

close

Closes a component and frees used resources.

close(correlation_id: Optional[str])

  • correlation_id: Optional[str] - (optional) transaction id to trace execution through call chain.

Examples

class MyConnector(IClosable):
    _client = None
    
    ... # The _client can be lazy created
    
    def close(self, correlation_id):
        if self._client is not None:
            self._client.close()
            self._client = None  

See also