t.w.c.c.CGIChannelRequest(BaseCGIChannelRequest) : class documentation

Part of twisted.web2.channel.cgi View Source View In Hierarchy

Method __init__ Undocumented
Method writeHeaders Undocumented
Method dataReceived Called whenever data is received.
Method connectionMade Called when a connection is made.
Method connectionLost Called when the connection is shut down.

Inherited from BaseCGIChannelRequest:

Method makeRequest Undocumented
Method writeIntermediateResponse Ignore, CGI doesn't support.
Method write Undocumented
Method finish Undocumented
Method getHostInfo Undocumented
Method getRemoteHost Undocumented
Method abortConnection Undocumented
Method registerProducer Undocumented
Method unregisterProducer Undocumented
Method writeConnectionLost Notification of the write connection being closed.
Method readConnectionLost Notification of the read connection being closed.

Inherited from BaseProtocol (via BaseCGIChannelRequest, Protocol):

Method makeConnection Make a connection to a transport and a server.
def __init__(self, requestFactory, vars): (source)
def writeHeaders(self, code, headers): (source)
def dataReceived(self, data): (source)

Called whenever data is received.

Use this method to translate to a higher-level message. Usually, some callback will be made upon the receipt of each complete protocol message.
Parametersdataa string of indeterminate length. Please keep in mind that you will probably need to buffer some data, as partial (or multiple) protocol messages may be received! I recommend that unit tests for protocols call through to this method with differing chunk sizes, down to one byte at a time.
def connectionMade(self): (source)

Called when a connection is made.

This may be considered the initializer of the protocol, because it is called when the connection is completed. For clients, this is called once the connection to the server has been established; for servers, this is called after an accept() call stops blocking and a socket has been received. If you need to send any greeting or initial message, do it here.
def connectionLost(self, reason): (source)

Called when the connection is shut down.

Clear any circular references here, and any external references to this Protocol. The connection has been closed.
Parametersreason (type: twisted.python.failure.Failure )
API Documentation for Twisted, generated by pydoctor at 2011-10-27 16:12:41.