Known subclasses: twisted.words.im.ircsupport.IRCProto

Internet Relay Chat client protocol, with sprinkles.

In addition to providing an interface for an IRC client protocol, this class also contains reasonable implementations of many common CTCP methods.

TODO

Limit the length of messages sent (because the IRC server probably does).
Add flood protection/rate limiting for my CTCP replies.
NickServ cooperation. (a mix-in?)

Instance Variable	nickname	Nickname the client will use.
Instance Variable	password	Password used to log on to the server. May be `None`.
Instance Variable	realname	Supplied to the server during login as the "Real name" or "ircname". May be `None`.
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. (type: Callable or String)
Instance Variable	versionName	CTCP VERSION reply, client name. If `None`, no VERSION reply will be sent. (type: `str`, or None.)
Instance Variable	versionNum	CTCP VERSION reply, client version. (type: `str`, or None.)
Instance Variable	versionEnv	CTCP VERSION reply, environment the client is running in. (type: `str`, or None.)
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. (type: Number of Seconds.)
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. (type: `str`)
Instance Variable	supported	Available ISUPPORT features on the server (type: `ServerSupportedFeatures`)
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. (type: `str`)
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. (type: `float`)
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	privmsg	Called when I have a message from a user to me or a channel.
Method	joined	Called when I finish joining a channel.
Method	left	Called when I have left a channel.
Method	noticed	Called when I have a notice from a user to me or 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	kickedFrom	Called when I am kicked from a channel.
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	userKicked	Called when I observe someone else being kicked from a channel.
Method	action	Called when I see a user perform an ACTION on a channel.
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	setNick	Set this client's nickname.
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_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_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_NICK	Called when a user changes their nickname.
Method	irc_KICK	Called when a user is kicked from a channel.
Method	irc_TOPIC	Someone in the channel set the topic.
Method	irc_RPL_TOPIC	Called when the topic for a channel is initially reported or when it subsequently changes.
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	irc_unknown	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	connectionMade	Called when a connection is made.
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. (type: `bool`)
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. (type: `str`)
Instance Variable	_heartbeat	Looping call to perform the keepalive by calling `IRCClient._sendHeartbeat` every `heartbeatInterval` seconds, or `None` if there is no heartbeat. (type: `task.LoopingCall`)
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.

Inherited from LineReceiver:

Class Variable	delimiter	The line-ending delimiter to use. By default this is `b'\r\n'`.
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.
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.

Inherited from Protocol (via LineReceiver):

Method

logPrefix

Return a prefix matching the class name, to identify log messages related to this protocol instance.

Inherited from BaseProtocol (via LineReceiver, Protocol):

Method

makeConnection

Make a connection to a transport and a server.

Inherited from _PauseableMixin (via LineReceiver):

Method	pauseProducing	Undocumented
Method	resumeProducing	Undocumented
Method	stopProducing	Undocumented

nickname =

Nickname the client will use.

password =

Password used to log on to the server. May be None.

realname =

Supplied to the server during login as the "Real name" or "ircname". May be None.

username =

Supplied to the server during login as the "User name". May be None

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)."

fingerReply =

Sent in reply to a FINGER CTCP query. If None, no FINGER reply will be sent. (type: Callable or String)

versionName =

CTCP VERSION reply, client name. If None, no VERSION reply will be sent. (type: str, or None.)

versionNum =

CTCP VERSION reply, client version. (type: str, or None.)

versionEnv =

CTCP VERSION reply, environment the client is running in. (type: str, or None.)

sourceURL =

CTCP SOURCE reply, a URL where the source code of this client may be found. If None, no SOURCE reply will be sent.

lineRate =

Minimum delay between lines sent to the server. If None, no delay will be imposed. (type: Number of Seconds.)

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.

erroneousNickFallback =

Default nickname assigned when an unregistered client triggers an ERR_ERRONEUSNICKNAME while trying to register with an illegal nickname. (type: str)

_registered =

Whether or not the user is registered. It becomes True once a welcome has been received from the server. (type: bool)

_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. (type: str)

supported =

Available ISUPPORT features on the server (type: ServerSupportedFeatures)

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. (type: str)

_heartbeat =

Looping call to perform the keepalive by calling IRCClient._sendHeartbeat every heartbeatInterval seconds, or None if there is no heartbeat. (type: task.LoopingCall)

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. (type: float)

def _reallySendLine(self, line): (source)

Undocumented

def sendLine(self, line): (source)

overrides twisted.protocols.basic.LineReceiver.sendLine

Sends a line to the other end of the connection.

Parameters line The line to send, not including the delimiter. (type: bytes)

def _sendLine(self): (source)

Undocumented

def connectionLost(self, reason): (source)

from twisted.internet.interfaces.IProtocol

overrides twisted.internet.protocol.Protocol.connectionLost

Called when the connection is shut down.

Clear any circular references here, and any external references to this Protocol. The connection has been closed.

def _createHeartbeat(self): (source)

Create the heartbeat LoopingCall.

def _sendHeartbeat(self): (source)

Send a PING message to the IRC server as a form of keepalive.

def stopHeartbeat(self): (source)

Stop sending PING messages to keep the connection to the server alive.

Present Since 11.1

def startHeartbeat(self): (source)

Start sending PING messages every IRCClient.heartbeatInterval seconds to keep the connection to the server alive during periods of no activity.

Present Since 11.1

def created(self, when): (source)

Called with creation date information about the server, usually at logon.

Parameters when A string describing when the server was created, probably. (type: str)

def yourHost(self, info): (source)

Called with daemon information about the server, usually at logon.

Parameters when A string describing what software the server is running, probably.

def myInfo(self, servername, version, umodes, cmodes): (source)

Called with information about the server, usually at logon.

Parameters	servername	The hostname of this server. (type: `str`)
	version	A description of what software this server runs. (type: `str`)
	umodes	All the available user modes. (type: `str`)
	cmodes	All the available channel modes. (type: `str`)

def luserClient(self, info): (source)

Called with information about the number of connections, usually at logon.

Parameters info A description of the number of clients and servers connected to the network, probably. (type: str)

def bounce(self, info): (source)

Called with information about where the client should reconnect.

Parameters info A plaintext description of the address that should be connected to. (type: str)

def isupport(self, options): (source)

Called with various information about what the server supports.

Parameters options Descriptions of features or limits of the server, possibly in the form "NAME=VALUE". (type: list of str)

def luserChannels(self, channels): (source)

Called with the number of channels existent on the server.

def luserOp(self, ops): (source)

Called with the number of ops logged on to the server.

def luserMe(self, info): (source)

Called with information about the server connected to.

Parameters info A plaintext string describing the number of users and servers connected to this server. (type: str)

def privmsg(self, user, channel, message): (source)

overridden in twisted.words.im.ircsupport.IRCProto

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

def joined(self, channel): (source)

Called when I finish joining a channel.

channel has the starting character ('#', '&', '!', or '+') intact.

def left(self, channel): (source)

Called when I have left a channel.

channel has the starting character ('#', '&', '!', or '+') intact.

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

overridden in twisted.words.im.ircsupport.IRCProto

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 modeChanged(self, user, channel, set, modes, args): (source)

Called when users or channel's modes are changed.

Parameters	user	The user and hostmask which instigated this change. (type: `str`)
	channel	The channel where the modes are changed. If args is empty the channel for which the modes are changing. If the changes are at server level it could be equal to `user`. (type: `str`)
	set	True if the mode(s) is being added, False if it is being removed. If some modes are added and others removed at the same time this function will be called twice, the first time with all the added modes, the second with the removed ones. (To change this behaviour override the irc_MODE method) (type: `bool` or `int`)
	modes	The mode or modes which are being changed. (type: `str`)
	args	Any additional information required for the mode change. (type: `tuple`)

def pong(self, user, secs): (source)

Called with the results of a CTCP PING query.

def signedOn(self): (source)

Called after successfully signing on to the server.

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

overridden in twisted.words.im.ircsupport.IRCProto

Called when I am kicked from a channel.

def nickChanged(self, nick): (source)

Called when my nick has been changed.

def userJoined(self, user, channel): (source)

Called when I see another user joining a channel.

def userLeft(self, user, channel): (source)

Called when I see another user leaving a channel.

def userQuit(self, user, quitMessage): (source)

Called when I see another user disconnect from the network.

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

overridden in twisted.words.im.ircsupport.IRCProto

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

def action(self, user, channel, data): (source)

overridden in twisted.words.im.ircsupport.IRCProto

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

def topicUpdated(self, user, channel, newTopic): (source)

In channel, user changed the topic to newTopic.

Also called when first joining a channel.

def userRenamed(self, oldname, newname): (source)

A user changed their name from oldname to newname.

def receivedMOTD(self, motd): (source)

I received a message-of-the-day banner from the server.

motd is a list of strings, where each string was sent as a separate message from the server. To display, you might want to use:

   '\n'.join(motd)

to get a nicely formatted string.

def join(self, channel, key=None): (source)

Join a channel.

Parameters	channel	The name of the channel to join. If it has no prefix, `'#'` will be prepended to it. (type: `str`)
	key	If specified, the key used to join the channel. (type: `str`)

def leave(self, channel, reason=None): (source)

Leave a channel.

Parameters	channel	The name of the channel to leave. If it has no prefix, `'#'` will be prepended to it. (type: `str`)
	reason	If given, the reason for leaving. (type: `str`)

def kick(self, channel, user, reason=None): (source)

Attempt to kick a user from a channel.

Parameters	channel	The name of the channel to kick the user from. If it has no prefix, `'#'` will be prepended to it. (type: `str`)
	user	The nick of the user to kick. (type: `str`)
	reason	If given, the reason for kicking the user. (type: `str`)

def invite(self, user, channel): (source)

Attempt to invite user to channel

Parameters	user	The user to invite (type: `str`)
	channel	The channel to invite the user too (type: `str`)
Present Since	11.0

def topic(self, channel, topic=None): (source)

Attempt to set the topic of the given channel, or ask what it is.

If topic is None, then I sent a topic query instead of trying to set the topic. The server should respond with a TOPIC message containing the current topic of the given channel.

Parameters	channel	The name of the channel to change the topic on. If it has no prefix, `'#'` will be prepended to it. (type: `str`)
	topic	If specified, what to set the topic to. (type: `str`)

def mode(self, chan, set, modes, limit=None, user=None, mask=None): (source)

Change the modes on a user or channel.

The limit, user, and mask parameters are mutually exclusive.

Parameters	chan	The name of the channel to operate on. (type: `str`)
	set	True to give the user or channel permissions and False to remove them. (type: `bool`)
	modes	The mode flags to set on the user or channel. (type: `str`)
	limit	In conjunction with the `'l'` mode flag, limits the number of users on the channel. (type: `int`)
	user	The user to change the mode on. (type: `str`)
	mask	In conjunction with the `'b'` mode flag, sets a mask of users to be banned from the channel. (type: `str`)

def say(self, channel, message, length=None): (source)

Send a message to a channel

Parameters	channel	The channel to say the message on. If it has no prefix, `'#'` will be prepended to it. (type: `str`)
	message	The message to say. (type: `str`)
	length	The maximum number of octets to send at a time. This has the effect of turning a single call to `msg()` into multiple commands to the server. This is useful when long messages may be sent that would otherwise cause the server to kick us off or silently truncate the text we are sending. If None is passed, the entire message is always send in one command. (type: `int`)

def _safeMaximumLineLength(self, command): (source)

Estimate a safe maximum line length for the given command.

This is done by assuming the maximum values for nickname length, realname and hostname combined with the command that needs to be sent and some guessing. A theoretical maximum value is used because it is possible that our nickname, username or hostname changes (on the server side) while the length is still being calculated.

def msg(self, user, message, length=None): (source)

Send a message to a user or channel.

The message will be split into multiple commands to the server if:

The message contains any newline characters
Any span between newline characters is longer than the given line-length.

Parameters	user	Username or channel name to which to direct the message. (type: `str`)
	message	Text to send. (type: `str`)
	length	Maximum number of octets to send in a single command, including the IRC protocol framing. If `None` is given then `IRCClient._safeMaximumLineLength` is used to determine a value. (type: `int`)

def notice(self, user, message): (source)

Send a notice to a user.

Notices are like normal message, but should never get automated replies.

Parameters	user	The user to send a notice to. (type: `str`)
	message	The contents of the notice to send. (type: `str`)

def away(self, message=''): (source)

Mark this client as away.

Parameters message If specified, the away message. (type: str)

def back(self): (source)

Clear the away status.

def whois(self, nickname, server=None): (source)

Retrieve user information about the given nickname.

Parameters	nickname	The nickname about which to retrieve information. (type: `str`)
Present Since	8.2

def register(self, nickname, hostname='foo', servername='bar'): (source)

Parameters	nickname	The nickname to register. (type: `str`)
	hostname	If specified, the hostname to logon as. (type: `str`)
	servername	If specified, the servername to logon as. (type: `str`)

def setNick(self, nickname): (source)

overridden in twisted.words.im.ircsupport.IRCProto

Set this client's nickname.

Parameters nickname The nickname to change to. (type: str)

def quit(self, message=''): (source)

Disconnect from the server

Parameters message If specified, the message to give when quitting the server. (type: str)

def describe(self, channel, action): (source)

Strike a pose.

Parameters	channel	The name of the channel to have an action on. If it has no prefix, it is sent to the user of that name. (type: `str`)
	action	The action to preform. (type: `str`)
Present Since	9.0

def ping(self, user, text=None): (source)

Measure round-trip delay to another IRC client.

def dccSend(self, user, file): (source)

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.

Parameters	user	`str` representing the user
	file	an open file (unknown, since this is not implemented)

def dccResume(self, user, fileName, port, resumePos): (source)

Send a DCC RESUME request to another user.

def dccAcceptResume(self, user, fileName, port, resumePos): (source)

Send a DCC ACCEPT response to clients who have requested a resume.

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

Called when we try to register or change to a nickname that is already taken.

def alterCollidedNick(self, nickname): (source)

Generate an altered version of a nickname that caused a collision in an effort to create an unused related name for subsequent registration.

Parameters	nickname	The nickname a user is attempting to register. (type: `str`)
Returns	A string that is in some way different from the nickname. (type: `str`)

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

Called when we try to register or change to an illegal nickname.

The server should send this reply when the nickname contains any disallowed characters. The bot will stall, waiting for RPL_WELCOME, if we don't handle this during sign-on.

Note The method uses the spelling erroneus, as it appears in the RFC, section 6.1.

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

Called when the login was incorrect.

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

Called when we have received the welcome from the server.

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

overridden in twisted.words.im.ircsupport.IRCProto

Called when a user joins a channel.

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

overridden in twisted.words.im.ircsupport.IRCProto

Called when a user leaves a channel.

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

overridden in twisted.words.im.ircsupport.IRCProto

Called when a user has quit.

def irc_MODE(self, user, params): (source)

Parse a server mode change message.

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

Called when some has pinged us.

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

Called when we get a message.

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

Called when a user gets a notice.

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

overridden in twisted.words.im.ircsupport.IRCProto

Called when a user changes their nickname.

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

Called when a user is kicked from a channel.

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

overridden in twisted.words.im.ircsupport.IRCProto

Someone in the channel set the topic.

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

overridden in twisted.words.im.ircsupport.IRCProto

Called when the topic for a channel is initially reported or when it subsequently changes.

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

Undocumented

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

Undocumented

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

Undocumented

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

RPL_ENDOFMOTD indicates the end of the message of the day messages. Deliver the accumulated lines to receivedMOTD.

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

def irc_unknown(self, prefix, command, params): (source)

overridden in twisted.words.im.ircsupport.IRCProto

Undocumented

def ctcpQuery(self, user, channel, messages): (source)

Dispatch method for any CTCP queries received.

Duplicated CTCP queries are ignored and no dispatch is made. Unrecognized CTCP queries invoke IRCClient.ctcpUnknownQuery.

def ctcpUnknownQuery(self, user, channel, tag, data): (source)

Fallback handler for unrecognized CTCP queries.

No CTCP ERRMSG reply is made to remove a potential denial of service avenue.

def ctcpQuery_ACTION(self, user, channel, data): (source)

Undocumented

def ctcpQuery_PING(self, user, channel, data): (source)

Undocumented

def ctcpQuery_FINGER(self, user, channel, data): (source)

Undocumented

def ctcpQuery_VERSION(self, user, channel, data): (source)

Undocumented

def ctcpQuery_SOURCE(self, user, channel, data): (source)

Undocumented

def ctcpQuery_USERINFO(self, user, channel, data): (source)

Undocumented

def ctcpQuery_CLIENTINFO(self, user, channel, data): (source)

A master index of what CTCP tags this client knows.

If no arguments are provided, respond with a list of known tags, sorted in alphabetical order. If an argument is provided, provide human-readable help on the usage of that tag.

def ctcpQuery_ERRMSG(self, user, channel, data): (source)

Undocumented

def ctcpQuery_TIME(self, user, channel, data): (source)

Undocumented

def ctcpQuery_DCC(self, user, channel, data): (source)

Initiate a Direct Client Connection

Parameters	user	The hostmask of the user/client. (type: `bytes`)
	channel	The name of the IRC channel. (type: `bytes`)
	data	The DCC request message. (type: `bytes`)

def dcc_SEND(self, user, channel, data): (source)

Undocumented

def dcc_ACCEPT(self, user, channel, data): (source)

Undocumented

def dcc_RESUME(self, user, channel, data): (source)

Undocumented

def dcc_CHAT(self, user, channel, data): (source)

Undocumented

def dccDoSend(self, user, address, port, fileName, size, data): (source)

Called when I receive a DCC SEND offer from a client.

By default, I do nothing here.

Parameters	user	The hostmask of the requesting user. (type: `bytes`)
	address	The IP address of the requesting user. (type: `bytes`)
	port	An integer representing the port of the requesting user. (type: `int`)
	fileName	The name of the file to be transferred. (type: `bytes`)
	size	The size of the file to be transferred, which may be `-1` if the size of the file was not specified in the DCC SEND request. (type: `int`)
	data	A 3-list of [fileName, address, port]. (type: `list`)

def dccDoResume(self, user, file, port, resumePos): (source)

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).

Parameters	user	The hostmask of the user who wants to resume the transfer of a file previously offered via DCC send. (type: `bytes`)
	file	The name of the file to resume the transfer of. (type: `bytes`)
	port	An integer representing the port of the requesting user. (type: `int`)
	resumePos	The position in the file from where the transfer should resume. (type: `int`)

def dccDoAcceptResume(self, user, file, port, resumePos): (source)

Called when a client has verified and accepted a DCC resume request made by us. By default it will do nothing.

Parameters	user	The hostmask of the user who has accepted the DCC resume request. (type: `bytes`)
	file	The name of the file to resume the transfer of. (type: `bytes`)
	port	An integer representing the port of the accepting user. (type: `int`)
	resumePos	The position in the file from where the transfer should resume. (type: `int`)

def dccDoChat(self, user, channel, address, port, data): (source)

Undocumented

def ctcpMakeReply(self, user, messages): (source)

Send one or more extended messages as a CTCP reply.

def ctcpMakeQuery(self, user, messages): (source)

Send one or more extended messages as a CTCP query.

def ctcpReply(self, user, channel, messages): (source)

Dispatch method for any CTCP replies received.

def ctcpReply_PING(self, user, channel, data): (source)

Undocumented

def ctcpUnknownReply(self, user, channel, tag, data): (source)

Called when a fitting ctcpReply_ method is not found.

Parameters	user	The hostmask of the user. (type: `bytes`)
	channel	The name of the IRC channel. (type: `bytes`)
	tag	The CTCP request tag for which no fitting method is found. (type: `bytes`)
	data	The CTCP message. (type: `bytes`)

def badMessage(self, line, excType, excValue, tb): (source)

When I get a message that's so broken I can't use it.

Parameters	line	The indecipherable message. (type: `bytes`)
	excType	The exception type of the exception raised by the message. (type: `type`)
	excValue	The exception parameter of excType or its associated value(the second argument to `raise`). (type: `BaseException`)
	tb	The Traceback as a traceback object. (type: `traceback`)

def quirkyMessage(self, s): (source)

This is called when I receive a message which is peculiar, but not wholly indecipherable.

Parameters s The peculiar message. (type: bytes)

def connectionMade(self): (source)

from twisted.internet.interfaces.IProtocol

overrides twisted.internet.protocol.BaseProtocol.connectionMade

overridden in twisted.words.im.ircsupport.IRCProto

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 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 The line which was received with the delimiter removed. (type: bytes)

def getUserModeParams(self): (source)

Get user modes that require parameters for correct parsing.

Returns (type: [str, str] @return [add, remove])

def getChannelModeParams(self): (source)

Get channel modes that require parameters for correct parsing.

Returns (type: [str, str] @return [add, remove])

def handleCommand(self, command, prefix, params): (source)

Determine the function to call for the given command and call it with the given arguments.

Parameters	command	The IRC command to determine the function for. (type: `bytes`)
	prefix	The prefix of the IRC message (as returned by `parsemsg`). (type: `bytes`)
	params	A list of parameters to call the function with. (type: `list`)

def __getstate__(self): (source)

Undocumented

API Documentation for Twisted, generated by pydoctor at 2018-10-15 19:29:43.

twisted.words.protocols.irc.IRCClient(basic.LineReceiver) class documentation

TODO

`twisted.words.protocols.irc.IRCClient(basic.LineReceiver)` class documentation