class documentation
class StringTCPTransport(proto_helpers.StringTransport): (source)
Undocumented
Method | get |
Similar to getPeer, but returns an address describing this side of the connection. |
Method | get |
Get the remote address of this connection. |
Method | lose |
Close the connection. Does nothing besides toggle the disconnecting instance variable to True. |
Class Variable | peer |
Undocumented |
Instance Variable | string |
Undocumented |
Inherited from StringTransport
:
Method | __init__ |
Undocumented |
Method | abort |
Abort the connection. Same as loseConnection, but also toggles the aborted instance variable to True. |
Method | clear |
Discard all data written to this transport so far. |
Method | pause |
Pause producing data. |
Method | register |
Register to receive data from a producer. |
Method | resume |
Resume producing data. |
Method | stop |
Stop producing data. |
Method | unregister |
Stop consuming data from a producer, without disconnecting. |
Method | value |
Retrieve all data which has been buffered by this transport. |
Method | write |
Write some data to the physical connection, in sequence, in a non-blocking fashion. |
Method | write |
Write an iterable of byte strings to the physical connection. |
Instance Variable | connected |
Undocumented |
Instance Variable | disconnected |
A bool which is False until abortConnection is called, then True. |
Instance Variable | disconnecting |
A bool which is False until loseConnection is called, then True. |
Instance Variable | host |
None or an object which will be returned as the host address of this transport. If None , a nasty tuple will be returned instead. |
Instance Variable | io |
A io.BytesIO which holds the data which has been written to this transport since the last call to clear . Use value instead of accessing this directly. |
Instance Variable | peer |
None or an object which will be returned as the peer address of this transport. If None , a nasty tuple will be returned instead. |
Instance Variable | producer |
If a producer is currently registered, producer is a reference to it. Otherwise, None . |
Instance Variable | producer |
The state of this StringTransport in its capacity as an IPushProducer . One of 'producing', 'paused', or 'stopped'. |
Instance Variable | streaming |
If a producer is currently registered, streaming refers to the value of the second parameter passed to registerProducer. |
Method | _check |
Undocumented |
Instance Variable | _lenient |
By default StringTransport enforces that resumeProducing is not called after the connection is lost. This is to ensure that any code that does call resumeProducing after the connection is lost is not blindly expecting ... |
Similar to getPeer, but returns an address describing this side of the connection.
Returns | |
An IAddress provider. |
Get the remote address of this connection.
Treat this method with caution. It is the unfortunate result of the CGI and Jabber standards, but should not be considered reliable for the usual host of reasons; port forwarding, proxying, firewalls, IP masquerading, etc.
Returns | |
An IAddress provider. |