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

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

No class docstring

Split Table into Classes Show Methods in One Table

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 Set this client's nickname.
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 Called when the topic for a channel is initially reported or when it
188 Method irc_333 Undocumented
193 Method irc_TOPIC Someone in the channel set the topic.
199 Method irc_JOIN Called when a user joins a channel.
209 Method irc_PART Called when a user leaves a channel.
219 Method irc_QUIT Called when a user has quit.
228 Method irc_NICK Called when a user changes their nickname.
239 Method irc_unknown Undocumented
243 Method joinGroup Undocumented

Inherited from AbstractClientMixin:

Line # Kind Name Docs
110 Method connectionLost Undocumented
115 Method unregisterAsAccountClient Tell the chat UI that I have `signed off'.

Inherited from IRCClient:

Line # Kind Name Docs
579 Method sendLine Sends a line to the other end of the connection.
602 Method created Called with creation date information about the server, usually at logon.
609 Method yourHost Called with daemon information about the server, usually at logon.
616 Method myInfo Called with information about the server, usually at logon.
632 Method luserClient Called with information about the number of connections, usually at logon.
640 Method bounce Called with information about where the client should reconnect.
648 Method isupport Called with various information about what the server supports.
656 Method luserChannels Called with the number of channels existant on the server.
662 Method luserOp Called with the number of ops logged on to the server.
668 Method luserMe Called with information about the server connected to.
683 Method joined Called when I finish joining a channel.
690 Method left Called when I have left a channel.
712 Method modeChanged Called when users or channel's modes are changed.
738 Method pong Called with the results of a CTCP PING query.
743 Method signedOn Called after sucessfully signing on to the server.
753 Method nickChanged Called when my nick has been changed.
761 Method userJoined Called when I see another user joining a channel.
766 Method userLeft Called when I see another user leaving a channel.
771 Method userQuit Called when I see another user disconnect from the network.
786 Method topicUpdated In channel, user changed the topic to newTopic.
793 Method userRenamed A user changed their name from oldname to newname.
800 Method receivedMOTD I received a message-of-the-day banner from the server.
815 Method join Join a channel.
831 Method leave Leave a channel.
847 Method kick Attempt to kick a user from a channel.
867 Method topic Attempt to set the topic of the given channel, or ask what it is.
887 Method mode Change the modes on a user or channel.
923 Method say Send a message to a channel
943 Method msg Send a message to a user or channel.
978 Method notice Send a notice to a user.
992 Method away Mark this client as away.
1003 Method back Clear the away status.
1011 Method whois Retrieve user information about the given nick name.
1026 Method register Login to the server.
1054 Method quit Disconnect from the server
1067 Method me Strike a pose.
1083 Method ping Measure round-trip delay to another IRC client.
1106 Method dccSend Undocumented
1132 Method dccResume Send a DCC RESUME request to another user.
1137 Method dccAcceptResume Send a DCC ACCEPT response to clients who have requested a resume.
1147 Method irc_ERR_NICKNAMEINUSE Called when we try to register an invalid nickname.
1153 Method irc_ERR_PASSWDMISMATCH Called when the login was incorrect.
1159 Method irc_RPL_WELCOME Called when we have received the welcome from the server.
1195 Method irc_MODE Parse the server message when one or more modes are changed
1231 Method irc_PING Called when some has pinged us.
1237 Method irc_PRIVMSG Called when we get a message.
1259 Method irc_NOTICE Called when a user gets a notice.
1289 Method irc_KICK Called when a user is kicked from a channel.
1322 Method irc_RPL_NOTOPIC Undocumented
1328 Method irc_RPL_MOTDSTART Undocumented
1333 Method irc_RPL_MOTD Undocumented
1338 Method irc_RPL_ENDOFMOTD Undocumented
1341 Method irc_RPL_CREATED Undocumented
1344 Method irc_RPL_YOURHOST Undocumented
1347 Method irc_RPL_MYINFO Undocumented
1353 Method irc_RPL_BOUNCE Undocumented
1360 Method irc_RPL_LUSERCLIENT Undocumented
1363 Method irc_RPL_LUSEROP Undocumented
1369 Method irc_RPL_LUSERCHANNELS Undocumented
1375 Method irc_RPL_LUSERME Undocumented
1384 Method ctcpQuery Dispatch method for any CTCP queries received.
1394 Method ctcpQuery_ACTION Undocumented
1397 Method ctcpQuery_PING Undocumented
1401 Method ctcpQuery_FINGER Undocumented
1416 Method ctcpQuery_VERSION Undocumented
1428 Method ctcpQuery_SOURCE Undocumented
1441 Method ctcpQuery_USERINFO Undocumented
1449 Method ctcpQuery_CLIENTINFO A master index of what CTCP tags this client knows.
1480 Method ctcpQuery_ERRMSG Undocumented
1487 Method ctcpQuery_TIME Undocumented
1496 Method ctcpQuery_DCC Initiate a Direct Client Connection
1516 Method dcc_SEND Undocumented
1540 Method dcc_ACCEPT Undocumented
1553 Method dcc_RESUME Undocumented
1565 Method dcc_CHAT Undocumented
1583 Method dccDoSend Called when I receive a DCC SEND offer from a client.
1594 Method dccDoResume Called when a client is trying to resume an offered file
1600 Method dccDoAcceptResume Called when a client has verified and accepted a DCC resume
1605 Method dccDoChat Undocumented
1618 Method ctcpUnknownQuery Undocumented
1627 Method ctcpMakeReply Send one or more extended messages as a CTCP reply.
1638 Method ctcpMakeQuery Send one or more extended messages as a CTCP query.
1650 Method ctcpReply Dispatch method for any CTCP replies received.
1661 Method ctcpReply_PING Undocumented
1670 Method ctcpUnknownReply Called when a fitting ctcpReply_ method is not found.
1683 Method badMessage When I get a message that's so broken I can't use it.
1691 Method quirkyMessage This is called when I receive a message which is peculiar,
1704 Method dataReceived Protocol.dataReceived.
1707 Method lineReceived Override this for when each line is received.
1718 Method handleCommand Determine the function to call for the given command and call
1732 Method __getstate__ Undocumented
576 Method _reallySendLine Undocumented
587 Method _sendLine Undocumented

Inherited from LineReceiver (via IRCClient):

Line # Kind Name Docs
207 Method clearLineBuffer Clear buffered data.
241 Method setLineMode Sets the line-mode of this receiver.
256 Method setRawMode Sets the raw mode of this receiver.
263 Method rawDataReceived Override this for when raw data is received.
278 Method lineLengthExceeded Called when the maximum line length has been reached.

Inherited from Protocol (via IRCClient, LineReceiver):

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

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

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

Inherited from _PauseableMixin (via IRCClient, LineReceiver):

Line # Kind Name Docs
172 Method pauseProducing Undocumented
176 Method resumeProducing Undocumented
181 Method stopProducing Undocumented
Line # Kind Name Docs
1732 Method __getstate__ Undocumented
86 Method __init__ Undocumented
150 Method action Called when I see a user perform an ACTION on a channel.
992 Method away Mark this client as away.
1003 Method back Clear the away status.
1683 Method badMessage When I get a message that's so broken I can't use it.
640 Method bounce Called with information about where the client should reconnect.
207 Method clearLineBuffer Clear buffered data.
110 Method connectionLost Undocumented
384 Method connectionLost Called when the connection is shut down.
102 Method connectionMade Called when a connection is made.
602 Method created Called with creation date information about the server, usually at logon.
1638 Method ctcpMakeQuery Send one or more extended messages as a CTCP query.
1627 Method ctcpMakeReply Send one or more extended messages as a CTCP reply.
1384 Method ctcpQuery Dispatch method for any CTCP queries received.
1394 Method ctcpQuery_ACTION Undocumented
1449 Method ctcpQuery_CLIENTINFO A master index of what CTCP tags this client knows.
1496 Method ctcpQuery_DCC Initiate a Direct Client Connection
1480 Method ctcpQuery_ERRMSG Undocumented
1401 Method ctcpQuery_FINGER Undocumented
1397 Method ctcpQuery_PING Undocumented
1428 Method ctcpQuery_SOURCE Undocumented
1487 Method ctcpQuery_TIME Undocumented
1441 Method ctcpQuery_USERINFO Undocumented
1416 Method ctcpQuery_VERSION Undocumented
1650 Method ctcpReply Dispatch method for any CTCP replies received.
1661 Method ctcpReply_PING Undocumented
1618 Method ctcpUnknownQuery Undocumented
1670 Method ctcpUnknownReply Called when a fitting ctcpReply_ method is not found.
1704 Method dataReceived Protocol.dataReceived.
1540 Method dcc_ACCEPT Undocumented
1565 Method dcc_CHAT Undocumented
1553 Method dcc_RESUME Undocumented
1516 Method dcc_SEND Undocumented
1137 Method dccAcceptResume Send a DCC ACCEPT response to clients who have requested a resume.
1600 Method dccDoAcceptResume Called when a client has verified and accepted a DCC resume
1605 Method dccDoChat Undocumented
1594 Method dccDoResume Called when a client is trying to resume an offered file
1583 Method dccDoSend Called when I receive a DCC SEND offer from a client.
1132 Method dccResume Send a DCC RESUME request to another user.
1106 Method dccSend Undocumented
94 Method getGroupConversation Undocumented
99 Method getPerson Undocumented
1718 Method handleCommand Determine the function to call for the given command and call
188 Method irc_333 Undocumented
1147 Method irc_ERR_NICKNAMEINUSE Called when we try to register an invalid nickname.
1153 Method irc_ERR_PASSWDMISMATCH Called when the login was incorrect.
199 Method irc_JOIN Called when a user joins a channel.
1289 Method irc_KICK Called when a user is kicked from a channel.
1195 Method irc_MODE Parse the server message when one or more modes are changed
228 Method irc_NICK Called when a user changes their nickname.
1259 Method irc_NOTICE Called when a user gets a notice.
209 Method irc_PART Called when a user leaves a channel.
1231 Method irc_PING Called when some has pinged us.
1237 Method irc_PRIVMSG Called when we get a message.
219 Method irc_QUIT Called when a user has quit.
1353 Method irc_RPL_BOUNCE Undocumented
1341 Method irc_RPL_CREATED Undocumented
1338 Method irc_RPL_ENDOFMOTD Undocumented
180 Method irc_RPL_ENDOFNAMES Undocumented
1369 Method irc_RPL_LUSERCHANNELS Undocumented
1360 Method irc_RPL_LUSERCLIENT Undocumented
1375 Method irc_RPL_LUSERME Undocumented
1363 Method irc_RPL_LUSEROP Undocumented
1333 Method irc_RPL_MOTD Undocumented
1328 Method irc_RPL_MOTDSTART Undocumented
1347 Method irc_RPL_MYINFO Undocumented
160 Method irc_RPL_NAMREPLY RPL_NAMREPLY
1322 Method irc_RPL_NOTOPIC Undocumented
185 Method irc_RPL_TOPIC Called when the topic for a channel is initially reported or when it
1159 Method irc_RPL_WELCOME Called when we have received the welcome from the server.
1344 Method irc_RPL_YOURHOST Undocumented
193 Method irc_TOPIC Someone in the channel set the topic.
239 Method irc_unknown Undocumented
648 Method isupport Called with various information about what the server supports.
815 Method join Join a channel.
683 Method joined Called when I finish joining a channel.
243 Method joinGroup Undocumented
847 Method kick Attempt to kick a user from a channel.
126 Method kickedFrom Called when I am kicked from a channel.
831 Method leave Leave a channel.
690 Method left Called when I have left a channel.
278 Method lineLengthExceeded Called when the maximum line length has been reached.
1707 Method lineReceived Override this for when each line is received.
656 Method luserChannels Called with the number of channels existant on the server.
632 Method luserClient Called with information about the number of connections, usually at logon.
668 Method luserMe Called with information about the server connected to.
662 Method luserOp Called with the number of ops logged on to the server.
341 Method makeConnection Make a connection to a transport and a server.
1067 Method me Strike a pose.
887 Method mode Change the modes on a user or channel.
712 Method modeChanged Called when users or channel's modes are changed.
943 Method msg Send a message to a user or channel.
616 Method myInfo Called with information about the server, usually at logon.
753 Method nickChanged Called when my nick has been changed.
978 Method notice Send a notice to a user.
136 Method noticed Called when I have a notice from a user to me or a channel.
172 Method pauseProducing Undocumented
1083 Method ping Measure round-trip delay to another IRC client.
738 Method pong Called with the results of a CTCP PING query.
139 Method privmsg Called when I have a message from a user to me or a channel.
1691 Method quirkyMessage This is called when I receive a message which is peculiar,
1054 Method quit Disconnect from the server
263 Method rawDataReceived Override this for when raw data is received.
800 Method receivedMOTD I received a message-of-the-day banner from the server.
1026 Method register Login to the server.
176 Method resumeProducing Undocumented
923 Method say Send a message to a channel
579 Method sendLine Sends a line to the other end of the connection.
241 Method setLineMode Sets the line-mode of this receiver.
121 Method setNick Set this client's nickname.
256 Method setRawMode Sets the raw mode of this receiver.
743 Method signedOn Called after sucessfully signing on to the server.
181 Method stopProducing Undocumented
867 Method topic Attempt to set the topic of the given channel, or ask what it is.
786 Method topicUpdated In channel, user changed the topic to newTopic.
115 Method unregisterAsAccountClient Tell the chat UI that I have `signed off'.
761 Method userJoined Called when I see another user joining a channel.
133 Method userKicked Called when I observe someone else being kicked from a channel.
766 Method userLeft Called when I see another user leaving a channel.
771 Method userQuit Called when I see another user disconnect from the network.
793 Method userRenamed A user changed their name from oldname to newname.
1011 Method whois Retrieve user information about the given nick name.
609 Method yourHost Called with daemon information about the server, usually at logon.
576 Method _reallySendLine Undocumented
587 Method _sendLine Undocumented
def __init__(self, account, chatui, logonDeferred=None): (source)
overrides twisted.words.im.basesupport.AbstractClientMixin.__init__
Undocumented
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.
def setNick(self, nick): (source)
overrides twisted.words.protocols.irc.IRCClient.setNick
Set this client's nickname.
ParametersnicknameThe nickname to change to. (type: str )
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.

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): (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
Called when the topic for a channel is initially reported or when it subsequently changes.
def irc_333(self, prefix, params): (source)
Undocumented
def irc_TOPIC(self, prefix, params): (source)
overrides twisted.words.protocols.irc.IRCClient.irc_TOPIC
Someone in the channel set the topic.
def irc_JOIN(self, prefix, params): (source)
overrides twisted.words.protocols.irc.IRCClient.irc_JOIN
Called when a user joins a channel.
def irc_PART(self, prefix, params): (source)
overrides twisted.words.protocols.irc.IRCClient.irc_PART
Called when a user leaves a channel.
def irc_QUIT(self, prefix, params): (source)
overrides twisted.words.protocols.irc.IRCClient.irc_QUIT
Called when a user has quit.
def irc_NICK(self, prefix, params): (source)
overrides twisted.words.protocols.irc.IRCClient.irc_NICK
Called when a user changes their nickname.
def irc_unknown(self, prefix, command, params): (source)
overrides twisted.words.protocols.irc.IRCClient.irc_unknown
Undocumented
def joinGroup(self, name): (source)
Undocumented
API Documentation for Twisted, generated by pydoctor at 2008-10-26 16:12:37.