Package twisted :: Package im :: Module ircsupport :: Class IRCProto

[show private | hide private]
[frames | no frames]

## Class IRCProto

         AbstractClientMixin --+
                               |
    BaseProtocol --+           |
                   |           |
            Protocol --+       |
                       |       |
            LineReceiver --+   |
                           |   |
                   IRCClient --+
                               |
                              IRCProto

Method Summary
| `__init__(self, account, chatui, logonDeferred)`
| `__getstate__(self)` (inherited from `IRCClient`)
| `action(self, username, channel, emote)`
| `away(self, message)` (inherited from `IRCClient`)
| ``badMessage`(self, line, excType, excValue, tb)` When I get a message that's so broken I can't use it. (inherited from `IRCClient`)
| ``connectionFailed`(self)` (Deprecated) (inherited from `Protocol`)
| `connectionLost(self, reason)` (inherited from `AbstractClientMixin`)
| `connectionMade(self)`
| ``ctcpMakeQuery`(self, user, messages)` Send one or more extended messagesas a CTCP query. (inherited from `IRCClient`)
| ``ctcpMakeReply`(self, user, messages)` Send one or more extended messagesas a CTCP reply. (inherited from `IRCClient`)
| ``ctcpQuery`(self, user, channel, messages)` Dispatch method for any CTCP queries received. (inherited from `IRCClient`)
| `ctcpQuery_ACTION(self, user, channel, data)` (inherited from `IRCClient`)
| ``ctcpQuery_CLIENTINFO`(self, user, channel, data)` A master index of what CTCP tags this client knows. (inherited from `IRCClient`)
| ``ctcpQuery_DCC`(self, user, channel, data)` Initiate a Direct Client Connection (inherited from `IRCClient`)
| `ctcpQuery_ERRMSG(self, user, channel, data)` (inherited from `IRCClient`)
| `ctcpQuery_FINGER(self, user, channel, data)` (inherited from `IRCClient`)
| `ctcpQuery_PING(self, user, channel, data)` (inherited from `IRCClient`)
| `ctcpQuery_SOURCE(self, user, channel, data)` (inherited from `IRCClient`)
| `ctcpQuery_TIME(self, user, channel, data)` (inherited from `IRCClient`)
| `ctcpQuery_USERINFO(self, user, channel, data)` (inherited from `IRCClient`)
| `ctcpQuery_VERSION(self, user, channel, data)` (inherited from `IRCClient`)
| ``ctcpReply`(self, user, channel, messages)` Dispatch method for any CTCP replies received. (inherited from `IRCClient`)
| `ctcpReply_PING(self, user, channel, data)` (inherited from `IRCClient`)
| `ctcpUnknownQuery(self, user, channel, tag, data)` (inherited from `IRCClient`)
| ``ctcpUnknownReply`(self, user, channel, tag, data)` Called when a fitting ctcpReply_ method is not found. (inherited from `IRCClient`)
| ``dataReceived`(self, data)` Protocol.dataReceived. (inherited from `IRCClient`)
| `dcc_ACCEPT(self, user, channel, data)` (inherited from `IRCClient`)
| `dcc_CHAT(self, user, channel, data)` (inherited from `IRCClient`)
| `dcc_RESUME(self, user, channel, data)` (inherited from `IRCClient`)
| `dcc_SEND(self, user, channel, data)` (inherited from `IRCClient`)
| ``dccAcceptResume`(self, user, fileName, port, resumePos)` Send a DCC ACCEPT response to clients who have requested a resume. (inherited from `IRCClient`)
| ``dccDoAcceptResume`(self, user, file, port, resumePos)` Called when a client has verified and accepted a DCC resume request made by us. (inherited from `IRCClient`)
| `dccDoChat(self, user, channel, address, port, data)` (inherited from `IRCClient`)
| ``dccDoResume`(self, user, file, port, resumePos)` Called when a client is trying to resume an offered file via DCC send. (inherited from `IRCClient`)
| ``dccDoSend`(self, user, address, port, fileName, size, data)` Called when I receive a DCC SEND offer from a client. (inherited from `IRCClient`)
| ``dccResume`(self, user, fileName, port, resumePos)` Send a DCC RESUME request to another user. (inherited from `IRCClient`)
| `dccSend(self, user, file)` (inherited from `IRCClient`)
| `getGroupConversation(self, name, hide)`
| `getPerson(self, name)`
| ``handleCommand`(self, command, prefix, params)` Determine the function to call for the given command and call it with the given arguments. (inherited from `IRCClient`)
| `irc_333(self, prefix, params)`
| `irc_ERR_NICKNAMEINUSE(self, prefix, params)` (inherited from `IRCClient`)
| `irc_ERR_PASSWDMISMATCH(self, prefix, params)` (inherited from `IRCClient`)
| `irc_JOIN(self, prefix, params)`
| ``irc_KICK`(self, prefix, params)` Kicked? Who? Not me, I hope. (inherited from `IRCClient`)
| `irc_MODE(self, prefix, params)` (inherited from `IRCClient`)
| `irc_NICK(self, prefix, params)`
| `irc_NOTICE(self, prefix, params)` (inherited from `IRCClient`)
| `irc_PART(self, prefix, params)`
| `irc_PING(self, prefix, params)` (inherited from `IRCClient`)
| `irc_PRIVMSG(self, prefix, params)` (inherited from `IRCClient`)
| `irc_QUIT(self, prefix, params)`
| `irc_RPL_ENDOFMOTD(self, prefix, params)` (inherited from `IRCClient`)
| `irc_RPL_ENDOFNAMES(self, prefix, params)`
| `irc_RPL_MOTD(self, prefix, params)` (inherited from `IRCClient`)
| `irc_RPL_MOTDSTART(self, prefix, params)` (inherited from `IRCClient`)
| ``irc_RPL_NAMREPLY`(self, prefix, params)` RPL_NAMREPLY >> NAMES #bnl << :Arlington.VA.US.Undernet.Org 353 z3p = #bnl :pSwede Dan-- SkOyg AG
| `irc_RPL_NOTOPIC(self, prefix, params)` (inherited from `IRCClient`)
| ``irc_RPL_TOPIC`(self, prefix, params)` I just joined the channel, and the server is telling me the current topic.
| `irc_RPL_WELCOME(self, prefix, params)` (inherited from `IRCClient`)
| ``irc_TOPIC`(self, prefix, params)` Someone in the channel set the topic.
| `irc_unknown(self, prefix, command, params)`
| `join(self, channel, key)` (inherited from `IRCClient`)
| ``joined`(self, channel)` Called when I finish joining a channel. (inherited from `IRCClient`)
| `joinGroup(self, name)`
| `kick(self, channel, user, reason)` (inherited from `IRCClient`)
| ``kickedFrom`(self, channel, kicker, message)` Called when I am kicked from a channel.
| `leave(self, channel, reason)` (inherited from `IRCClient`)
| ``left`(self, channel)` Called when I have left a channel. (inherited from `IRCClient`)
| ``lineLengthExceeded`(self, line)` Called when the maximum line length has been reached. (inherited from `LineReceiver`)
| ``lineReceived`(self, line)` Override this for when each line is received. (inherited from `IRCClient`)
| ``makeConnection`(self, transport)` Make a connection to a transport and a server. (inherited from `BaseProtocol`)
| ``me`(self, channel, action)` Strike a pose. (inherited from `IRCClient`)
| ``mode`(self, chan, set, modes, limit, user, mask)` Change the modes on a user or channel. (inherited from `IRCClient`)
| ``modeChanged`(self, user, channel, set, modes, args)` Called when a channel's modes are changed (inherited from `IRCClient`)
| `msg(self, user, message, length)` (inherited from `IRCClient`)
| ``nickChanged`(self, nick)` Called when my nick has been changed. (inherited from `IRCClient`)
| `notice(self, user, message)` (inherited from `IRCClient`)
| `noticed(self, username, channel, message)`
| `part(self, channel, reason)` (inherited from `IRCClient`)
| ``ping`(self, user, text)` Measure round-trip delay to another IRC client. (inherited from `IRCClient`)
| ``pong`(self, user, secs)` Called with the results of a CTCP PING query. (inherited from `IRCClient`)
| `privmsg(self, username, channel, message, metadata)`
| ``quirkyMessage`(self, s)` This is called when I receive a message which is peculiar, but not wholly indecipherable. (inherited from `IRCClient`)
| `quit(self, message)` (inherited from `IRCClient`)
| ``rawDataReceived`(self, data)` Override this for when raw data is received. (inherited from `LineReceiver`)
| ``receivedMOTD`(self, motd)` I received a message-of-the-day banner from the server. (inherited from `IRCClient`)
| `register(self, nickname, hostname, servername)` (inherited from `IRCClient`)
| `say(self, channel, message, length)` (inherited from `IRCClient`)
| ``sendLine`(self, line)` Sends a line to the other end of the connection. (inherited from `IRCClient`)
| ``setLineMode`(self, extra)` Sets the line-mode of this receiver. (inherited from `LineReceiver`)
| `setNick(self, nick)`
| ``setRawMode`(self)` Sets the raw mode of this receiver. (inherited from `LineReceiver`)
| ``signedOn`(self)` Called after sucessfully signing on to the server. (inherited from `IRCClient`)
| ``topic`(self, channel, topic)` Attempt to set the topic of the given channel, or ask what it is. (inherited from `IRCClient`)
| ``topicUpdated`(self, user, channel, newTopic)` In channel, user changed the topic to newTopic. (inherited from `IRCClient`)
| ``unregisterAsAccountClient`(self)` Tell the chat UI that I have `signed off'. (inherited from `AbstractClientMixin`)
| ``userJoined`(self, user, channel)` Called when I see another user joining a channel. (inherited from `IRCClient`)
| ``userKicked`(self, kickee, channel, kicker, message)` Called when I observe someone else being kicked from a channel.
| ``userLeft`(self, user, channel)` Called when I see another user leaving a channel. (inherited from `IRCClient`)
| ``userRenamed`(self, oldname, newname)` A user changed their name from oldname to newname. (inherited from `IRCClient`)
| `_sendLine(self)` (inherited from `IRCClient`)

Method Details

### irc_RPL_NAMREPLY(self, prefix, params)

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

### irc_RPL_TOPIC(self, prefix, params)

I just joined the channel, and the server is telling me the current topic.

  Overrides:
    `twisted.protocols.irc.IRCClient.irc_RPL_TOPIC` (inherited documentation)

### irc_TOPIC(self, prefix, params)

Someone in the channel set the topic.

  Overrides:
    `twisted.protocols.irc.IRCClient.irc_TOPIC` (inherited documentation)

### kickedFrom(self, channel, kicker, message)

Called when I am kicked from a channel.

### userKicked(self, kickee, channel, kicker, message)

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

  Overrides:
    `twisted.protocols.irc.IRCClient.userKicked` (inherited documentation)

Generated by Epydoc 1.1 on Thu May 8 13:18:23 2003 | http://epydoc.sf.net