class documentation

class IRCProto(basesupport.AbstractClientMixin, irc.IRCClient): (source)

View In Hierarchy

Undocumented

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

Inherited from AbstractClientMixin:

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

Inherited from IRCClient:

Method __getstate__ Undocumented
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 away Mark this client as away.
Method back Clear the away status.
Method badMessage When I get a message that's so broken I can't use it.
Method bounce Called with information about where the client should reconnect.
Method connectionLost Called when the connection is shut down.
Method created Called with creation date information about the server, usually at logon.
Method ctcpMakeQuery Send one or more extended messages as a CTCP query.
Method ctcpMakeReply Send one or more extended messages as a CTCP reply.
Method ctcpQuery Dispatch method for any CTCP queries received.
Method ctcpQuery_ACTION Undocumented
Method ctcpQuery_CLIENTINFO A master index of what CTCP tags this client knows.
Method ctcpQuery_DCC Initiate a Direct Client Connection
Method ctcpQuery_ERRMSG Undocumented
Method ctcpQuery_FINGER Undocumented
Method ctcpQuery_PING Undocumented
Method ctcpQuery_SOURCE Undocumented
Method ctcpQuery_TIME Undocumented
Method ctcpQuery_USERINFO Undocumented
Method ctcpQuery_VERSION Undocumented
Method ctcpReply Dispatch method for any CTCP replies received.
Method ctcpReply_PING Undocumented
Method ctcpUnknownQuery Fallback handler for unrecognized CTCP queries.
Method ctcpUnknownReply Called when a fitting ctcpReply_ method is not found.
Method dataReceived Protocol.dataReceived. Translates bytes into lines, and calls lineReceived (or rawDataReceived, depending on mode.)
Method dcc_ACCEPT Undocumented
Method dcc_CHAT Undocumented
Method dcc_RESUME Undocumented
Method dcc_SEND Undocumented
Method dccAcceptResume Send a DCC ACCEPT response to clients who have requested a resume.
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 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 dccDoSend Called when I receive a DCC SEND offer from a client.
Method dccResume Send a DCC RESUME request to another user.
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 describe Strike a pose.
Method getChannelModeParams Get channel modes that require parameters for correct parsing.
Method getUserModeParams Get user 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 invite Attempt to invite user to channel
Method irc_ERR_ERRONEUSNICKNAME Called when we try to register or change to an illegal nickname.
Method irc_ERR_NICKNAMEINUSE Called when we try to register or change to a nickname that is already taken.
Method irc_ERR_PASSWDMISMATCH Called when the login was incorrect.
Method irc_KICK Called when a user is kicked from a channel.
Method irc_MODE Parse a server mode change message.
Method irc_NOTICE Called when a user gets a notice.
Method irc_PING Called when some has pinged us.
Method irc_PRIVMSG Called when we get a message.
Method irc_RPL_BOUNCE Undocumented
Method irc_RPL_CREATED 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_ISUPPORT Undocumented
Method irc_RPL_LUSERCHANNELS Undocumented
Method irc_RPL_LUSERCLIENT Undocumented
Method irc_RPL_LUSERME Undocumented
Method irc_RPL_LUSEROP Undocumented
Method irc_RPL_MOTD Undocumented
Method irc_RPL_MOTDSTART Undocumented
Method irc_RPL_MYINFO Undocumented
Method irc_RPL_NOTOPIC Undocumented
Method irc_RPL_WELCOME Called when we have received the welcome from the server.
Method irc_RPL_YOURHOST Undocumented
Method isupport Called with various information about what the server supports.
Method join Join a channel.
Method joined Called when I finish joining a channel.
Method kick Attempt to kick a user from a channel.
Method leave Leave a channel.
Method left Called when I have left a channel.
Method lineReceived Override this for when each line is received.
Method luserChannels Called with the number of channels existent on the server.
Method luserClient Called with information about the number of connections, usually at logon.
Method luserMe Called with information about the server connected to.
Method luserOp Called with the number of ops logged on to the server.
Method mode Change the modes on a user or channel.
Method modeChanged Called when users or channel's modes are changed.
Method msg Send a message to a user or channel.
Method myInfo Called with information about the server, usually at logon.
Method nickChanged Called when my nick has been changed.
Method notice Send a notice to a user.
Method ping Measure round-trip delay to another IRC client.
Method pong Called with the results of a CTCP PING query.
Method quirkyMessage This is called when I receive a message which is peculiar, but not wholly indecipherable.
Method quit Disconnect from the server
Method receivedMOTD I received a message-of-the-day banner from the server.
Method register Login to the server.
Method say Send a message to a channel
Method sendLine Sends a line to the other end of the connection.
Method signedOn Called after successfully signing on to the server.
Method startHeartbeat Start sending PING messages every IRCClient.heartbeatInterval seconds to keep the connection to the server alive during periods of no activity.
Method stopHeartbeat Stop sending PING messages to keep the connection to the server alive.
Method topic Attempt to set the topic of the given channel, or ask what it is.
Method topicUpdated In channel, user changed the topic to newTopic.
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 userRenamed A user changed their name from oldname to newname.
Method whois Retrieve user information about the given nickname.
Method yourHost Called with daemon information about the server, usually at logon.
Class Variable __pychecker__ Undocumented
Class Variable dcc_destdir Undocumented
Class Variable delimiter Undocumented
Instance Variable dcc_sessions Undocumented
Instance Variable erroneousNickFallback Default nickname assigned when an unregistered client triggers an ERR_ERRONEUSNICKNAME while trying to register with an illegal nickname.
Instance Variable fingerReply Sent in reply to a FINGER CTCP query. If None, no FINGER reply will be sent.
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.
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 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 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 supported Available ISUPPORT features on the server
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 username Supplied to the server during login as the "User name". May be None
Instance Variable versionEnv CTCP VERSION reply, environment the client is running in.
Instance Variable versionName CTCP VERSION reply, client name. If None, no VERSION reply will be sent.
Instance Variable versionNum CTCP VERSION reply, client version.
Method _createHeartbeat Create the heartbeat LoopingCall.
Method _reallySendLine Undocumented
Method _safeMaximumLineLength Estimate a safe maximum line length for the given command.
Method _sendHeartbeat Send a PING message to the IRC server as a form of keepalive.
Method _sendLine Undocumented
Class Variable _MAX_PINGRING Undocumented
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 _pings Undocumented
Instance Variable _queue Undocumented
Instance Variable _queueEmptying Undocumented
Instance Variable _registered Whether or not the user is registered. It becomes True once a welcome has been received from the server.

Inherited from LineReceiver (via IRCClient):

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 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.
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
Instance Variable _buffer Undocumented
Instance Variable _busyReceiving Undocumented

Inherited from Protocol (via IRCClient, LineReceiver):

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 IRCClient, LineReceiver, Protocol):

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

Inherited from _PauseableMixin (via IRCClient, LineReceiver):

Method pauseProducing Undocumented
Method resumeProducing Undocumented
Method stopProducing Undocumented
Instance Variable paused Undocumented
def __init__(self, account, chatui, logonDeferred=None): (source)
def action(self, username, channel, emote): (source)
Called when I see a user perform an ACTION on a channel.
def connectionMade(self): (source)

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 getGroupConversation(self, name, hide=0): (source)

Undocumented

def getPerson(self, name): (source)

Undocumented

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

Undocumented

def irc_JOIN(self, prefix, params): (source)
Called when a user joins a channel.
def irc_NICK(self, prefix, params): (source)
Called when a user changes their nickname.
def irc_PART(self, prefix, params): (source)
Called when a user leaves a channel.
def irc_QUIT(self, prefix, params): (source)
Called when a user has quit.
def irc_RPL_ENDOFNAMES(self, prefix, params): (source)

Undocumented

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_TOPIC(self, prefix, params): (source)
Called when the topic for a channel is initially reported or when it subsequently changes.
def irc_TOPIC(self, prefix, params): (source)
Someone in the channel set the topic.
def irc_unknown(self, prefix, command, params): (source)
def joinGroup(self, name): (source)

Undocumented

def kickedFrom(self, channel, kicker, message): (source)
Called when I am kicked from a channel.
def noticed(self, username, channel, message): (source)

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)
Called when I have a message from a user to me or a channel.
def setNick(self, nick): (source)
Set this client's nickname.
Parameters
nickUndocumented
nickname:strThe nickname to change to.
def userKicked(self, kickee, channel, kicker, message): (source)
Called when I observe someone else being kicked from a channel.
accountName = (source)

Undocumented

name = (source)

Undocumented

_groups: dict = (source)

Undocumented

_ingroups: dict = (source)

Undocumented

_namreplies: dict = (source)

Undocumented

_topics: dict = (source)

Undocumented