Inheritance diagram for pyrosetta.distributed.cluster.logging_listeners.SocketListener:

Public Member Functions
None	__init__ (self, str logging_address, str logging_file, str logging_level, Union[float, int] timeout, bool ignore_errors)

logging.FileHandler	setup_handler (self, str logging_file, str logging_level)

None	start (self)

None	stop (self)

None	serve_until_stopped (self)

Public Attributes
	socket_listener_address

	handler

	passkey

	timeout

	ignore_errors

	max_packet_size

	abort

Static Public Attributes
bool	allow_reuse_address = True

Private Attributes
	_thread

Detailed Description

TCP socket-based logging receiver modified from logging cookbook recipe:
https://docs.python.org/3/howto/logging-cookbook.html#sending-and-receiving-logging-events-across-a-network

Constructor & Destructor Documentation

◆ init()

None pyrosetta.distributed.cluster.logging_listeners.SocketListener.__init__	(		self,
		str	logging_address,
		str	logging_file,
		str	logging_level,
		Union[float, int]	timeout,
		bool	ignore_errors
	)

References pyrosetta.distributed.cluster.logging_filters.split_socket_address().

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

Member Function Documentation

◆ serve_until_stopped()

None pyrosetta.distributed.cluster.logging_listeners.SocketListener.serve_until_stopped ( self )

Run logging socket listener until aborted.

References job_manager.CommandRunner.abort(), pyrosetta.distributed.cluster.logging_listeners.SocketListener.abort, ui::network::Bowman.abort(), ui::network::BowmanThread.abort(), PyMOL-Rosetta-relay-client.PR_UDPServer.socket, PyMOL-RosettaServer.PR_UDPServer.socket, pyrosetta.network.rosetta_udp_to_tcp_bridge.PR_UDPServer.socket, pyrosetta.PyMOLRosettaServer.PR_UDPServer.socket, pyrosetta.distributed.cluster.core.PyRosettaCluster.timeout, pyrosetta.distributed.cluster.logging_listeners.SocketListener.timeout, and ui::network::B.timeout.

◆ setup_handler()

logging.FileHandler pyrosetta.distributed.cluster.logging_listeners.SocketListener.setup_handler	(		self,
		str	logging_file,
		str	logging_level
	)

Setup logging file handler for logging socket listener.

References join(), and pyrosetta.distributed.cluster.logging_listeners.SocketListener.socket_listener_address.

Referenced by pyrosetta.distributed.cluster.logging_handlers.MultiSocketHandler.get().

◆ start()

None pyrosetta.distributed.cluster.logging_listeners.SocketListener.start ( self )

Start logging socket listener.

References pyrosetta.distributed.cluster.logging_listeners.SocketListener._thread.

Referenced by pyrosetta.tests.distributed.test_gil.HeartBeat.__enter__(), and enumerate_junctions.Component.to_string().

◆ stop()

None pyrosetta.distributed.cluster.logging_listeners.SocketListener.stop ( self )

Stop logging socket listener.

References pyrosetta.distributed.cluster.logging_listeners.SocketListener._thread, and join().

Member Data Documentation

◆ _thread

pyrosetta.distributed.cluster.logging_listeners.SocketListener._thread

private

Referenced by pyrosetta.distributed.cluster.logging_listeners.SocketListener.start(), and pyrosetta.distributed.cluster.logging_listeners.SocketListener.stop().

◆ abort

pyrosetta.distributed.cluster.logging_listeners.SocketListener.abort

Referenced by job_manager.CommandRunner.menu(), and pyrosetta.distributed.cluster.logging_listeners.SocketListener.serve_until_stopped().

◆ allow_reuse_address

bool pyrosetta.distributed.cluster.logging_listeners.SocketListener.allow_reuse_address = True

static

◆ handler

pyrosetta.distributed.cluster.logging_listeners.SocketListener.handler

Referenced by pyrosetta.distributed.utility.log.LoggingContext.__exit__().

◆ ignore_errors

pyrosetta.distributed.cluster.logging_listeners.SocketListener.ignore_errors

Referenced by pyrosetta.distributed.cluster.core.PyRosettaCluster._run().

◆ max_packet_size

pyrosetta.distributed.cluster.logging_listeners.SocketListener.max_packet_size

◆ passkey

pyrosetta.distributed.cluster.logging_listeners.SocketListener.passkey

◆ socket_listener_address

pyrosetta.distributed.cluster.logging_listeners.SocketListener.socket_listener_address

Referenced by pyrosetta.distributed.cluster.logging_listeners.SocketListener.setup_handler().

◆ timeout

pyrosetta.distributed.cluster.logging_listeners.SocketListener.timeout

Referenced by pyrosetta.distributed.cluster.core.PyRosettaCluster._run(), and pyrosetta.distributed.cluster.logging_listeners.SocketListener.serve_until_stopped().

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

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

Public Member Functions

Public Attributes

Static Public Attributes

Private Attributes