Part of twisted.protocols.amp View Source View In Hierarchy
Boxes - key/value pairs - via length-prefixed strings. A box is composed of:
In other words, an even number of strings prefixed with packed unsigned 16-bit integers, and then a 0-length string to indicate the end of the box.This protocol also implements 2 extra private bits of functionality related to the byte boundaries between messages; it can start TLS between two given boxes or switch to an entirely different protocol. However, due to some tricky elements of the implementation, the public interface to this functionality is
|Instance Variables||boxReceiver||an |
|Method||sendBox||Send a amp.Box to my peer.|
|Method||dataReceived||Either parse incoming data as
|Method||connectionLost||The connection was lost; notify any nested protocol.|
|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||unhandledError||The buck stops here. This error was completely unhandled, time to terminate the connection.|
|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.|
|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
|Method||_startTLS||Used by TLSBox to initiate the SSL handshake.|
|Method||_defaultStartTLSResponder||The default TLS responder doesn't specify any certificate or anything.|
Inherited from StatefulStringProtocol:
|Method||stringReceived||Choose a protocol phase function and call it.|
|Method||sendString||Send an prefixed string to the other end of the connection.|
|Method||connectionMade||Called when a connection is made.|
|Parameters||newProto||the new protocol instance to switch to.|
|clientFactory||the ClientFactory to send the |
Send a amp.Box to my peer.Note: transport.write is never called outside of this method.
|Raises||ProtocolSwitched||if the protocol has previously been switched.|
|ConnectionLost||if the connection has previously been lost.|
boxReceiverthat it is about to receive boxes from this protocol by invoking
AmpBoxes or relay it to our nested protocol.
The default TLS responder doesn't specify any certificate or anything.
From a security perspective, it's little better than a plain-text connection - but it is still a *bit* better, so it's included for convenience.You probably want to override this by providing your own StartTLS.responder.