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`.`web`.`http`.`_GenericHTTPChannelProtocol``

class documentation

`class _GenericHTTPChannelProtocol(proxyForInterface(IProtocol, '_channel')): (source)`

View In Hierarchy

A proxy object that wraps one of the HTTP protocol objects, and switches between them depending on TLS negotiated protocol.

Method | `callLater.setter` | Sets the value for the `callLater` callback. This callback is used by the `twisted.protocols.policies.TimeoutMixin` to handle timeouts.
Method | `dataReceived` | An override of `IProtocol.dataReceived` that checks what protocol we're using.
Method | `factory.setter` | Undocumented
Method | `requestFactory.setter` | A callable to use to build `IRequest` objects.
Method | `site.setter` | A reference to the creating `twisted.web.server.Site` object.
Method | `timeOut.setter` | The idle timeout for the backing channel.
Property | `callLater` | A value for the `callLater` callback. This callback is used by the `twisted.protocols.policies.TimeoutMixin` to handle timeouts.
Property | `factory` | No summary
Property | `requestFactory` | A callable to use to build `IRequest` objects.
Property | `site` | A reference to the creating `twisted.web.server.Site` object.
Property | `timeOut` | The idle timeout for the backing channel.
Instance Variable | `_callLater` | A value for the `callLater` callback.
Instance Variable | `_channel` | The object capable of behaving like a `HTTPChannel` that is backing this object. By default this is a `HTTPChannel`, but if a HTTP protocol upgrade takes place this may be a different channel object. Must implement ...
Instance Variable | `_factory` | A reference to the creating `HTTPFactory` object.
Instance Variable | `_negotiatedProtocol` | The protocol negotiated with ALPN or NPN, if any.
Instance Variable | `_requestFactory` | A callable to use to build `IRequest` objects.
Instance Variable | `_site` | A reference to the creating `twisted.web.server.Site` object.
Instance Variable | `_timeOut` | A timeout value to pass to the backing channel.

@callLater.setter
def callLater(self, value): (source)

Sets the value for the `callLater` callback. This callback is used by the `twisted.protocols.policies.TimeoutMixin` to handle timeouts.

Parameters
value:`callable` | The new callback to use.

def dataReceived(self, data): (source)

An override of `IProtocol.dataReceived` that checks what protocol we're using.

@factory.setter
def factory(self, value): (source)

Undocumented

@requestFactory.setter
def requestFactory(self, value): (source)

A callable to use to build `IRequest` objects.

Sets the object on the backing channel and also stores the value for propagation to any new channel.

Parameters
value:A `callable` returning `IRequest` | The new callable to use.

@site.setter
def site(self, value): (source)

A reference to the creating `twisted.web.server.Site` object.

Sets the object on the backing channel and also stores the value for propagation to any new channel.

Parameters
value:`twisted.web.server.Site` | The `twisted.web.server.Site` object to set.

@timeOut.setter
def timeOut(self, value): (source)

The idle timeout for the backing channel.

Sets the idle timeout on both the backing channel and stores it for propagation to any new backing channel.

Parameters
value:`int` or `float` | The timeout to set.

@property
callLater = (source)

A value for the `callLater` callback. This callback is used by the `twisted.protocols.policies.TimeoutMixin` to handle timeouts.

@property
factory = (source)

See Also
`_genericHTTPChannelProtocolFactory`

@property
requestFactory = (source)

A callable to use to build `IRequest` objects.

Retries the object from the current backing channel.

@property
site = (source)

A reference to the creating `twisted.web.server.Site` object.

Returns the site object from the backing channel.

@property
timeOut = (source)

The idle timeout for the backing channel.

_callLater: `callable` = (source)

A value for the `callLater` callback.

_channel: `HTTPChannel` = (source)

The object capable of behaving like a `HTTPChannel` that is backing this object. By default this is a `HTTPChannel`, but if a HTTP protocol upgrade takes place this may be a different channel object. Must implement `IProtocol`.

_factory: `HTTPFactory` = (source)

A reference to the creating `HTTPFactory` object.

_negotiatedProtocol: Either a bytestring containing the ALPN token for the negotiated protocol, or `None` if no protocol has yet been negotiated. = (source)

The protocol negotiated with ALPN or NPN, if any.

_requestFactory: `IRequest` = (source)

A callable to use to build `IRequest` objects.

_site: `twisted.web.server.Site` = (source)

A reference to the creating `twisted.web.server.Site` object.

_timeOut: `int` or `None` = (source)

A timeout value to pass to the backing channel.