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 call​Later​.setter Sets the value for the callLater callback. This callback is used by the twisted.protocols.policies.TimeoutMixin to handle timeouts.
Method data​Received An override of IProtocol.dataReceived that checks what protocol we're using.
Method factory​.setter Undocumented
Method request​Factory​.setter A callable to use to build IRequest objects.
Method site​.setter A reference to the creating twisted.web.server.Site object.
Method time​Out​.setter The idle timeout for the backing channel.
Property call​Later A value for the callLater callback. This callback is used by the twisted.protocols.policies.TimeoutMixin to handle timeouts.
Property factory
Property request​Factory A callable to use to build IRequest objects.
Property site A reference to the creating twisted.web.server.Site object.
Property time​Out The idle timeout for the backing channel.
Instance Variable _call​Later 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 IProtocol.
Instance Variable _factory A reference to the creating HTTPFactory object.
Instance Variable _negotiated​Protocol The protocol negotiated with ALPN or NPN, if any.
Instance Variable _request​Factory A callable to use to build IRequest objects.
Instance Variable _site A reference to the creating twisted.web.server.Site object.
Instance Variable _time​Out 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:callableThe 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 IRequestThe 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.SiteThe 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 floatThe 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
requestFactory = (source)

A callable to use to build IRequest objects.

Retries the object from the current backing channel.

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.
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.
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.
A reference to the creating twisted.web.server.Site object.
_timeOut: int or None = (source)
A timeout value to pass to the backing channel.