Go to the latest version of this document.
search in docstrings

Search bar offers the following options:

- Term presence. The below example searches for documents that must contain “foo”, might contain “bar” and must not contain “baz”: `+foo bar -baz`
- Wildcards. The below example searches for documents with words beginning with “foo”: `foo*`
- Search in specific fields. The following search matches all objects in "twisted.mail" that matches “search”: `+qname:twisted.mail.* +search`

  Possible fields: 'name', 'qname' (fully qualified name), 'docstring', and 'kind'. Last two fields are only applicable if "search in docstrings" is enabled.

- Fuzzy matches. The following search matches all documents that have a word within 1 edit distance of “foo”: `foo~1`

Results provided by Lunr.js

# ``twisted`.`protocols`.`policies`.`TrafficLoggingProtocol``

class documentation

`class TrafficLoggingProtocol(ProtocolWrapper): (source)`

Constructor: `TrafficLoggingProtocol(factory, wrappedProtocol, logfile, lengthLimit, number)`

View In Hierarchy

Undocumented

Method | `__init__` | No summary
Method | `connectionLost` | Called when the connection is shut down.
Method | `connectionMade` | Called when a connection is made.
Method | `dataReceived` | Called whenever data is received.
Method | `loseConnection` | Undocumented
Method | `write` | Undocumented
Method | `writeSequence` | Undocumented
Instance Variable | `lengthLimit` | Undocumented
Instance Variable | `logfile` | Undocumented
Method | `_log` | Undocumented
Method | `_mungeData` | Undocumented
Instance Variable | `_number` | Undocumented

Inherited from `ProtocolWrapper`:

Method | `__getattr__` | Undocumented
Method | `getHost` | Undocumented
Method | `getPeer` | Undocumented
Method | `logPrefix` | Use a customized log prefix mentioning both the wrapped protocol and the current one.
Method | `makeConnection` | When a connection is made, register this wrapper with its factory, save the real transport, and connect the wrapped protocol to this `ProtocolWrapper` to intercept any transport calls it makes.
Method | `registerProducer` | Undocumented
Method | `stopConsuming` | Undocumented
Method | `unregisterProducer` | Undocumented
Instance Variable | `disconnecting` | Undocumented
Instance Variable | `factory` | The `WrappingFactory` which created this `ProtocolWrapper`.
Instance Variable | `wrappedProtocol` | An `IProtocol` provider to which `IProtocol` method calls onto this `ProtocolWrapper` will be proxied.

Inherited from `BaseProtocol` (via `ProtocolWrapper`, `Protocol`):

Instance Variable | `connected` | Undocumented
Instance Variable | `transport` | Undocumented

def __init__(self, factory, wrappedProtocol, logfile, lengthLimit=None, number=0): (source)
overrides `twisted.protocols.policies.ProtocolWrapper.__init__`

Parameters
factory:`protocol.Factory`. | factory which created this protocol.
wrappedProtocol:`protocol.Protocol`. | the underlying protocol.
logfile:`file` | file opened for writing used to write log messages.
lengthLimit:`int` | maximum size of the datareceived logged.
number:`int`. | identifier of the connection.

def connectionLost(self, reason): (source)
from `twisted.internet.interfaces.IProtocol`
overrides `twisted.protocols.policies.ProtocolWrapper.connectionLost`

Called when the connection is shut down.

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

Parameters
reason:`twisted.python.failure.Failure` | Undocumented

def connectionMade(self): (source)
from `twisted.internet.interfaces.IProtocol`
overrides `twisted.internet.protocol.BaseProtocol.connectionMade`

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.

def dataReceived(self, data): (source)
from `twisted.internet.interfaces.IProtocol`
overrides `twisted.protocols.policies.ProtocolWrapper.dataReceived`

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.

Parameters
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.

def loseConnection(self): (source)
overrides `twisted.protocols.policies.ProtocolWrapper.loseConnection`

Undocumented

def write(self, data): (source)
overrides `twisted.protocols.policies.ProtocolWrapper.write`

Undocumented

def writeSequence(self, iovec): (source)
overrides `twisted.protocols.policies.ProtocolWrapper.writeSequence`

Undocumented

lengthLimit = (source)

Undocumented

logfile = (source)

Undocumented

def _log(self, line): (source)

Undocumented

def _mungeData(self, data): (source)

Undocumented

_number = (source)

Undocumented