(P) simple_subproc

(M) simple_subproc_child_protocol

class peek_plugin_base.simple_subproc.simple_subproc_child_protocol.SimpleSubprocChildProtocol(TaskClass)[source]

Bases: twisted.internet.protocol.Protocol

connectionLost(reason: twisted.python.failure.Failure = <twisted.python.failure.Failure twisted.internet.error.ConnectionDone: Connection was closed cleanly.>)[source]

Called when the connection is shut down.

Clear any circular references here, and any external references to this Protocol. The connection has been closed.

@type reason: L{twisted.python.failure.Failure}

dataReceived(data: bytes)[source]

Called whenever data is received.

Use this method to translate to a higher-level message. Usually, some callback will be made upon the receipt of each complete protocol message.

@param data: a string of indeterminate length. Please keep in mind
that you will probably need to buffer some data, as partial (or multiple) protocol messages may be received! I recommend that unit tests for protocols call through to this method with differing chunk sizes, down to one byte at a time.

(M) simple_subproc_parent_protocol

class peek_plugin_base.simple_subproc.simple_subproc_parent_protocol.SimpleSubprocParentProtocol(constructorTuple: peek_plugin_base.simple_subproc.simple_subproc_task_constructor_tuple.SimpleSubprocTaskConstructorTuple)[source]

Bases: twisted.internet.protocol.ProcessProtocol

connectionMade()[source]

Called when a connection is made.

This may be considered the initializer of the protocol, because it is called when the connection is completed. For clients, this is called once the connection to the server has been established; for servers, this is called after an accept() call stops blocking and a socket has been received. If you need to send any greeting or initial message, do it here.

errReceived(data: bytes)[source]

Some data was received from stderr.

outReceived(data)[source]

Some data was received from stdout.

queueCommand(command: peek_plugin_base.simple_subproc.simple_subproc_task_call_tuple.SimpleSubprocTaskCallTuple) → twisted.internet.defer.Deferred[source]

(M) simple_subproc_task_call_tuple

class peek_plugin_base.simple_subproc.simple_subproc_task_call_tuple.SimpleSubprocTaskCallTuple(**kwargs)[source]

Bases: vortex.Tuple.Tuple

commandUuid = <vortex.Tuple.TupleField object>
kwargs = <vortex.Tuple.TupleField object>

(M) simple_subproc_task_constructor_tuple

class peek_plugin_base.simple_subproc.simple_subproc_task_constructor_tuple.SimpleSubprocTaskConstructorTuple(**kwargs)[source]

Bases: vortex.Tuple.Tuple

kwargs = <vortex.Tuple.TupleField object>

(M) simple_subproc_task_result_tuple

class peek_plugin_base.simple_subproc.simple_subproc_task_result_tuple.SimpleSubprocTaskResultTuple(**kwargs)[source]

Bases: vortex.Tuple.Tuple

commandUuid = <vortex.Tuple.TupleField object>
exceptionStr = <vortex.Tuple.TupleField object>
result = <vortex.Tuple.TupleField object>