Home | Trees | Index | Help |
|
---|
Package twisted :: Package protocols :: Module basic :: Class LineReceiver |
|
BaseProtocol
--+ |Protocol
--+ | LineReceiver
DccChat
,
DictClient
,
FileReceive
,
FileSend
,
Finger
,
FlashConduit
,
FTP
,
FTPClient
,
FTPFileListProtocol
,
HTTPChannel
,
HTTPClient
,
IMAP4Client
,
IMAP4Server
,
IRCClient
,
LineLogger
,
MessagesParser
,
MSNEventBase
,
NMEAReceiver
,
NNTPClient
,
NNTPServer
,
PostfixTCPMapServer
,
SMTP
,
SMTPClient
A protocol that receives lines and/or raw data, depending on mode.
In line mode, each line that's received becomes a callback to lineReceived
. In raw data mode, each chunk
of raw data becomes a callback to rawDataReceived
. The setLineMode
and setRawMode
methods switch between the two
modes.
Method Summary | |
---|---|
Clear buffered data. | |
Protocol.dataReceived. | |
Called when the maximum line length has been reached. | |
Override this for when each line is received. | |
Override this for when raw data is received. | |
Sends a line to the other end of the connection. | |
Sets the line-mode of this receiver. | |
Sets the raw mode of this receiver. | |
Inherited from Protocol | |
(Deprecated) | |
Called when the connection is shut down. | |
Inherited from BaseProtocol | |
Called when a connection is made. | |
Make a connection to a transport and a server. |
Class Variable Summary | |
---|---|
str |
_LineReceiver__buffer = ''
|
str |
delimiter : The line-ending delimiter to use. |
int |
line_mode = 1 |
int |
MAX_LENGTH : The maximum length of a line to allow (If a sent line is longer than
this, the connection is dropped). |
Inherited from Protocol | |
tuple |
__implements__ = (<class twisted.internet.interfaces.IPr...
|
Inherited from BaseProtocol | |
int |
connected = 0 |
NoneType |
transport = None |
Method Details |
---|
clearLineBuffer(self)Clear buffered data. |
dataReceived(self, data)Protocol.dataReceived. Translates bytes into lines, and calls lineReceived (or rawDataReceived, depending on mode.) |
lineLengthExceeded(self, line)Called when the maximum line length has been reached. Override if it needs to be dealt with in some special way. |
lineReceived(self, line)Override this for when each line is received. |
rawDataReceived(self, data)Override this for when raw data is received. |
sendLine(self, line)Sends a line to the other end of the connection. |
setLineMode(self, extra='')Sets the line-mode of this receiver. If you are calling this from a rawDataReceived callback, you can pass in extra unhandled data, and that data will be parsed for lines. Further data received will be sent to lineReceived rather than rawDataReceived. |
setRawMode(self)Sets the raw mode of this receiver. Further data received will be sent to rawDataReceived rather than lineReceived. |
Class Variable Details |
---|
_LineReceiver__buffer
|
delimiterThe line-ending delimiter to use. By default this is '\r\n'.
|
line_mode
|
MAX_LENGTHThe maximum length of a line to allow (If a sent line is longer than this, the connection is dropped). Default is 16384.
|
Home | Trees | Index | Help |
|
---|
Generated by Epydoc 2.0 on Sat May 15 20:08:20 2004 | http://epydoc.sf.net |