Class t.w.i.i.IRCProto(basesupport.AbstractClientMixin, irc.IRCClient):

Part of twisted.words.im.ircsupport View Source View In Hierarchy

Undocumented
Line # Kind Name Docs
86 Method __init__ Undocumented
94 Method getGroupConversation Undocumented
99 Method getPerson Undocumented
102 Method connectionMade Called when a connection is made.
121 Method setNick Undocumented
126 Method kickedFrom Called when I am kicked from a channel.
133 Method userKicked Called when I observe someone else being kicked from a channel.
136 Method noticed Called when I have a notice from a user to me or a channel.
139 Method privmsg Called when I have a message from a user to me or a channel.
150 Method action Called when I see a user perform an ACTION on a channel.
160 Method irc_RPL_NAMREPLY RPL_NAMREPLY
180 Method irc_RPL_ENDOFNAMES Undocumented
185 Method irc_RPL_TOPIC I just joined the channel, and the server is telling me the current topic.
188 Method irc_333 Undocumented
193 Method irc_TOPIC Someone in the channel set the topic.
199 Method irc_JOIN Undocumented
209 Method irc_PART Undocumented
219 Method irc_QUIT Undocumented
228 Method irc_NICK Undocumented
239 Method irc_unknown Undocumented
243 Method joinGroup Undocumented

Inherited from AbstractClientMixin:

Line # Kind Name Docs
110 Method connectionLost Called when the connection is shut down.
115 Method unregisterAsAccountClient Tell the chat UI that I have `signed off'.

Inherited from IRCClient:

Line # Kind Name Docs
567 Method _reallySendLine Undocumented
570 Method sendLine Undocumented
578 Method _sendLine Undocumented
593 Method created Called with creation date information about the server, usually at logon.
600 Method yourHost Called with daemon information about the server, usually at logon.
607 Method myInfo Called with information about the server, usually at logon.
623 Method luserClient Called with information about the number of connections, usually at logon.
631 Method bounce Called with information about where the client should reconnect.
639 Method isupport Called with various information about what the server supports.
647 Method luserChannels Called with the number of channels existant on the server.
653 Method luserOp Called with the number of ops logged on to the server.
659 Method luserMe Called with information about the server connected to.
674 Method joined Called when I finish joining a channel.
681 Method left Called when I have left a channel.
703 Method modeChanged Called when a channel's modes are changed
724 Method pong Called with the results of a CTCP PING query.
729 Method signedOn Called after sucessfully signing on to the server.
739 Method nickChanged Called when my nick has been changed.
747 Method userJoined Called when I see another user joining a channel.
752 Method userLeft Called when I see another user leaving a channel.
757 Method userQuit Called when I see another user disconnect from the network.
772 Method topicUpdated In channel, user changed the topic to newTopic.
779 Method userRenamed A user changed their name from oldname to newname.
786 Method receivedMOTD I received a message-of-the-day banner from the server.
801 Method join Undocumented
808 Method leave Undocumented
815 Method kick Undocumented
824 Method topic Attempt to set the topic of the given channel, or ask what it is.
838 Method mode Change the modes on a user or channel.
853 Method say Undocumented
857 Method msg Send a message to a user or channel.
892 Method notice Undocumented
895 Method away Undocumented
898 Method register Undocumented
910 Method quit Undocumented
915 Method me Strike a pose.
924 Method ping Measure round-trip delay to another IRC client.
946 Method dccSend Undocumented
972 Method dccResume Send a DCC RESUME request to another user.
977 Method dccAcceptResume Send a DCC ACCEPT response to clients who have requested a resume.
987 Method irc_ERR_NICKNAMEINUSE Undocumented
990 Method irc_ERR_PASSWDMISMATCH Undocumented
993 Method irc_RPL_WELCOME Undocumented
1016 Method irc_MODE Undocumented
1023 Method irc_PING Undocumented
1026 Method irc_PRIVMSG Undocumented
1045 Method irc_NOTICE Undocumented
1069 Method irc_KICK Kicked? Who? Not me, I hope.
1098 Method irc_RPL_NOTOPIC Undocumented
1104 Method irc_RPL_MOTDSTART Undocumented
1109 Method irc_RPL_MOTD Undocumented
1114 Method irc_RPL_ENDOFMOTD Undocumented
1117 Method irc_RPL_CREATED Undocumented
1120 Method irc_RPL_YOURHOST Undocumented
1123 Method irc_RPL_MYINFO Undocumented
1129 Method irc_RPL_BOUNCE Undocumented
1136 Method irc_RPL_LUSERCLIENT Undocumented
1139 Method irc_RPL_LUSEROP Undocumented
1145 Method irc_RPL_LUSERCHANNELS Undocumented
1151 Method irc_RPL_LUSERME Undocumented
1160 Method ctcpQuery Dispatch method for any CTCP queries received.
1170 Method ctcpQuery_ACTION Undocumented
1173 Method ctcpQuery_PING Undocumented
1177 Method ctcpQuery_FINGER Undocumented
1192 Method ctcpQuery_VERSION Undocumented
1204 Method ctcpQuery_SOURCE Undocumented
1217 Method ctcpQuery_USERINFO Undocumented
1225 Method ctcpQuery_CLIENTINFO A master index of what CTCP tags this client knows.
1256 Method ctcpQuery_ERRMSG Undocumented
1263 Method ctcpQuery_TIME Undocumented
1272 Method ctcpQuery_DCC Initiate a Direct Client Connection
1292 Method dcc_SEND Undocumented
1316 Method dcc_ACCEPT Undocumented
1329 Method dcc_RESUME Undocumented
1341 Method dcc_CHAT Undocumented
1359 Method dccDoSend Called when I receive a DCC SEND offer from a client.
1370 Method dccDoResume Called when a client is trying to resume an offered file
1376 Method dccDoAcceptResume Called when a client has verified and accepted a DCC resume
1381 Method dccDoChat Undocumented
1394 Method ctcpUnknownQuery Undocumented
1403 Method ctcpMakeReply Send one or more extended messages as a CTCP reply.
1413 Method ctcpMakeQuery Send one or more extended messages as a CTCP query.
1424 Method ctcpReply Dispatch method for any CTCP replies received.
1434 Method ctcpReply_PING Undocumented
1443 Method ctcpUnknownReply Called when a fitting ctcpReply_ method is not found.
1456 Method badMessage When I get a message that's so broken I can't use it.
1464 Method quirkyMessage This is called when I receive a message which is peculiar,
1477 Method dataReceived Called whenever data is received.
1480 Method lineReceived Undocumented
1491 Method handleCommand Determine the function to call for the given command and call
1505 Method __getstate__ Undocumented

Inherited from LineReceiver (via IRCClient):

Line # Kind Name Docs
208 Method clearLineBuffer Clear buffered data.
242 Method setLineMode Sets the line-mode of this receiver.
257 Method setRawMode Sets the raw mode of this receiver.
264 Method rawDataReceived Override this for when raw data is received.
279 Method lineLengthExceeded Called when the maximum line length has been reached.

Inherited from Protocol (via IRCClient, LineReceiver):

Line # Kind Name Docs
368 Method connectionLost Called when the connection is shut down.

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

Line # Kind Name Docs
325 Method makeConnection Make a connection to a transport and a server.

Inherited from _PauseableMixin (via IRCClient, LineReceiver):

Line # Kind Name Docs
173 Method pauseProducing Undocumented
177 Method resumeProducing Undocumented
182 Method stopProducing Undocumented
def __init__(self, account, chatui, logonDeferred=None):
overrides twisted.words.im.basesupport.AbstractClientMixin.__init__
Undocumented
def getGroupConversation(self, name, hide=0):
Undocumented
def getPerson(self, name):
Undocumented
def connectionMade(self):
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.
def setNick(self, nick):
overrides twisted.words.protocols.irc.IRCClient.setNick
Undocumented
def kickedFrom(self, channel, kicker, message):
overrides twisted.words.protocols.irc.IRCClient.kickedFrom
Called when I am kicked from a channel.
def userKicked(self, kickee, channel, kicker, message):
overrides twisted.words.protocols.irc.IRCClient.userKicked
Called when I observe someone else being kicked from a channel.
def noticed(self, username, channel, message):
overrides twisted.words.protocols.irc.IRCClient.noticed

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

By default, this is equivalent to IRCClient.privmsg, but if your client makes any automated replies, you must override this! From 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):
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):
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):
RPL_NAMREPLY >> NAMES #bnl << :Arlington.VA.US.Undernet.Org 353 z3p = #bnl :pSwede Dan-- SkOyg AG
def irc_RPL_ENDOFNAMES(self, prefix, params):
Undocumented
def irc_RPL_TOPIC(self, prefix, params):
overrides twisted.words.protocols.irc.IRCClient.irc_RPL_TOPIC
I just joined the channel, and the server is telling me the current topic.
def irc_333(self, prefix, params):
Undocumented
def irc_TOPIC(self, prefix, params):
overrides twisted.words.protocols.irc.IRCClient.irc_TOPIC
Someone in the channel set the topic.
def irc_JOIN(self, prefix, params):
overrides twisted.words.protocols.irc.IRCClient.irc_JOIN
Undocumented
def irc_PART(self, prefix, params):
overrides twisted.words.protocols.irc.IRCClient.irc_PART
Undocumented
def irc_QUIT(self, prefix, params):
overrides twisted.words.protocols.irc.IRCClient.irc_QUIT
Undocumented
def irc_NICK(self, prefix, params):
overrides twisted.words.protocols.irc.IRCClient.irc_NICK
Undocumented
def irc_unknown(self, prefix, command, params):
overrides twisted.words.protocols.irc.IRCClient.irc_unknown
Undocumented
def joinGroup(self, name):
Undocumented