twisted.web.http._GenericHTTPChannelProtocol : API documentation

class documentation

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

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

Property	`factory`
Method	`factory.setter`	Undocumented
Property	`requestFactory`	A callable to use to build `IRequest` objects.
Method	`requestFactory.setter`	A callable to use to build `IRequest` objects.
Property	`site`	A reference to the creating `twisted.web.server.Site` object.
Method	`site.setter`	A reference to the creating `twisted.web.server.Site` object.
Property	`timeOut`	The idle timeout for the backing channel.
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.
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.
Instance Variable	`_negotiatedProtocol`	The protocol negotiated with ALPN or NPN, if any.
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 `IProtocol`.
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	`_factory`	A reference to the creating `HTTPFactory` object.
Instance Variable	`_timeOut`	A timeout value to pass to the backing channel.
Instance Variable	`_callLater`	A value for the `callLater` callback.

_negotiatedProtocol = (source)

The protocol negotiated with ALPN or NPN, if any.

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

_channel = (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.

(type: HTTPChannel)

_requestFactory = (source)

A callable to use to build IRequest objects.

(type: IRequest)

_site = (source)

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

(type: twisted.web.server.Site)

_factory = (source)

A reference to the creating HTTPFactory object.

(type: HTTPFactory)

_timeOut = (source)

A timeout value to pass to the backing channel.

(type: int or None)

_callLater = (source)

A value for the callLater callback.

(type: callable)

@property
factory = (source)

See Also _genericHTTPChannelProtocolFactory

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

Undocumented

@property
requestFactory = (source)

A callable to use to build IRequest objects.

Retries the object from the current backing channel.

@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 The new callable to use. (type: A callable returning IRequest)

@property
site = (source)

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

Returns the site object from the backing channel.

@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 The twisted.web.server.Site object to set. (type: twisted.web.server.Site)

@property
timeOut = (source)

The idle timeout for the backing channel.

@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 The timeout to set. (type: int or float)

@property
callLater = (source)

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

@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 The new callback to use. (type: callable)

def dataReceived(self, data): (source)

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

API Documentation for Twisted, generated by pydoctor 21.2.0 at 2021-02-28 21:00:42.