twisted.words.im.ircsupport.IRCProto : API documentation

class documentation

class twisted.words.im.ircsupport.IRCProto(basesupport.AbstractClientMixin, irc.IRCClient): (source)

Undocumented

Method	__init__	Undocumented
Method	getGroupConversation	Undocumented
Method	getPerson	Undocumented
Method	connectionMade	Called when a connection is made.
Instance Variable	performLogin	Undocumented
Instance Variable	nickname	Undocumented
Instance Variable	password	Undocumented
Instance Variable	realname	Undocumented
Method	setNick	Set this client's nickname.
Instance Variable	name	Undocumented
Instance Variable	accountName	Undocumented
Method	kickedFrom	Called when I am kicked from a channel.
Method	userKicked	Called when I observe someone else being kicked from a channel.
Method	noticed	Called when I have a notice from a user to me or a channel.
Method	privmsg	Called when I have a message from a user to me or a channel.
Method	action	Called when I see a user perform an ACTION on a channel.
Method	irc_RPL_NAMREPLY	RPL_NAMREPLY >> NAMES #bnl << :Arlington.VA.US.Undernet.Org 353 z3p = #bnl :pSwede Dan-- SkOyg AG
Method	irc_RPL_ENDOFNAMES	Undocumented
Method	irc_RPL_TOPIC	Called when the topic for a channel is initially reported or when it subsequently changes.
Method	irc_333	Undocumented
Method	irc_TOPIC	Someone in the channel set the topic.
Method	irc_JOIN	Called when a user joins a channel.
Method	irc_PART	Called when a user leaves a channel.
Method	irc_QUIT	Called when a user has quit.
Method	irc_NICK	Called when a user changes their nickname.
Method	irc_unknown	Undocumented
Method	joinGroup	Undocumented
Instance Variable	_namreplies	Undocumented
Instance Variable	_ingroups	Undocumented
Instance Variable	_groups	Undocumented
Instance Variable	_topics	Undocumented

Inherited from AbstractClientMixin:

Instance Variable	account	Undocumented
Instance Variable	chat	Undocumented
Method	connectionLost	Undocumented
Method	unregisterAsAccountClient	Tell the chat UI that I have `signed off'.
Instance Variable	_logonDeferred	Fired when I am done logging in.
Class Variable	_protoBase	Undocumented

Inherited from IRCClient:

Instance Variable	username	Supplied to the server during login as the "User name". May be `None`
Instance Variable	userinfo	Sent in reply to a `USERINFO` CTCP query. If `None`, no USERINFO reply will be sent. "This is used to transmit a string which is settable by the user (and never should be set by the client)."
Instance Variable	fingerReply	Sent in reply to a `FINGER` CTCP query. If `None`, no FINGER reply will be sent.
Instance Variable	versionName	CTCP VERSION reply, client name. If `None`, no VERSION reply will be sent.
Instance Variable	versionNum	CTCP VERSION reply, client version.
Instance Variable	versionEnv	CTCP VERSION reply, environment the client is running in.
Instance Variable	sourceURL	CTCP SOURCE reply, a URL where the source code of this client may be found. If `None`, no SOURCE reply will be sent.
Instance Variable	lineRate	Minimum delay between lines sent to the server. If `None`, no delay will be imposed.
Instance Variable	motd	Either `None` or, between receipt of RPL_MOTDSTART and RPL_ENDOFMOTD, a `list` of `str`, each of which is the content of an RPL_MOTD message.
Instance Variable	erroneousNickFallback	Default nickname assigned when an unregistered client triggers an `ERR_ERRONEUSNICKNAME` while trying to register with an illegal nickname.
Instance Variable	supported	Available ISUPPORT features on the server
Instance Variable	hostname	Host name of the IRC server the client is connected to. Initially the host name is `None` and later is set to the host name from which the RPL_WELCOME message is received.
Instance Variable	heartbeatInterval	Interval, in seconds, to send PING messages to the server as a form of keepalive, defaults to 120 seconds. Use `None` to disable the heartbeat.
Class Variable	dcc_destdir	Undocumented
Instance Variable	dcc_sessions	Undocumented
Class Variable	delimiter	Undocumented
Class Variable	__pychecker__	Undocumented
Method	sendLine	Sends a line to the other end of the connection.
Method	connectionLost	Called when the connection is shut down.
Method	stopHeartbeat	Stop sending PING messages to keep the connection to the server alive.
Method	startHeartbeat	Start sending PING messages every `IRCClient.heartbeatInterval` seconds to keep the connection to the server alive during periods of no activity.
Method	created	Called with creation date information about the server, usually at logon.
Method	yourHost	Called with daemon information about the server, usually at logon.
Method	myInfo	Called with information about the server, usually at logon.
Method	luserClient	Called with information about the number of connections, usually at logon.
Method	bounce	Called with information about where the client should reconnect.
Method	isupport	Called with various information about what the server supports.
Method	luserChannels	Called with the number of channels existent on the server.
Method	luserOp	Called with the number of ops logged on to the server.
Method	luserMe	Called with information about the server connected to.
Method	joined	Called when I finish joining a channel.
Method	left	Called when I have left a channel.
Method	modeChanged	Called when users or channel's modes are changed.
Method	pong	Called with the results of a CTCP PING query.
Method	signedOn	Called after successfully signing on to the server.
Method	nickChanged	Called when my nick has been changed.
Method	userJoined	Called when I see another user joining a channel.
Method	userLeft	Called when I see another user leaving a channel.
Method	userQuit	Called when I see another user disconnect from the network.
Method	topicUpdated	In channel, user changed the topic to newTopic.
Method	userRenamed	A user changed their name from oldname to newname.
Method	receivedMOTD	I received a message-of-the-day banner from the server.
Method	join	Join a channel.
Method	leave	Leave a channel.
Method	kick	Attempt to kick a user from a channel.
Method	invite	Attempt to invite user to channel
Method	topic	Attempt to set the topic of the given channel, or ask what it is.
Method	mode	Change the modes on a user or channel.
Method	say	Send a message to a channel
Method	msg	Send a message to a user or channel.
Method	notice	Send a notice to a user.
Method	away	Mark this client as away.
Method	back	Clear the away status.
Method	whois	Retrieve user information about the given nickname.
Method	register	Login to the server.
Method	quit	Disconnect from the server
Method	describe	Strike a pose.
Method	ping	Measure round-trip delay to another IRC client.
Method	dccSend	This is supposed to send a user a file directly. This generally doesn't work on any client, and this method is included only for backwards compatibility and completeness.
Method	dccResume	Send a DCC RESUME request to another user.
Method	dccAcceptResume	Send a DCC ACCEPT response to clients who have requested a resume.
Method	irc_ERR_NICKNAMEINUSE	Called when we try to register or change to a nickname that is already taken.
Method	alterCollidedNick	Generate an altered version of a nickname that caused a collision in an effort to create an unused related name for subsequent registration.
Method	irc_ERR_ERRONEUSNICKNAME	Called when we try to register or change to an illegal nickname.
Method	irc_ERR_PASSWDMISMATCH	Called when the login was incorrect.
Method	irc_RPL_WELCOME	Called when we have received the welcome from the server.
Method	irc_MODE	Parse a server mode change message.
Method	irc_PING	Called when some has pinged us.
Method	irc_PRIVMSG	Called when we get a message.
Method	irc_NOTICE	Called when a user gets a notice.
Method	irc_KICK	Called when a user is kicked from a channel.
Method	irc_RPL_NOTOPIC	Undocumented
Method	irc_RPL_MOTDSTART	Undocumented
Method	irc_RPL_MOTD	Undocumented
Method	irc_RPL_ENDOFMOTD	RPL_ENDOFMOTD indicates the end of the message of the day messages. Deliver the accumulated lines to `receivedMOTD`.
Method	irc_RPL_CREATED	Undocumented
Method	irc_RPL_YOURHOST	Undocumented
Method	irc_RPL_MYINFO	Undocumented
Method	irc_RPL_BOUNCE	Undocumented
Method	irc_RPL_ISUPPORT	Undocumented
Method	irc_RPL_LUSERCLIENT	Undocumented
Method	irc_RPL_LUSEROP	Undocumented
Method	irc_RPL_LUSERCHANNELS	Undocumented
Method	irc_RPL_LUSERME	Undocumented
Method	ctcpQuery	Dispatch method for any CTCP queries received.
Method	ctcpUnknownQuery	Fallback handler for unrecognized CTCP queries.
Method	ctcpQuery_ACTION	Undocumented
Method	ctcpQuery_PING	Undocumented
Method	ctcpQuery_FINGER	Undocumented
Method	ctcpQuery_VERSION	Undocumented
Method	ctcpQuery_SOURCE	Undocumented
Method	ctcpQuery_USERINFO	Undocumented
Method	ctcpQuery_CLIENTINFO	A master index of what CTCP tags this client knows.
Method	ctcpQuery_ERRMSG	Undocumented
Method	ctcpQuery_TIME	Undocumented
Method	ctcpQuery_DCC	Initiate a Direct Client Connection
Method	dcc_SEND	Undocumented
Method	dcc_ACCEPT	Undocumented
Method	dcc_RESUME	Undocumented
Method	dcc_CHAT	Undocumented
Method	dccDoSend	Called when I receive a DCC SEND offer from a client.
Method	dccDoResume	Called when a client is trying to resume an offered file via DCC send. It should be either replied to with a DCC ACCEPT or ignored (default).
Method	dccDoAcceptResume	Called when a client has verified and accepted a DCC resume request made by us. By default it will do nothing.
Method	dccDoChat	Undocumented
Method	ctcpMakeReply	Send one or more `extended messages` as a CTCP reply.
Method	ctcpMakeQuery	Send one or more `extended messages` as a CTCP query.
Method	ctcpReply	Dispatch method for any CTCP replies received.
Method	ctcpReply_PING	Undocumented
Method	ctcpUnknownReply	Called when a fitting ctcpReply_ method is not found.
Method	badMessage	When I get a message that's so broken I can't use it.
Method	quirkyMessage	This is called when I receive a message which is peculiar, but not wholly indecipherable.
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.
Method	getUserModeParams	Get user modes that require parameters for correct parsing.
Method	getChannelModeParams	Get channel modes that require parameters for correct parsing.
Method	handleCommand	Determine the function to call for the given command and call it with the given arguments.
Method	__getstate__	Undocumented
Instance Variable	_registered	Whether or not the user is registered. It becomes True once a welcome has been received from the server.
Instance Variable	_attemptedNick	The nickname that will try to get registered. It may change if it is illegal or already taken. `nickname` becomes the `_attemptedNick` that is successfully registered.
Instance Variable	_heartbeat	Looping call to perform the keepalive by calling `IRCClient._sendHeartbeat` every `heartbeatInterval` seconds, or `None` if there is no heartbeat.
Instance Variable	_queue	Undocumented
Instance Variable	_queueEmptying	Undocumented
Method	_reallySendLine	Undocumented
Method	_sendLine	Undocumented
Method	_createHeartbeat	Create the heartbeat `LoopingCall`.
Method	_sendHeartbeat	Send a PING message to the IRC server as a form of keepalive.
Method	_safeMaximumLineLength	Estimate a safe maximum line length for the given command.
Instance Variable	_pings	Undocumented
Class Variable	_MAX_PINGRING	Undocumented

Inherited from LineReceiver (via IRCClient):

Class Variable	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
Method	clearLineBuffer	Clear buffered data.
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.
Method	rawDataReceived	Override this for when raw data is received.
Method	lineLengthExceeded	Called when the maximum line length has been reached. Override if it needs to be dealt with in some special way.
Instance Variable	_buffer	Undocumented
Instance Variable	_busyReceiving	Undocumented

Inherited from Protocol (via IRCClient, LineReceiver):

Class Variable	factory	Undocumented
Method	logPrefix	Return a prefix matching the class name, to identify log messages related to this protocol instance.

Inherited from BaseProtocol (via IRCClient, LineReceiver, Protocol):

Instance Variable	connected	Undocumented
Instance Variable	transport	Undocumented
Method	makeConnection	Make a connection to a transport and a server.

Inherited from _PauseableMixin (via IRCClient, LineReceiver):

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

def __init__(self, account, chatui, logonDeferred=None): (source)

overrides twisted.words.im.basesupport.AbstractClientMixin.__init__

Undocumented

_namreplies = (source)

Undocumented

(type: dict)

_ingroups = (source)

Undocumented

(type: dict)

_groups = (source)

Undocumented

(type: dict)

_topics = (source)

Undocumented

(type: dict)

def getGroupConversation(self, name, hide=0): (source)

Undocumented

def getPerson(self, name): (source)

Undocumented

def connectionMade(self): (source)

from twisted.internet.interfaces.IProtocol

overrides twisted.words.im.basesupport.AbstractClientMixin.connectionMade

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.

performLogin = (source)

overrides twisted.words.protocols.irc.IRCClient.performLogin

Undocumented

(type: bool)

nickname = (source)

overrides twisted.words.protocols.irc.IRCClient.nickname

Undocumented

password = (source)

overrides twisted.words.protocols.irc.IRCClient.password

Undocumented

realname = (source)

overrides twisted.words.protocols.irc.IRCClient.realname

Undocumented

(type: str)

def setNick(self, nick): (source)

overrides twisted.words.protocols.irc.IRCClient.setNick

Set this client's nickname.

Parameters	nick	Undocumented
	nickname	The nickname to change to. (type: `str`)

name = (source)

Undocumented

accountName = (source)

Undocumented

def kickedFrom(self, channel, kicker, message): (source)

overrides twisted.words.protocols.irc.IRCClient.kickedFrom

Called when I am kicked from a channel.

def userKicked(self, kickee, channel, kicker, message): (source)

overrides twisted.words.protocols.irc.IRCClient.userKicked

Called when I observe someone else being kicked from a channel.

def noticed(self, username, channel, message): (source)

overrides twisted.words.protocols.irc.IRCClient.noticed

Called when I have a notice from a user to me or a channel.

If the client makes any automated replies, it must not do so in response to a NOTICE message, per the RFC:

    The difference between NOTICE and PRIVMSG is that
    automatic replies MUST NEVER be sent in response to a
    NOTICE message. [...] The object of this rule is to avoid
    loops between clients automatically sending something in
    response to something it received.

def privmsg(self, username, channel, message, metadata=None): (source)

overrides twisted.words.protocols.irc.IRCClient.privmsg

Called when I have a message from a user to me or a channel.

def action(self, username, channel, emote): (source)

overrides twisted.words.protocols.irc.IRCClient.action

Called when I see a user perform an ACTION on a channel.

def irc_RPL_NAMREPLY(self, prefix, params): (source)

RPL_NAMREPLY >> NAMES #bnl << :Arlington.VA.US.Undernet.Org 353 z3p = #bnl :pSwede Dan-- SkOyg AG

def irc_RPL_ENDOFNAMES(self, prefix, params): (source)

Undocumented

def irc_RPL_TOPIC(self, prefix, params): (source)

overrides twisted.words.protocols.irc.IRCClient.irc_RPL_TOPIC