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`.`internet`.`endpoints`.`_WrappingProtocol``

class documentation

`class _WrappingProtocol(Protocol): (source)`

View In Hierarchy

Wrap another protocol in order to notify my user when a connection has been made.

Method | `__init__` | No summary
Method | `connectionLost` | Proxy `connectionLost` calls to our `self._wrappedProtocol`
Method | `connectionMade` | Connect the `self._wrappedProtocol` to our `self.transport` and callback `self._connectedDeferred` with the `self._wrappedProtocol`
Method | `dataReceived` | Proxy `dataReceived` calls to our `self._wrappedProtocol`
Method | `fileDescriptorReceived` | Proxy `fileDescriptorReceived` calls to our `self._wrappedProtocol`
Method | `handshakeCompleted` | Proxy `interfaces.IHandshakeListener` to our `self._wrappedProtocol`.
Method | `logPrefix` | Transparently pass through the wrapped protocol's log prefix.
Method | `readConnectionLost` | Proxy `IHalfCloseableProtocol.readConnectionLost` to our `self._wrappedProtocol`
Method | `writeConnectionLost` | Proxy `IHalfCloseableProtocol.writeConnectionLost` to our `self._wrappedProtocol`
Instance Variable | `_connectedDeferred` | Undocumented
Instance Variable | `_wrappedProtocol` | Undocumented

Inherited from `Protocol`:

Class Variable | `factory` | Undocumented

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

Method | `makeConnection` | Make a connection to a transport and a server.
Instance Variable | `connected` | Undocumented
Instance Variable | `transport` | Undocumented

def __init__(self, connectedDeferred, wrappedProtocol): (source)

Parameters
connectedDeferred | The `Deferred` that will callback with the `wrappedProtocol` when it is connected.
wrappedProtocol | An `IProtocol` provider that will be connected.

def connectionLost(self, reason): (source)
from `twisted.internet.interfaces.IProtocol`
overrides `twisted.internet.protocol.Protocol.connectionLost`

Proxy `connectionLost` calls to our `self._wrappedProtocol`

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

Connect the `self._wrappedProtocol` to our `self.transport` and callback `self._connectedDeferred` with the `self._wrappedProtocol`

def dataReceived(self, data): (source)
from `twisted.internet.interfaces.IProtocol`
overrides `twisted.internet.protocol.Protocol.dataReceived`

Proxy `dataReceived` calls to our `self._wrappedProtocol`

def fileDescriptorReceived(self, descriptor): (source)

Proxy `fileDescriptorReceived` calls to our `self._wrappedProtocol`

def handshakeCompleted(self): (source)

Proxy `interfaces.IHandshakeListener` to our `self._wrappedProtocol`.

def logPrefix(self): (source)
from `twisted.internet.interfaces.ILoggingContext`
overrides `twisted.internet.protocol.Protocol.logPrefix`

Transparently pass through the wrapped protocol's log prefix.

def readConnectionLost(self): (source)

Proxy `IHalfCloseableProtocol.readConnectionLost` to our `self._wrappedProtocol`

def writeConnectionLost(self): (source)

Proxy `IHalfCloseableProtocol.writeConnectionLost` to our `self._wrappedProtocol`

_connectedDeferred = (source)

Undocumented

_wrappedProtocol = (source)

Undocumented