Inheritance diagram for pyrosetta.distributed.cluster.logging_handlers.MsgpackHmacSocketHandler:

Public Member Functions
None	__init__ (self, str host, int port)

None	set_masked_key (self, str task_id, bytes masked_key)

None	pop_masked_key (self, str task_id)

None	clear_masked_keys (self)

None	zeroize (self, Optional[bytearray] buffer)

None	close (self)

Any	sanitize_record_arg (self, Any arg)

Any	sanitize_record_args (self, Any args)

bytes	makePickle (self, logging.LogRecord record)

Static Private Attributes
tuple	_supported_types = (str, int, float, bool, type(None), bytes, bytearray)

Additional Inherited Members
Static Public Member Functions inherited from pyrosetta.distributed.cluster.logging_handlers.HandlerMixin
L	lock (L func)

Detailed Description

Subclass of `logging.handlers.SocketHandler` using MessagePack and hash-based message
authentication codes (HMAC).

Constructor & Destructor Documentation

◆ init()

None pyrosetta.distributed.cluster.logging_handlers.MsgpackHmacSocketHandler.__init__	(		self,
		str	host,
		int	port
	)

Referenced by pyrosetta.distributed.tasks.taskbase.TaskBase.__setstate__().

Member Function Documentation

◆ clear_masked_keys()

None pyrosetta.distributed.cluster.logging_handlers.MsgpackHmacSocketHandler.clear_masked_keys ( self )

Clear all task IDs and HMAC keys from the cache.

References basic::options::OptionKeys::in::file.list, and pyrosetta.distributed.cluster.logging_handlers.MsgpackHmacSocketHandler.zeroize().

Referenced by pyrosetta.distributed.cluster.logging_handlers.MsgpackHmacSocketHandler.close().

◆ close()

None pyrosetta.distributed.cluster.logging_handlers.MsgpackHmacSocketHandler.close ( self )

Close the handler.

References pyrosetta.distributed.cluster.logging_handlers.MsgpackHmacSocketHandler.clear_masked_keys().

Referenced by pyrosetta.distributed.utility.log.LoggingContext.__exit__(), ez_setup.ContextualZipFile.__exit__(), PyMOL-Rosetta-relay-client.SecretInputDialog.__init__(), and PyMOL-Rosetta-relay-client.SecretInputDialog.start_server().

◆ makePickle()

bytes pyrosetta.distributed.cluster.logging_handlers.MsgpackHmacSocketHandler.makePickle	(		self,
		logging.LogRecord	record
	)

Compress a logging record with MessagePack and a hash-based message authentication code (HMAC).

References pyrosetta.distributed.cluster.logging_handlers.HandlerMixin._locked(), run_backbone.float, ObjexxFCL.get(), pyrosetta.distributed.cluster.hkdf.hmac_digest(), enumerate_junctions.int, ObjexxFCL.len(), and pyrosetta.distributed.cluster.logging_handlers.MsgpackHmacSocketHandler.sanitize_record_args().

◆ pop_masked_key()

None pyrosetta.distributed.cluster.logging_handlers.MsgpackHmacSocketHandler.pop_masked_key	(		self,
		str	task_id
	)

Pop a task ID and HMAC key from the cache.

References pyrosetta.distributed.cluster.logging_handlers.HandlerMixin._locked(), and pyrosetta.distributed.cluster.logging_handlers.MsgpackHmacSocketHandler.zeroize().

◆ sanitize_record_arg()

Any pyrosetta.distributed.cluster.logging_handlers.MsgpackHmacSocketHandler.sanitize_record_arg	(		self,
		Any	arg
	)

Sanitize a single element of log record `args` for MessagePack.

References pyrosetta.distributed.cluster.str.

Referenced by pyrosetta.distributed.cluster.logging_handlers.MsgpackHmacSocketHandler.sanitize_record_args().

◆ sanitize_record_args()

Any pyrosetta.distributed.cluster.logging_handlers.MsgpackHmacSocketHandler.sanitize_record_args	(		self,
		Any	args
	)

Sanitize log record `args` for MessagePack.

References basic::options::OptionKeys::in::file.list, and pyrosetta.distributed.cluster.logging_handlers.MsgpackHmacSocketHandler.sanitize_record_arg().

Referenced by pyrosetta.distributed.cluster.logging_handlers.MsgpackHmacSocketHandler.makePickle().

◆ set_masked_key()

None pyrosetta.distributed.cluster.logging_handlers.MsgpackHmacSocketHandler.set_masked_key	(		self,
		str	task_id,
		bytes	masked_key
	)

Set a task ID and HMAC key into the cache.

◆ zeroize()

None pyrosetta.distributed.cluster.logging_handlers.MsgpackHmacSocketHandler.zeroize	(		self,
		Optional[bytearray]	buffer
	)

Zeroize a bytearray in memory.

References ObjexxFCL.len().

Referenced by pyrosetta.distributed.cluster.logging_handlers.MsgpackHmacSocketHandler.clear_masked_keys(), and pyrosetta.distributed.cluster.logging_handlers.MsgpackHmacSocketHandler.pop_masked_key().

Member Data Documentation

◆ _supported_types

tuple pyrosetta.distributed.cluster.logging_handlers.MsgpackHmacSocketHandler._supported_types = (str, int, float, bool, type(None), bytes, bytearray)

staticprivate

The documentation for this class was generated from the following file:

src/python/PyRosetta/src/pyrosetta/distributed/cluster/logging_handlers.py

Public Member Functions

Static Private Attributes

Additional Inherited Members