twisted.web.http._GenericHTTPChannelProtocol(proxyForInterface(IProtocol, '_channel')) class documentation

Part of twisted.web.http (View In Hierarchy)

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

Method factory 0
Method factory Undocumented
Method requestFactory 0 A callable to use to build IRequest objects.
Method requestFactory A callable to use to build IRequest objects.
Method site 0 A reference to the creating twisted.web.server.Site object.
Method site A reference to the creating twisted.web.server.Site object.
Method timeOut 0 The idle timeout for the backing channel.
Method timeOut The idle timeout for the backing channel.
Method callLater 0 A value for the callLater callback. This callback is used by the twisted.protocols.policies.TimeoutMixin to handle timeouts.
Method callLater 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. (type: Either a bytestring containing the ALPN token for the negotiated protocol, or None if no protocol has yet been negotiated.)
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. (type: HTTPChannel)
Instance Variable _requestFactory A callable to use to build IRequest objects. (type: IRequest)
Instance Variable _site A reference to the creating twisted.web.server.Site object. (type: twisted.web.server.Site)
Instance Variable _factory A reference to the creating HTTPFactory object. (type: HTTPFactory)
Instance Variable _timeOut A timeout value to pass to the backing channel. (type: int or None)
Instance Variable _callLater A value for the callLater callback. (type: callable)
_negotiatedProtocol =
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 =
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 =
A callable to use to build IRequest objects. (type: IRequest)
_site =
A reference to the creating twisted.web.server.Site object. (type: twisted.web.server.Site)
_factory =
A reference to the creating HTTPFactory object. (type: HTTPFactory)
_timeOut =
A timeout value to pass to the backing channel. (type: int or None)
_callLater =
A value for the callLater callback. (type: callable)
@property
def factory 0(self):
See Also_genericHTTPChannelProtocolFactory
@factory.setter
def factory(self, value):
Undocumented
@property
def requestFactory 0(self):

A callable to use to build IRequest objects.

Retries the object from the current backing channel.

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

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.

ParametersvalueThe new callable to use. (type: A callable returning IRequest)
@property
def site 0(self):

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

Returns the site object from the backing channel.

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

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.

ParametersvalueThe twisted.web.server.Site object to set. (type: twisted.web.server.Site)
@property
def timeOut 0(self):

The idle timeout for the backing channel.

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

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.

ParametersvalueThe timeout to set. (type: int or float)
@property
def callLater 0(self):

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):

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

ParametersvalueThe new callback to use. (type: callable)
def dataReceived(self, data):

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

API Documentation for twisted, generated by pydoctor at 2020-03-25 17:34:30.