egse.monitoring

cgse-common

This code is part of the cgse-common package.

egse.monitoring ¶

Classes:

Name	Description
`Monitoring`	Context manager to monitor processes.

Functions:

Name	Description
`monitoring`	Monitor the status of a control server on hostname:port.

Monitoring(
    endpoint,
    subscribe=None,
    use_pickle=True,
    callback=None,
    timeout=None,
)

Context manager to monitor processes.

Most control servers publish status information on their MONITORING_PORT.

Parameters:

Name	Type	Description	Default
`endpoint`	`str`	the endpoint to which the service will connect	required
`subscribe`	`Tuple[str]`	subscription string, default is 'ALL'	`None`
`use_pickle`	`bool`	use pickle to process responses, currently always True	`True`
`callback`	`Callable`	function that is called to process the response	`None`
`timeout`	`float`	stop monitoring after timeout seconds	`None`

monitoring(
    hostname,
    port,
    subscribe=None,
    use_pickle=True,
    list_names=False,
    callback=None,
)

Monitor the status of a control server on hostname:port.

The port number shall correspond to the port number on which the control server is publishing status information.