EnginePort

class ClusterShell.Worker.EngineClient.EnginePort(handler=None, autoclose=False)

An EnginePort is an abstraction object to deliver messages reliably between tasks.

__init__(handler=None, autoclose=False)

Initialize EnginePort object.

__repr__()

Return repr(self).

__weakref__

list of weak references to the object

abort()

Abort processing any action by this client.

Safe to call on an already closing or aborting client.

msg(send_msg, send_once=False)

Port message send method that will wait for acknowledgement unless the send_once parameter if set.

May be called from another thread. Will generate ev_msg() on Port event handler (in Port task/thread).

Return False if the message cannot be sent (eg. port closed).

msg_send(send_msg)

Port message send-once method (no acknowledgement). See msg().

Return False if the message cannot be sent (eg. port closed).