class documentation
class CollectorClient(irc.IRCClient): (source)
A client that saves in a list the names of the methods that got called.
Method | __init__ |
No summary |
Instance Variable | methods |
Undocumented |
Instance Variable | nickname |
Undocumented |
Inherited from IRCClient
:
Method | __getstate__ |
Undocumented |
Method | action |
Called when I see a user perform an ACTION on a channel. |
Method | alter |
Generate an altered version of a nickname that caused a collision in an effort to create an unused related name for subsequent registration. |
Method | away |
Mark this client as away. |
Method | back |
Clear the away status. |
Method | bad |
When I get a message that's so broken I can't use it. |
Method | bounce |
Called with information about where the client should reconnect. |
Method | connection |
Called when the connection is shut down. |
Method | connection |
Called when a connection is made. |
Method | created |
Called with creation date information about the server, usually at logon. |
Method | ctcp |
Send one or more extended messages as a CTCP query. |
Method | ctcp |
Send one or more extended messages as a CTCP reply. |
Method | ctcp |
Dispatch method for any CTCP queries received. |
Method | ctcp |
Undocumented |
Method | ctcp |
A master index of what CTCP tags this client knows. |
Method | ctcp |
Initiate a Direct Client Connection |
Method | ctcp |
Undocumented |
Method | ctcp |
Undocumented |
Method | ctcp |
Undocumented |
Method | ctcp |
Undocumented |
Method | ctcp |
Undocumented |
Method | ctcp |
Undocumented |
Method | ctcp |
Undocumented |
Method | ctcp |
Dispatch method for any CTCP replies received. |
Method | ctcp |
Undocumented |
Method | ctcp |
Fallback handler for unrecognized CTCP queries. |
Method | ctcp |
Called when a fitting ctcpReply_ method is not found. |
Method | data |
Protocol.dataReceived. Translates bytes into lines, and calls lineReceived (or rawDataReceived, depending on mode.) |
Method | dcc_ |
Undocumented |
Method | dcc_ |
Undocumented |
Method | dcc_ |
Undocumented |
Method | dcc_ |
Undocumented |
Method | dcc |
Send a DCC ACCEPT response to clients who have requested a resume. |
Method | dcc |
Called when a client has verified and accepted a DCC resume request made by us. By default it will do nothing. |
Method | dcc |
Undocumented |
Method | dcc |
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 | dcc |
Called when I receive a DCC SEND offer from a client. |
Method | dcc |
Send a DCC RESUME request to another user. |
Method | dcc |
This is supposed to send a user a file directly. This generally doesn't work on any client, and this method is included only for backwards compatibility and completeness. |
Method | describe |
Strike a pose. |
Method | get |
Get channel modes that require parameters for correct parsing. |
Method | get |
Get user modes that require parameters for correct parsing. |
Method | handle |
Determine the function to call for the given command and call it with the given arguments. |
Method | invite |
Attempt to invite user to channel |
Method | irc_ |
Called when we try to register or change to an illegal nickname. |
Method | irc_ |
Called when we try to register or change to a nickname that is already taken. |
Method | irc_ |
Called when the login was incorrect. |
Method | irc_ |
Called when a user joins a channel. |
Method | irc_ |
Called when a user is kicked from a channel. |
Method | irc_ |
Parse a server mode change message. |
Method | irc_ |
Called when a user changes their nickname. |
Method | irc_ |
Called when a user gets a notice. |
Method | irc_ |
Called when a user leaves a channel. |
Method | irc_ |
Called when some has pinged us. |
Method | irc_ |
Called when we get a message. |
Method | irc_ |
Called when a user has quit. |
Method | irc_ |
Undocumented |
Method | irc_ |
Undocumented |
Method | irc_ |
RPL_ENDOFMOTD indicates the end of the message of the day messages. Deliver the accumulated lines to receivedMOTD. |
Method | irc_ |
Undocumented |
Method | irc_ |
Undocumented |
Method | irc_ |
Undocumented |
Method | irc_ |
Undocumented |
Method | irc_ |
Undocumented |
Method | irc_ |
Undocumented |
Method | irc_ |
Undocumented |
Method | irc_ |
Undocumented |
Method | irc_ |
Undocumented |
Method | irc_ |
Called when the topic for a channel is initially reported or when it subsequently changes. |
Method | irc_ |
Called when we have received the welcome from the server. |
Method | irc_ |
Undocumented |
Method | irc_ |
Someone in the channel set the topic. |
Method | irc |
Undocumented |
Method | isupport |
Called with various information about what the server supports. |
Method | join |
Join a channel. |
Method | joined |
Called when I finish joining a channel. |
Method | kick |
Attempt to kick a user from a channel. |
Method | kicked |
Called when I am kicked from a channel. |
Method | leave |
Leave a channel. |
Method | left |
Called when I have left a channel. |
Method | line |
Override this for when each line is received. |
Method | luser |
Called with the number of channels existent on the server. |
Method | luser |
Called with information about the number of connections, usually at logon. |
Method | luser |
Called with information about the server connected to. |
Method | luser |
Called with the number of ops logged on to the server. |
Method | mode |
Change the modes on a user or channel. |
Method | mode |
Called when users or channel's modes are changed. |
Method | msg |
Send a message to a user or channel. |
Method | my |
Called with information about the server, usually at logon. |
Method | nick |
Called when my nick has been changed. |
Method | notice |
Send a notice to a user. |
Method | noticed |
Called when I have a notice from a user to me or a channel. |
Method | ping |
Measure round-trip delay to another IRC client. |
Method | pong |
Called with the results of a CTCP PING query. |
Method | privmsg |
Called when I have a message from a user to me or a channel. |
Method | quirky |
This is called when I receive a message which is peculiar, but not wholly indecipherable. |
Method | quit |
Disconnect from the server |
Method | received |
I received a message-of-the-day banner from the server. |
Method | register |
Login to the server. |
Method | say |
Send a message to a channel |
Method | send |
Sends a line to the other end of the connection. |
Method | set |
Set this client's nickname. |
Method | signed |
Called after successfully signing on to the server. |
Method | start |
Start sending PING messages every IRCClient.heartbeatInterval seconds to keep the connection to the server alive during periods of no activity. |
Method | stop |
Stop sending PING messages to keep the connection to the server alive. |
Method | topic |
Attempt to set the topic of the given channel, or ask what it is. |
Method | topic |
In channel, user changed the topic to newTopic. |
Method | user |
Called when I see another user joining a channel. |
Method | user |
Called when I observe someone else being kicked from a channel. |
Method | user |
Called when I see another user leaving a channel. |
Method | user |
Called when I see another user disconnect from the network. |
Method | user |
A user changed their name from oldname to newname. |
Method | whois |
Retrieve user information about the given nickname. |
Method | your |
Called with daemon information about the server, usually at logon. |
Class Variable | __pychecker__ |
Undocumented |
Class Variable | dcc |
Undocumented |
Class Variable | delimiter |
Undocumented |
Class Variable | perform |
Undocumented |
Instance Variable | dcc |
Undocumented |
Instance Variable | erroneous |
Default nickname assigned when an unregistered client triggers an ERR_ERRONEUSNICKNAME while trying to register with an illegal nickname. |
Instance Variable | finger |
Sent in reply to a FINGER CTCP query. If None , no FINGER reply will be sent. |
Instance Variable | heartbeat |
Interval, in seconds, to send PING messages to the server as a form of keepalive, defaults to 120 seconds. Use None to disable the heartbeat. |
Instance Variable | hostname |
Host name of the IRC server the client is connected to. Initially the host name is None and later is set to the host name from which the RPL_WELCOME message is received. |
Instance Variable | line |
Minimum delay between lines sent to the server. If None , no delay will be imposed. |
Instance Variable | motd |
Either None or, between receipt of RPL_MOTDSTART and RPL_ENDOFMOTD, a list of str , each of which is the content of an RPL_MOTD message. |
Instance Variable | password |
Password used to log on to the server. May be None . |
Instance Variable | realname |
Supplied to the server during login as the "Real name" or "ircname". May be None . |
Instance Variable | source |
CTCP SOURCE reply, a URL where the source code of this client may be found. If None , no SOURCE reply will be sent. |
Instance Variable | supported |
Available ISUPPORT features on the server |
Instance Variable | userinfo |
Sent in reply to a USERINFO CTCP query. If None , no USERINFO reply will be sent. "This is used to transmit a string which is settable by the user (and never should be set by the client)." |
Instance Variable | username |
Supplied to the server during login as the "User name". May be None |
Instance Variable | version |
CTCP VERSION reply, environment the client is running in. |
Instance Variable | version |
CTCP VERSION reply, client name. If None , no VERSION reply will be sent. |
Instance Variable | version |
CTCP VERSION reply, client version. |
Method | _create |
Create the heartbeat LoopingCall . |
Method | _really |
Undocumented |
Method | _safe |
Estimate a safe maximum line length for the given command. |
Method | _send |
Send a PING message to the IRC server as a form of keepalive. |
Method | _send |
Undocumented |
Method | _send |
Send a message or notice to a user or channel. |
Constant | _MAX |
Undocumented |
Instance Variable | _attempted |
The nickname that will try to get registered. It may change if it is illegal or already taken. nickname becomes the _attemptedNick that is successfully registered. |
Instance Variable | _heartbeat |
Looping call to perform the keepalive by calling IRCClient._sendHeartbeat every heartbeatInterval seconds, or None if there is no heartbeat. |
Instance Variable | _pings |
Undocumented |
Instance Variable | _queue |
Undocumented |
Instance Variable | _queue |
Undocumented |
Instance Variable | _registered |
Whether or not the user is registered. It becomes True once a welcome has been received from the server. |
Inherited from LineReceiver
(via IRCClient
):
Method | clear |
Clear buffered data. |
Method | line |
Called when the maximum line length has been reached. Override if it needs to be dealt with in some special way. |
Method | raw |
Override this for when raw data is received. |
Method | set |
Sets the line-mode of this receiver. |
Method | set |
Sets the raw mode of this receiver. Further data received will be sent to rawDataReceived rather than lineReceived. |
Constant | MAX |
The maximum length of a line to allow (If a sent line is longer than this, the connection is dropped). Default is 16384. |
Instance Variable | line |
Undocumented |
Instance Variable | _buffer |
Undocumented |
Instance Variable | _busy |
Undocumented |
Inherited from Protocol
(via IRCClient
, LineReceiver
):
Method | log |
Return a prefix matching the class name, to identify log messages related to this protocol instance. |
Class Variable | factory |
Undocumented |
Inherited from BaseProtocol
(via IRCClient
, LineReceiver
, Protocol
):
Method | make |
Make a connection to a transport and a server. |
Instance Variable | connected |
Undocumented |
Instance Variable | transport |
Undocumented |
Inherited from _PauseableMixin
(via IRCClient
, LineReceiver
, Protocol
, BaseProtocol
):
Method | pause |
Undocumented |
Method | resume |
Undocumented |
Method | stop |
Undocumented |
Instance Variable | paused |
Undocumented |