Package twisted :: Package words :: Module tendril :: Class TendrilIRC
[show private | hide private]
[frames | no frames]

Class TendrilIRC

BaseProtocol --+            
               |            
        Protocol --+        
                   |        
        LineReceiver --+    
                       |    
               IRCClient --+
                           |
               Ephemeral --+
                           |
                          TendrilIRC


I connect to the IRC server and broker traffic.
Method Summary
  __init__(self)
Create a new Tendril IRC client.
  __getstate__(self)
(inherited from IRCClient)
  __setstate__(self, state)
(inherited from Ephemeral)
  action(self, user, channel, message)
Speak about a participant in third-person.
  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)
  bot_DCC(self, user, params)
Commands for brokering DCC handshakes.
  bot_help(self, user, params)
  bot_msg(self, sender, params)
Pass along a message as a directMessage to a words Participant
  botUnknown(self, user, channel, message)
  connectionFailed(self)
(Deprecated) (inherited from Protocol)
  connectionLost(self, reason)
When I lose a connection, log out all my IRC participants.
  connectionMade(self)
Called when a connection is made. (inherited from IRCClient)
  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)
Accept DCC handshakes, for passing on to others.
  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)
  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_ERR_BADCHANNELKEY(self, prefix, params)
When I can't get on a channel, report it.
  irc_ERR_BANNEDFROMCHAN(self, prefix, params)
When I can't get on a channel, report it.
  irc_ERR_CHANNELISFULL(self, prefix, params)
When I can't get on a channel, report it.
  irc_ERR_INVITEONLYCHAN(self, prefix, params)
When I can't get on a channel, report it.
  irc_ERR_NICKNAMEINUSE(self, prefix, params)
(inherited from IRCClient)
  irc_ERR_NOSUCHCHANNEL(self, prefix, params)
When I can't get on a channel, report it.
  irc_ERR_NOTREGISTERED(self, prefix, params)
  irc_ERR_PASSWDMISMATCH(self, prefix, params)
(inherited from IRCClient)
  irc_ERR_UNAVAILRESOURCE(self, prefix, params)
When I can't get on a channel, report it.
  irc_INVITE(self, prefix, params)
Accept an invitation, if it's in my groupList.
  irc_JOIN(self, prefix, params)
Join IRC user to the corresponding group.
  irc_KICK(self, prefix, params)
Kicked? Who? Not me, I hope.
  irc_MODE(self, prefix, params)
(inherited from IRCClient)
  irc_NICK(self, prefix, params)
When an IRC user changes their nickname
  irc_NOTICE(self, prefix, params)
(inherited from IRCClient)
  irc_PART(self, prefix, params)
Parting IRC members leave the correspoding group.
  irc_PING(self, prefix, params)
(inherited from IRCClient)
  irc_PRIVMSG(self, prefix, params)
(inherited from IRCClient)
  irc_QUIT(self, prefix, params)
When a user quits IRC, log out their participant.
  irc_RPL_ENDOFMOTD(self, prefix, params)
(inherited from IRCClient)
  irc_RPL_MOTD(self, prefix, params)
(inherited from IRCClient)
  irc_RPL_MOTDSTART(self, prefix, params)
(inherited from IRCClient)
  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. (inherited from IRCClient)
  irc_RPL_WELCOME(self, prefix, params)
(inherited from IRCClient)
  irc_TOPIC(self, prefix, params)
Announce the new topic.
  irc_unknown(self, prefix, command, params)
(inherited from IRCClient)
  join(self, channel, key)
(inherited from IRCClient)
  joined(self, channel)
Called when I finish joining a channel. (inherited from IRCClient)
  kickedFrom(self, channel, kicker, message)
Called when I am kicked from a channel. (inherited from IRCClient)
  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.
  log(self, message, priority)
I need to give Twisted a prioritized logging facility one of these days.
  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, user, channel, message)
Pass channel notices on to the group.
  part(self, channel, reason)
(inherited from IRCClient)
  ping(self, user)
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, user, channel, message)
Dispatch privmsg as a groupMessage or a command, as appropriate.
  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)
Send a line through my transport, unless my transport isn't up.
  setLineMode(self, extra)
Sets the line-mode of this receiver. (inherited from LineReceiver)
  setNick(self, nickname)
(inherited from IRCClient)
  setRawMode(self)
Sets the raw mode of this receiver. (inherited from LineReceiver)
  signedOn(self)
Join my groupList once I've signed on.
  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)
  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. (inherited from IRCClient)
  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)

Class Variable Summary
tuple helptext
str realname
str versionEnv
str versionName
str versionNum
NoneType words

Method Details

__init__(self)
(Constructor)

Create a new Tendril IRC client.

action(self, user, channel, message)

Speak about a participant in third-person.
Overrides:
twisted.protocols.irc.IRCClient.action

bot_DCC(self, user, params)

Commands for brokering DCC handshakes.

DCC -- I'll tell you if I'm holding a DCC request from you.

DCC PASSTO nick -- give the DCC request you gave me to this nick.

DCC FORGET -- forget any DCC requests you offered to me.

bot_msg(self, sender, params)

Pass along a message as a directMessage to a words Participant

connectionLost(self, reason)

When I lose a connection, log out all my IRC participants.
Overrides:
twisted.internet.protocol.Protocol.connectionLost

ctcpQuery_DCC(self, user, channel, data)

Accept DCC handshakes, for passing on to others.
Overrides:
twisted.protocols.irc.IRCClient.ctcpQuery_DCC

irc_ERR_BADCHANNELKEY(self, prefix, params)

When I can't get on a channel, report it.

irc_ERR_BANNEDFROMCHAN(self, prefix, params)

When I can't get on a channel, report it.

irc_ERR_CHANNELISFULL(self, prefix, params)

When I can't get on a channel, report it.

irc_ERR_INVITEONLYCHAN(self, prefix, params)

When I can't get on a channel, report it.

irc_ERR_NOSUCHCHANNEL(self, prefix, params)

When I can't get on a channel, report it.

irc_ERR_UNAVAILRESOURCE(self, prefix, params)

When I can't get on a channel, report it.

irc_INVITE(self, prefix, params)

Accept an invitation, if it's in my groupList.

irc_JOIN(self, prefix, params)

Join IRC user to the corresponding group.
Overrides:
twisted.protocols.irc.IRCClient.irc_JOIN

irc_KICK(self, prefix, params)

Kicked? Who? Not me, I hope.
Overrides:
twisted.protocols.irc.IRCClient.irc_KICK

irc_NICK(self, prefix, params)

When an IRC user changes their nickname

this does *not* change the name of their perspectivee, just my nickname->perspective and client->nickname mappings.
Overrides:
twisted.protocols.irc.IRCClient.irc_NICK

irc_PART(self, prefix, params)

Parting IRC members leave the correspoding group.
Overrides:
twisted.protocols.irc.IRCClient.irc_PART

irc_QUIT(self, prefix, params)

When a user quits IRC, log out their participant.

irc_TOPIC(self, prefix, params)

Announce the new topic.
Overrides:
twisted.protocols.irc.IRCClient.irc_TOPIC

lineReceived(self, line)

Override this for when each line is received.
Overrides:
twisted.protocols.irc.IRCClient.lineReceived (inherited documentation)

log(self, message, priority=None)

I need to give Twisted a prioritized logging facility one of these days.

noticed(self, user, channel, message)

Pass channel notices on to the group.
Overrides:
twisted.protocols.irc.IRCClient.noticed

privmsg(self, user, channel, message)

Dispatch privmsg as a groupMessage or a command, as appropriate.
Overrides:
twisted.protocols.irc.IRCClient.privmsg

sendLine(self, line)

Send a line through my transport, unless my transport isn't up.
Overrides:
twisted.protocols.irc.IRCClient.sendLine

signedOn(self)

Join my groupList once I've signed on.
Overrides:
twisted.protocols.irc.IRCClient.signedOn

Class Variable Details

helptext

Type:
tuple
Value:
("Hi, I'm a Tendril bridge between here and %(service)s.",
 'You can send a private message to someone like this:',
 '/msg %(myNick)s msg theirNick Hi there!')                            

realname

Type:
str
Value:
'Tendril'                                                              

versionEnv

Type:
str
Value:
'Twisted 1.0.2'                                                        

versionName

Type:
str
Value:
'Tendril'                                                              

versionNum

Type:
str
Value:
'1.32'                                                                 

words

Type:
NoneType
Value:
None                                                                   

Generated by Epydoc 1.2 prerelease on Wed Jan 29 06:26:43 2003 http://epydoc.sf.net