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

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

No class docstring
Method __init__ Undocumented
Method getGroupConversation Undocumented
Method getPerson Undocumented
Method connectionMade Called when a connection is made.
Method setNick Set this client's nickname.
Method kickedFrom Called when I am kicked from a channel.
Method userKicked Called when I observe someone else being kicked from a channel.
Method noticed Called when I have a notice from a user to me or a channel.
Method privmsg Called when I have a message from a user to me or a channel.
Method action Called when I see a user perform an ACTION on a channel.
Method irc_RPL_NAMREPLY RPL_NAMREPLY >> NAMES #bnl << :Arlington.VA.US.Undernet.Org 353 z3p = #bnl :pSwede Dan-- SkOyg AG
Method irc_RPL_ENDOFNAMES Undocumented
Method irc_RPL_TOPIC Called when the topic for a channel is initially reported or when it subsequently changes.
Method irc_333 Undocumented
Method irc_TOPIC Someone in the channel set the topic.
Method irc_JOIN Called when a user joins a channel.
Method irc_PART Called when a user leaves a channel.
Method irc_QUIT Called when a user has quit.
Method irc_NICK Called when a user changes their nickname.
Method irc_unknown Undocumented
Method joinGroup Undocumented

Inherited from AbstractClientMixin:

Method connectionLost Undocumented
Method unregisterAsAccountClient Tell the chat UI that I have `signed off'.

Inherited from IRCClient:

Method sendLine Sends a line to the other end of the connection.
Method created Called with creation date information about the server, usually at logon.
Method yourHost Called with daemon information about the server, usually at logon.
Method myInfo Called with information about the server, usually at logon.
Method luserClient Called with information about the number of connections, usually at logon.
Method bounce Called with information about where the client should reconnect.
Method isupport Called with various information about what the server supports.
Method luserChannels Called with the number of channels existant on the server.
Method luserOp Called with the number of ops logged on to the server.
Method luserMe Called with information about the server connected to.
Method joined Called when I finish joining a channel.
Method left Called when I have left a channel.
Method modeChanged Called when users or channel's modes are changed.
Method pong Called with the results of a CTCP PING query.
Method signedOn Called after sucessfully signing on to the server.
Method nickChanged Called when my nick has been changed.
Method userJoined Called when I see another user joining a channel.
Method userLeft Called when I see another user leaving a channel.
Method userQuit Called when I see another user disconnect from the network.
Method topicUpdated In channel, user changed the topic to newTopic.
Method userRenamed A user changed their name from oldname to newname.
Method receivedMOTD I received a message-of-the-day banner from the server.
Method join Join a channel.
Method leave Leave a channel.
Method kick Attempt to kick a user from a channel.
Method topic Attempt to set the topic of the given channel, or ask what it is.
Method mode Change the modes on a user or channel.
Method say Send a message to a channel
Method msg Send a message to a user or channel.
Method notice Send a notice to a user.
Method away Mark this client as away.
Method back Clear the away status.
Method whois Retrieve user information about the given nick name.
Method register Login to the server.
Method quit Disconnect from the server
Method me Strike a pose.
Method ping Measure round-trip delay to another IRC client.
Method dccSend Undocumented
Method dccResume Send a DCC RESUME request to another user.
Method dccAcceptResume Send a DCC ACCEPT response to clients who have requested a resume.
Method irc_ERR_NICKNAMEINUSE Called when we try to register an invalid nickname.
Method irc_ERR_PASSWDMISMATCH Called when the login was incorrect.
Method irc_RPL_WELCOME Called when we have received the welcome from the server.
Method irc_MODE Parse the server message when one or more modes are changed
Method irc_PING Called when some has pinged us.
Method irc_PRIVMSG Called when we get a message.
Method irc_NOTICE Called when a user gets a notice.
Method irc_KICK Called when a user is kicked from a channel.
Method irc_RPL_NOTOPIC Undocumented
Method irc_RPL_MOTDSTART Undocumented
Method irc_RPL_MOTD Undocumented
Method irc_RPL_ENDOFMOTD Undocumented
Method irc_RPL_CREATED Undocumented
Method irc_RPL_YOURHOST Undocumented
Method irc_RPL_MYINFO Undocumented
Method irc_RPL_BOUNCE Undocumented
Method irc_RPL_LUSERCLIENT Undocumented
Method irc_RPL_LUSEROP Undocumented
Method irc_RPL_LUSERCHANNELS Undocumented
Method irc_RPL_LUSERME Undocumented
Method ctcpQuery Dispatch method for any CTCP queries received.
Method ctcpQuery_ACTION Undocumented
Method ctcpQuery_PING Undocumented
Method ctcpQuery_FINGER Undocumented
Method ctcpQuery_VERSION Undocumented
Method ctcpQuery_SOURCE Undocumented
Method ctcpQuery_USERINFO Undocumented
Method ctcpQuery_CLIENTINFO A master index of what CTCP tags this client knows.
Method ctcpQuery_ERRMSG Undocumented
Method ctcpQuery_TIME Undocumented
Method ctcpQuery_DCC Initiate a Direct Client Connection
Method dcc_SEND Undocumented
Method dcc_ACCEPT Undocumented
Method dcc_RESUME Undocumented
Method dcc_CHAT Undocumented
Method dccDoSend Called when I receive a DCC SEND offer from a client.
Method dccDoResume Called when a client is trying to resume an offered file via DCC send. It should be either replied to with a DCC ACCEPT or ignored (default).
Method dccDoAcceptResume Called when a client has verified and accepted a DCC resume request made by us. By default it will do nothing.
Method dccDoChat Undocumented
Method ctcpUnknownQuery Undocumented
Method ctcpMakeReply Send one or more extended messages as a CTCP reply.
Method ctcpMakeQuery Send one or more extended messages as a CTCP query.
Method ctcpReply Dispatch method for any CTCP replies received.
Method ctcpReply_PING Undocumented
Method ctcpUnknownReply Called when a fitting ctcpReply_ method is not found.
Method badMessage When I get a message that's so broken I can't use it.
Method quirkyMessage This is called when I receive a message which is peculiar, but not wholly indecipherable.
Method dataReceived Protocol.dataReceived. Translates bytes into lines, and calls lineReceived (or rawDataReceived, depending on mode.)
Method lineReceived Override this for when each line is received.
Method handleCommand Determine the function to call for the given command and call it with the given arguments.
Method __getstate__ Undocumented
Method _reallySendLine Undocumented
Method _sendLine Undocumented

Inherited from LineReceiver (via IRCClient):

Method clearLineBuffer Clear buffered data.
Method setLineMode Sets the line-mode of this receiver.
Method setRawMode Sets the raw mode of this receiver. Further data received will be sent to rawDataReceived rather than lineReceived.
Method rawDataReceived Override this for when raw data is received.
Method lineLengthExceeded Called when the maximum line length has been reached. Override if it needs to be dealt with in some special way.

Inherited from Protocol (via IRCClient, LineReceiver):

Method connectionLost Called when the connection is shut down.

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

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

Inherited from _PauseableMixin (via IRCClient, LineReceiver):

Method pauseProducing Undocumented
Method resumeProducing Undocumented
Method stopProducing 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 2011-10-27 16:02:37.