twisted.words.protocols.irc.DccChat

class documentation

class DccChat(basic.LineReceiver, styles.Ephemeral): (source)

Direct Client Connection protocol type CHAT.

DCC CHAT is really just your run o' the mill basic.LineReceiver protocol. This class only varies from that slightly, accepting either LF or CR LF for a line delimeter for incoming messages while always using CR LF for outgoing.

The lineReceived method implemented here uses the DCC connection's 'client' attribute (provided upon construction) to deliver incoming lines from the DCC chat via IRCClient's normal privmsg interface. That's something of a spoof, which you may well want to override.

Method	`__init__`	Initialize a new DCC CHAT session.
Method	`dataReceived`	Protocol.dataReceived. Translates bytes into lines, and calls lineReceived (or rawDataReceived, depending on mode.)
Method	`lineReceived`	Override this for when each line is received.
Class Variable	`delimiter`	Undocumented
Instance Variable	`buffer`	Undocumented
Instance Variable	`client`	Undocumented
Instance Variable	`queryData`	Undocumented
Instance Variable	`remoteParty`	Undocumented

Inherited from LineReceiver:

Method	`clearLineBuffer`	Clear buffered data.
Method	`lineLengthExceeded`	Called when the maximum line length has been reached. Override if it needs to be dealt with in some special way.
Method	`rawDataReceived`	Override this for when raw data is received.
Method	`sendLine`	Sends a line to the other end of the connection.
Method	`setLineMode`	Sets the line-mode of this receiver.
Method	`setRawMode`	Sets the raw mode of this receiver. Further data received will be sent to rawDataReceived rather than lineReceived.
Constant	`MAX_LENGTH`	The maximum length of a line to allow (If a sent line is longer than this, the connection is dropped). Default is 16384.
Instance Variable	`line_mode`	Undocumented
Instance Variable	`_buffer`	Undocumented
Instance Variable	`_busyReceiving`	Undocumented

Inherited from Protocol (via LineReceiver):

Method	`connectionLost`	Called when the connection is shut down.
Method	`logPrefix`	Return a prefix matching the class name, to identify log messages related to this protocol instance.
Class Variable	`factory`	Undocumented

Inherited from BaseProtocol (via LineReceiver, Protocol):

Method	`connectionMade`	Called when a connection is made.
Method	`makeConnection`	Make a connection to a transport and a server.
Instance Variable	`connected`	Undocumented
Instance Variable	`transport`	Undocumented

Inherited from _PauseableMixin (via LineReceiver):

Method	`pauseProducing`	Undocumented
Method	`resumeProducing`	Undocumented
Method	`stopProducing`	Undocumented
Instance Variable	`paused`	Undocumented

Inherited from Ephemeral:

Method	`__getstate__`	Undocumented
Method	`__reduce__`	Serialize any subclass of `Ephemeral` in a way which replaces it with `Ephemeral` itself.
Method	`__setstate__`	Undocumented
Instance Variable	`__class__`	Undocumented

def __init__(self, client, queryData=None): (source)

Initialize a new DCC CHAT session.

queryData is a 3-tuple of (fromUser, targetUserOrChannel, data) as received by the CTCP query.

(To be honest, fromUser is the only thing that's currently used here. targetUserOrChannel is potentially useful, while the 'data' argument is solely for informational purposes.)

def dataReceived(self, data): (source)

from twisted.internet.interfaces.IProtocol

overrides twisted.protocols.basic.LineReceiver.dataReceived

Protocol.dataReceived. Translates bytes into lines, and calls lineReceived (or rawDataReceived, depending on mode.)

def lineReceived(self, line): (source)

overrides twisted.protocols.basic.LineReceiver.lineReceived

Override this for when each line is received.

Parameters
line:`bytes`	The line which was received with the delimiter removed.

delimiter = (source)

overrides twisted.protocols.basic.LineReceiver.delimiter

Undocumented

buffer = (source)

Undocumented

client = (source)

Undocumented

queryData = (source)

Undocumented

remoteParty = (source)

Undocumented