API docs for “services.ircServer.Server”

Class s.i.Server(IRCUser, pluginSupport):

Part of services.ircServer View Source View In Hierarchy

No class docstring
Method __init__ Undocumented
Method startPlugin Undocumented
Method handleCommand Determine the function to call for the given command and call
Method connectionMade Called when a connection is made.
Method connectionLost Called when the connection is shut down.
Method getHostmask Undocumented
Method sendmsg Undocumented
Method stop Undocumented

Inherited from IRCUser:

Method sendMessage Send a line formatted as an IRC message.
Method userJoined Callback notifying this user that the given user has joined
Method userLeft Callback notifying this user that the given user has left the
Method receive Callback notifying this user of the given message sent by the
Method groupMetaUpdate Callback notifying this user that the metadata for the given
Method irc_PASS Password message -- Register a password.
Method irc_NICK Nick message -- Set your nickname.
Method irc_USER User message -- Set your realname.
Method irc_NICKSERV_PRIVMSG Send a (private) message.
Method logInAs Undocumented
Method irc_PING Ping message
Method irc_QUIT Quit
Method irc_MODE User mode message
Method irc_USERHOST Userhost message
Method irc_PRIVMSG Send a (private) message.
Method irc_JOIN Join message
Method irc_PART Part message
Method irc_NAMES Names message
Method irc_TOPIC Topic message
Method list Send a group of LIST response lines
Method irc_LIST List query
Method irc_WHO Who query
Method irc_WHOIS Whois query
Method irc_OPER Oper message
Method _cbLogin Undocumented
Method _ebLogin Undocumented
Method _channelMode Undocumented
Method _userMode Undocumented
Method _sendTopic Send the topic of the given group to this user, if it has one.
Method _getTopic Undocumented
Method _setTopic Undocumented
Method _channelWho Undocumented
Method _userWho Undocumented

Inherited from IRC (via IRCUser):

Method sendLine Undocumented
Method dataReceived This hack is to support mIRC, which sends LF only,
Method irc_unknown Implement me!
Method privmsg Send a message to a channel or user
Method notice Send a "notice" to a channel or user.
Method action Send an action to a channel or user.
Method topic Send the topic to a user.
Method topicAuthor Send the author of and time at which a topic was set for the given
Method names Send the names of a channel's participants to a user.
Method who Send a list of users participating in a channel.
Method whois Send information about the state of a particular user.
Method join Send a join message.
Method part Send a part message.
Method channelMode Send information about the mode of a channel.

Inherited from BaseProtocol (via IRCUser, IRC, Protocol):

Method makeConnection Make a connection to a transport and a server.

Inherited from pluginSupport:

Method register_pluginsupport_commands Undocumented
Method depends Undocumented
Method depends_on_module Undocumented
Method depends_on_service Undocumented
Method depends_on_plugin Undocumented
Method importPlugin Undocumented
Method callbackRegistered Undocumented
Method registerCallback Undocumented
Method unregisterCallback Undocumented
Method startPlugins initializes all known plugins
Method reloadPluginClass Undocumented
Method restartPlugin Undocumented
Method reloadPlugins call this to reload all plugins
Method stopPlugins stop all Plugins
Method stopPlugin Undocumented
Class WontStart Undocumented
Class DependencyMissing Undocumented
Class ModuleMissing Undocumented
Class ServiceMissing Undocumented
Class PluginMissing Undocumented
Method logerror format a exception nicely and pass it to the logger
Method _getClassName Undocumented
Method _apirunner Pass all calls to plugin callbacks through this method, they
def __init__(self, root, parent): (source)
overrides lib.pluginSupport.pluginSupport.__init__
Undocumented
def startPlugin(self, pluginName): (source)
overrides lib.pluginSupport.pluginSupport.startPlugin
Undocumented
def handleCommand(self, command, prefix, params): (source)
overrides twisted.words.protocols.irc.IRC.handleCommand
Determine the function to call for the given command and call it with the given arguments.
def connectionMade(self): (source)
overrides twisted.words.service.IRCUser.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 connectionLost(self, reason): (source)
overrides twisted.words.service.IRCUser.connectionLost
Called when the connection is shut down.

Clear any circular references here, and any external references to this Protocol. The connection has been closed.

Parametersreason (type: twisted.python.failure.Failure )
def getHostmask(self): (source)
Undocumented
def sendmsg(self, user, channel, msg): (source)
Undocumented
def stop(self): (source)
Undocumented
API Documentation for OtfBot - the friendly Bot, generated by pydoctor at 2010-01-04 01:40:56.