twisted.protocols.irc.DccSendProtocol

Package twisted :: Package protocols :: Module irc :: Class DccSendProtocol

Class DccSendProtocol

       Ephemeral --+
                   |
BaseProtocol --+   |
               |   |
        Protocol --+
                   |
                  DccSendProtocol

Protocol for an outgoing Direct Client Connection SEND.

Method Summary
	`__init__(self, file)`
	`connectionLost(self, reason)`
	`connectionMade(self)` Called when a connection is made.
	`dataReceived(self, data)` Called whenever data is received.
	`sendBlock(self)`
Inherited from Protocol
	`connectionFailed(self)` (Deprecated)
Inherited from BaseProtocol
	`makeConnection(self, transport)` Make a connection to a transport and a server.
Inherited from Ephemeral
	`__getstate__(self)`
	`__setstate__(self, state)`

Class Variable Summary
`int`	`blocksize` = 1024
`int`	`bytesSent` = 0
`int`	`completed` = 0
`int`	`connected` = 0
`NoneType`	`file` = None
Inherited from Protocol
`tuple`	`__implements__` = `(<class twisted.internet.interfaces.IPr...`
Inherited from BaseProtocol
`NoneType`	`transport` = None

Method Details

connectionMade(self)

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.

Overrides:: twisted.internet.protocol.BaseProtocol.connectionMade (inherited documentation)

dataReceived(self, data)

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.

Parameters:: data - a 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.

Overrides:: twisted.internet.protocol.Protocol.dataReceived (inherited documentation)

Class Variable Details

blocksize

Type:: int
Value:: 1024

bytesSent

Type:: int
Value:: 0

completed

Type:: int
Value:: 0

connected

Type:: int
Value:: 0

file

Type:: NoneType
Value:: None

Generated by Epydoc 2.0 on Sat May 15 20:08:37 2004

http://epydoc.sf.net