twisted.trial._dist.worker.WorkerProtocol

class documentation

class WorkerProtocol(AMP): (source)

Constructor: WorkerProtocol(forceGarbageCollection)

View In Hierarchy

The worker-side trial distributed protocol.

Method __init__ Undocumented
Async Method run Run a test case by name.
Method start Set up the worker, moving into given directory for tests to run in them.
Class Variable logger Undocumented
Instance Variable _forceGarbageCollection Undocumented
Instance Variable _loader Undocumented
Instance Variable _result Undocumented

Inherited from AMP:

Method __repr__ A verbose string representation which gives us information about this AMP connection.
Method connectionLost Emit a helpful log message when the connection is lost.
Method locateResponder Unify the implementations of CommandLocator and SimpleStringLocator to perform both kinds of dispatch, preferring CommandLocator.
Method makeConnection Emit a helpful log message when the connection is made.
Instance Variable transport Undocumented
Instance Variable _ampInitialized Undocumented
Instance Variable _transportHost Undocumented
Instance Variable _transportPeer Undocumented

Inherited from BinaryBoxProtocol (via AMP):

Method dataReceived Either parse incoming data as AmpBoxes or relay it to our nested protocol.
Method lengthLimitExceeded The key length limit was exceeded. Disconnect the transport and make sure a meaningful exception is reported.
Method proto_init String received in the 'init' state.
Method proto_key String received in the 'key' state. If the key is empty, a complete box has been received.
Method proto_value String received in the 'value' state.
Method sendBox Send a amp.Box to my peer.
Method unhandledError The buck stops here. This error was completely unhandled, time to terminate the connection.
Class Variable noPeerCertificate Undocumented
Instance Variable boxReceiver an IBoxReceiver provider, whose IBoxReceiver.ampBoxReceived method will be invoked for each AmpBox that is received.
Instance Variable hostCertificate Undocumented
Instance Variable innerProtocol Undocumented
Instance Variable innerProtocolClientFactory Undocumented
Instance Variable MAX_LENGTH Undocumented
Instance Variable recvd Undocumented
Property peerCertificate Undocumented
Method _defaultStartTLSResponder The default TLS responder doesn't specify any certificate or anything.
Method _lockForSwitch Lock this binary protocol so that no further boxes may be sent. This is used when sending a request to switch underlying protocols. You probably want to subclass ProtocolSwitchCommand rather than calling this directly.
Method _prepareTLS Used by StartTLSCommand to put us into the state where we don't actually send things that get sent, instead we buffer them. see _sendBoxCommand.
Method _startTLS Used by TLSBox to initiate the SSL handshake.
Method _switchTo Switch this BinaryBoxProtocol's transport to a new protocol. You need to do this 'simultaneously' on both ends of a connection; the easiest way to do this is to use a subclass of ProtocolSwitchCommand.
Method _unlockFromSwitch Unlock this locked binary protocol so that further boxes may be sent again. This is used after an attempt to switch protocols has failed for some reason.
Constant _MAX_KEY_LENGTH Undocumented
Constant _MAX_VALUE_LENGTH Undocumented
Instance Variable _currentBox Undocumented
Instance Variable _currentKey Undocumented
Instance Variable _justStartedTLS Undocumented
Instance Variable _keyLengthLimitExceeded A flag which is only true when the connection is being closed because a key length prefix which was longer than allowed by the protocol was received.
Instance Variable _locked Undocumented
Instance Variable _startingTLSBuffer Undocumented

Inherited from StatefulStringProtocol (via AMP, BinaryBoxProtocol):

Method stringReceived Choose a protocol phase function and call it.
Instance Variable state Current state of the protocol. Defaults to 'init'.

Inherited from Int16StringReceiver (via AMP, BinaryBoxProtocol, StatefulStringProtocol):

Instance Variable prefixLength Undocumented
Instance Variable structFormat Undocumented

Inherited from IntNStringReceiver (via AMP, BinaryBoxProtocol, StatefulStringProtocol, Int16StringReceiver):

Method sendString Send a prefixed string to the other end of the connection.
Instance Variable _compatibilityOffset the offset within _unprocessed to the next message to be parsed. (used to generate the recvd attribute)
Instance Variable _unprocessed bytes received, but not yet broken up into messages / sent to stringReceived. _compatibilityOffset must be updated when this value is updated so that the recvd attribute can be generated correctly.

Inherited from Protocol (via AMP, BinaryBoxProtocol, StatefulStringProtocol, Int16StringReceiver, IntNStringReceiver):

Method logPrefix Return a prefix matching the class name, to identify log messages related to this protocol instance.
Class Variable factory Undocumented

Inherited from BaseProtocol (via AMP, BinaryBoxProtocol, StatefulStringProtocol, Int16StringReceiver, IntNStringReceiver, Protocol):

Method connectionMade Called when a connection is made.
Instance Variable connected Undocumented

Inherited from _PauseableMixin (via AMP, BinaryBoxProtocol, StatefulStringProtocol, Int16StringReceiver, IntNStringReceiver, Protocol, BaseProtocol):

Method pauseProducing Undocumented
Method resumeProducing Undocumented
Method stopProducing Undocumented
Instance Variable paused Undocumented

Inherited from _DescriptorExchanger (via AMP, BinaryBoxProtocol, StatefulStringProtocol, Int16StringReceiver, IntNStringReceiver, Protocol, BaseProtocol, _PauseableMixin):

Method fileDescriptorReceived Collect received file descriptors to be claimed later by Descriptor.
Method _sendFileDescriptor Assign and return the next ordinal to the given descriptor after sending the descriptor over this protocol's transport.
Instance Variable _descriptors Temporary storage for all file descriptors received. Values in this dictionary are the file descriptors (as integers). Keys in this dictionary are ordinals giving the order in which each descriptor was received...
Instance Variable _getDescriptor Undocumented
Instance Variable _receivingDescriptorCounter A no-argument callable which returns the ordinals, starting from 0. This is used to construct values for fileDescriptorReceived.
Instance Variable _sendingDescriptorCounter A no-argument callable which returns the ordinals, starting from 0. This is used to construct values for _sendFileDescriptor.

Inherited from BoxDispatcher (via AMP, BinaryBoxProtocol, StatefulStringProtocol, Int16StringReceiver, IntNStringReceiver, Protocol, BaseProtocol, _PauseableMixin, _DescriptorExchanger):

Method ampBoxReceived An AmpBox was received, representing a command, or an answer to a previously issued command (either successful or erroneous). Respond to it according to its contents.
Method callRemote This is the primary high-level API for sending messages via AMP. Invoke it with a command and appropriate arguments to send a message to this connection's peer.
Method callRemoteString This is a low-level API, designed only for optimizing simple messages for which the overhead of parsing is too great.
Method dispatchCommand A box with a _command key was received.
Method failAllOutgoing Call the errback on all outstanding requests awaiting responses.
Method startReceivingBoxes The given boxSender is going to start calling boxReceived on this BoxDispatcher.
Method stopReceivingBoxes No further boxes will be received here. Terminate all currently outstanding command deferreds with the given reason.
Instance Variable boxSender an object which can send boxes, via the _sendBoxCommand method, such as an AMP instance.
Instance Variable locator an object with a CommandLocator.locateResponder method that locates a responder function that takes a Box and returns a result (either a Box or a Deferred which fires one).
Method _answerReceived An AMP box was received that answered a command previously sent with callRemote.
Method _commandReceived No summary
Method _errorReceived An AMP box was received that answered a command previously sent with callRemote, with an error.
Method _nextTag Generate protocol-local serial numbers for _ask keys.
Method _safeEmit Emit a box, ignoring ProtocolSwitched and ConnectionLost errors which cannot be usefully handled.
Method _sendBoxCommand Send a command across the wire with the given amp.Box.
Class Variable _counter Undocumented
Instance Variable _failAllReason Undocumented
Instance Variable _outstandingRequests a dictionary mapping request IDs to Deferreds which were returned for those requests.

Inherited from CommandLocator (via AMP, BinaryBoxProtocol, StatefulStringProtocol, Int16StringReceiver, IntNStringReceiver, Protocol, BaseProtocol, _PauseableMixin, _DescriptorExchanger, BoxDispatcher):

Method lookupFunction Deprecated synonym for CommandLocator.locateResponder
Method _wrapWithSerialization Wrap aCallable with its command's argument de-serialization and result serialization logic.

Inherited from SimpleStringLocator (via AMP, BinaryBoxProtocol, StatefulStringProtocol, Int16StringReceiver, IntNStringReceiver, Protocol, BaseProtocol, _PauseableMixin, _DescriptorExchanger, BoxDispatcher, CommandLocator):

Class Variable baseDispatchPrefix Undocumented
def __init__(self, forceGarbageCollection=False): (source)
overrides twisted.protocols.amp.AMP.__init__

Undocumented

@workercommands.Run.responder
async def run(self, testCase: str) -> RunResult: (source)

Run a test case by name.

@workercommands.Start.responder
def start(self, directory): (source)

Set up the worker, moving into given directory for tests to run in them.

logger = (source)

Undocumented

_forceGarbageCollection = (source)

Undocumented

_loader = (source)

Undocumented

_result = (source)

Undocumented