WormbotReporter.WIR_IRCBase

/******************************************************************************
Copyright (c) 2005-2007 by Wormbo <wormbo@online.de>
$Id$

Abstract base class for an IRC client. Defines all the constants specified in RFC 1459 "Internet Relay Chat Protocol".
******************************************************************************/


class WIR_IRCBase extends TCPLink
    abstract;


//=============================================================================
// Constants
//=============================================================================

//-----------------------------------------------------------------------------
// Errors
//-----------------------------------------------------------------------------

/**
"<nickname> :No such nick/channel"
Used to indicate the nickname parameter supplied to a command is currently unused.
*/
const ERR_NOSUCHNICK        = 401;
/**
"<server name> :No such server"
Used to indicate the server name given currently doesn't exist.
*/
const ERR_NOSUCHSERVER      = 402;
/**
"<channel name> :No such channel"
Used to indicate the given channel name is invalid.
*/
const ERR_NOSUCHCHANNEL     = 403;
/**
"<channel name> :Cannot send to channel"
Sent to a user who is either (a) not on a channel which is mode +n or (b) not a chanop (or mode +v) on a channel which has mode +m set and is trying to send a PRIVMSG message to that channel.
*/
const ERR_CANNOTSENDTOCHAN  = 404;
/**
"<channel name> :You have joined too many channels"
Sent to a user when they have joined the maximum number of allowed channels and they try to join another channel.
*/
const ERR_TOOMANYCHANNELS   = 405;
/**
"<nickname> :There was no such nickname"
Returned by WHOWAS to indicate there is no history information for that nickname.
*/
const ERR_WASNOSUCHNICK     = 406;
/**
"<target> :Duplicate recipients. No message delivered"
Returned to a client which is attempting to send PRIVMSG/NOTICE using the user@host destination format and for a user@host which has several occurrences.
*/
const ERR_TOOMANYTARGETS    = 407;
/**
":No origin specified"
PING or PONG message missing the originator parameter which is required since these commands must work without valid prefixes.
*/
const ERR_NOORIGIN          = 409;

/**
":No recipient given (<command>)"
Returned by PRIVMSG to indicate that the message wasn't delivered for some reason.
*/
const ERR_NORECIPIENT   = 411;
/**
":No text to send"
Returned by PRIVMSG to indicate that the message wasn't delivered for some reason.
*/
const ERR_NOTEXTTOSEND  = 412;
/**
"<mask> :No toplevel domain specified"
Returned by PRIVMSG to indicate that the message wasn't delivered for some reason. ERR_NOTOPLEVEL is an error that is returned when an invalid use of "PRIVMSG $<server>" or "PRIVMSG #<host>" is attempted.
*/
const ERR_NOTOPLEVEL    = 413;
/**
"<mask> :Wildcard in toplevel domain"
Returned by PRIVMSG to indicate that the message wasn't delivered for some reason. ERR_WILDTOPLEVEL is an error that is returned when an invalid use of "PRIVMSG $<server>" or "PRIVMSG #<host>" is attempted.
*/
const ERR_WILDTOPLEVEL  = 414;

/**
"<command> :Unknown command"
Returned to a registered client to indicate that the command sent is unknown by the server.
*/
const ERR_UNKNOWNCOMMAND  = 421;
/**
":MOTD File is missing"
Server's MOTD file could not be opened by the server.
*/
const ERR_NOMOTD          = 422;
/**
"<server> :No administrative info available"
Returned by a server in response to an ADMIN message when there is an error in finding the appropriate information.
*/
const ERR_NOADMININFO     = 423;
/**
":File error doing <file op> on <file>"
Generic error message used to report a failed file operation during the processing of a message.
*/
const ERR_FILEERROR       = 424;

/**
":No nickname given"
Returned when a nickname parameter expected for a command and isn't found.
*/
const ERR_NONICKNAMEGIVEN   = 431;
/**
"<nick> :Erroneus nickname"
Returned after receiving a NICK message which contains characters which do not fall in the defined set. See section x.x.x for details on valid nicknames.
*/
const ERR_ERRONEUSNICKNAME  = 432;
/**
"<nick> :Nickname is already in use"
Returned when a NICK message is processed that results in an attempt to change to a currently existing nickname.
*/
const ERR_NICKNAMEINUSE     = 433;
/**
"<nick> :Nickname collision KILL"
Returned by a server to a client when it detects a nickname collision (registered of a NICK that already exists by another server).
*/
const ERR_NICKCOLLISION     = 436;

/**
"<nick> <channel> :They aren't on that channel"
Returned by the server to indicate that the target user of the command is not on the given channel.
*/
const ERR_USERNOTINCHANNEL  = 441;
/**
"<channel> :You're not on that channel"
Returned by the server whenever a client tries to perform a channel effecting command for which the client isn't a member.
*/
const ERR_NOTONCHANNEL      = 442;
/**
"<user> <channel> :is already on channel"
Returned when a client tries to invite a user to a channel they are already on.
*/
const ERR_USERONCHANNEL     = 443;
/**
"<user> :User not logged in"
Returned by the summon after a SUMMON command for a user was unable to be performed since they were not logged in.
*/
const ERR_NOLOGIN           = 444;
/**
":SUMMON has been disabled"
Returned as a response to the SUMMON command. Must be returned by any server which does not implement it.
*/
const ERR_SUMMONDISABLED    = 445;
/**
":USERS has been disabled"
Returned as a response to the USERS command. Must be returned by any server which does not implement it.
*/
const ERR_USERSDISABLED     = 446;

/**
":You have not registered"
Returned by the server to indicate that the client must be registered before the server will allow it to be parsed in detail.
*/
const ERR_NOTREGISTERED = 451;

/**
"<command> :Not enough parameters"
Returned by the server by numerous commands to indicate to the client that it didn't supply enough parameters.
*/
const ERR_NEEDMOREPARAMS    = 461;
/**
":You may not reregister"
Returned by the server to any link which tries to change part of the registered details (such as password or user details from second USER message).
*/
const ERR_ALREADYREGISTRED  = 462;
/**
":Your host isn't among the privileged"
Returned to a client which attempts to register with a server which does not been setup to allow connections from the host the attempted connection is tried.
*/
const ERR_NOPERMFORHOST     = 463;
/**
":Password incorrect"
Returned to indicate a failed attempt at registering a connection for which a password was required and was either not given or incorrect.
*/
const ERR_PASSWDMISMATCH    = 464;
/**
":You are banned from this server"
Returned after an attempt to connect and register yourself with a server which has been setup to explicitly deny connections to you.
*/
const ERR_YOUREBANNEDCREEP  = 465;
/**
"<channel> :Channel key already set"
*/
const ERR_KEYSET            = 467;

/**
"<channel> :Cannot join channel (+l)"
*/
const ERR_CHANNELISFULL   = 471;
/**
"<char> :is unknown mode char to me"
*/
const ERR_UNKNOWNMODE     = 472;
/**
"<channel> :Cannot join channel (+i)"
*/
const ERR_INVITEONLYCHAN  = 473;
/**
"<channel> :Cannot join channel (+b)"
*/
const ERR_BANNEDFROMCHAN  = 474;
/**
"<channel> :Cannot join channel (+k)"
*/
const ERR_BADCHANNELKEY   = 475;

/**
":Permission Denied- You're not an IRC operator"
Any command requiring operator privileges to operate must return this error to indicate the attempt was unsuccessful.
*/
const ERR_NOPRIVILEGES      = 481;
/**
"<channel> :You're not channel operator"
Any command requiring 'chanop' privileges (such as MODE messages) must return this error if the client making the attempt is not a chanop on the specified channel.
*/
const ERR_CHANOPRIVSNEEDED  = 482;
/**
":You cant kill a server!"
Any attempts to use the KILL command on a server are to be refused and this error returned directly to the client.
*/
const ERR_CANTKILLSERVER    = 483;

/**
":No O-lines for your host"
If a client sends an OPER message and the server has not been configured to allow connections from the client's host as an operator, this error must be returned.
*/
const ERR_NOOPERHOST  = 491;

/**
":Unknown MODE flag"
Returned by the server to indicate that a MODE message was sent with a nickname parameter and that the a mode flag sent was not recognized.
*/
const ERR_UMODEUNKNOWNFLAG  = 501;
/**
":Cant change mode for other users"
Error sent to any user trying to view or change the user mode for a user other than themselves.
*/
const ERR_USERSDONTMATCH    = 502;


//-----------------------------------------------------------------------------
// Command responses
//-----------------------------------------------------------------------------

/**
Dummy reply number. Not used.
*/
const RPL_NONE  = 300;

/**
":[<reply>{<space><reply>}]"
Reply format used by USERHOST to list replies to the query list. The reply string is composed as follows:
<reply> ::= <nick>['*'] '=' <'+'|'-'><hostname>
The '*' indicates whether the client has registered as an Operator. The '-' or '+' characters represent whether the client has set an AWAY message or not respectively.
*/
const RPL_USERHOST  = 302;
/**
":[<nick> {<space><nick>}]"
Reply format used by ISON to list replies to the query list.
*/
const RPL_ISON      = 303;

/**
"<nick> :<away message>"
This reply is used with the AWAY command (if allowed). RPL_AWAY is sent to any client sending a PRIVMSG to a client which is away. RPL_AWAY is only sent by the server to which the client is connected.
*/
const RPL_AWAY    = 301;
/**
":You are no longer marked as being away"
This reply is used with the AWAY command (if allowed). RPL_UNAWAY is sent when the client sets an AWAY message.
*/
const RPL_UNAWAY  = 305;
/**
":You have been marked as being away"
This reply is used with the AWAY command (if allowed). RPL_NOWAWAY is sent when the client removes an AWAY message.
*/
const RPL_NOWAWAY = 306;

/**
"<nick> <user> <host> * :<real name>"
Replies 311 - 313, 317 - 319 are all replies generated in response to a WHOIS message. Given that there are enough parameters present, the answering server must either formulate a reply out of the above numerics (if the query nick is found) or return an error reply. The '*' in RPL_WHOISUSER is there as the literal character and not as a wild card. For each reply set, only RPL_WHOISCHANNELS may appear more than once (for long lists of channel names). The '@' and '+' characters next to the channel name indicate whether a client is a channel operator or has been granted permission to speak on a moderated channel. The RPL_ENDOFWHOIS reply is used to mark the end of processing a WHOIS message.
*/
const RPL_WHOISUSER = 311;
/**
"<nick> <server> :<server info>"
Replies 311 - 313, 317 - 319 are all replies generated in response to a WHOIS message. Given that there are enough parameters present, the answering server must either formulate a reply out of the above numerics (if the query nick is found) or return an error reply. The '*' in RPL_WHOISUSER is there as the literal character and not as a wild card. For each reply set, only RPL_WHOISCHANNELS may appear more than once (for long lists of channel names). The '@' and '+' characters next to the channel name indicate whether a client is a channel operator or has been granted permission to speak on a moderated channel. The RPL_ENDOFWHOIS reply is used to mark the end of processing a WHOIS message.
*/
const RPL_WHOISSERVER   = 312;
/**
"<nick> :is an IRC operator"
Replies 311 - 313, 317 - 319 are all replies generated in response to a WHOIS message. Given that there are enough parameters present, the answering server must either formulate a reply out of the above numerics (if the query nick is found) or return an error reply. The '*' in RPL_WHOISUSER is there as the literal character and not as a wild card. For each reply set, only RPL_WHOISCHANNELS may appear more than once (for long lists of channel names). The '@' and '+' characters next to the channel name indicate whether a client is a channel operator or has been granted permission to speak on a moderated channel. The RPL_ENDOFWHOIS reply is used to mark the end of processing a WHOIS message.
*/
const RPL_WHOISOPERATOR = 313;
/**
"<nick> <integer> :seconds idle"
Replies 311 - 313, 317 - 319 are all replies generated in response to a WHOIS message. Given that there are enough parameters present, the answering server must either formulate a reply out of the above numerics (if the query nick is found) or return an error reply. The '*' in RPL_WHOISUSER is there as the literal character and not as a wild card. For each reply set, only RPL_WHOISCHANNELS may appear more than once (for long lists of channel names). The '@' and '+' characters next to the channel name indicate whether a client is a channel operator or has been granted permission to speak on a moderated channel. The RPL_ENDOFWHOIS reply is used to mark the end of processing a WHOIS message.
*/
const RPL_WHOISIDLE     = 317;
/**
"<nick> :End of /WHOIS list"
Replies 311 - 313, 317 - 319 are all replies generated in response to a WHOIS message. Given that there are enough parameters present, the answering server must either formulate a reply out of the above numerics (if the query nick is found) or return an error reply. The '*' in RPL_WHOISUSER is there as the literal character and not as a wild card. For each reply set, only RPL_WHOISCHANNELS may appear more than once (for long lists of channel names). The '@' and '+' characters next to the channel name indicate whether a client is a channel operator or has been granted permission to speak on a moderated channel. The RPL_ENDOFWHOIS reply is used to mark the end of processing a WHOIS message.
*/
const RPL_ENDOFWHOIS    = 318;
/**
<nick> :{[@|+]<channel><space>}"
Replies 311 - 313, 317 - 319 are all replies generated in response to a WHOIS message. Given that there are enough parameters present, the answering server must either formulate a reply out of the above numerics (if the query nick is found) or return an error reply. The '*' in RPL_WHOISUSER is there as the literal character and not as a wild card. For each reply set, only RPL_WHOISCHANNELS may appear more than once (for long lists of channel names). The '@' and '+' characters next to the channel name indicate whether a client is a channel operator or has been granted permission to speak on a moderated channel. The RPL_ENDOFWHOIS reply is used to mark the end of processing a WHOIS message.
*/
const RPL_WHOISCHANNELS = 319;

/**
"<nick> <user> <host> * :<real name>"
When replying to a WHOWAS message, a server must use the replies RPL_WHOWASUSER, RPL_WHOISSERVER or ERR_WASNOSUCHNICK for each nickname in the presented list. At the end of all reply batches, there must be RPL_ENDOFWHOWAS (even if there was only one reply and it was an error).
*/
const RPL_WHOWASUSER  = 314;
/**
"<nick> :End of WHOWAS"
When replying to a WHOWAS message, a server must use the replies RPL_WHOWASUSER, RPL_WHOISSERVER or ERR_WASNOSUCHNICK for each nickname in the presented list. At the end of all reply batches, there must be RPL_ENDOFWHOWAS (even if there was only one reply and it was an error).
*/
const RPL_ENDOFWHOWAS = 369;

/**
"Channel :Users Name"
Replies RPL_LISTSTART, RPL_LIST, RPL_LISTEND mark the start, actual replies with data and end of the server's response to a LIST command. If there are no channels available to return, only the start and end reply must be sent.
*/
const RPL_LISTSTART = 321;
/**
"<channel> <# visible> :<topic>"
Replies RPL_LISTSTART, RPL_LIST, RPL_LISTEND mark the start, actual replies with data and end of the server's response to a LIST command. If there are no channels available to return, only the start and end reply must be sent.
*/
const RPL_LIST      = 322;
/**
":End of /LIST"
Replies RPL_LISTSTART, RPL_LIST, RPL_LISTEND mark the start, actual replies with data and end of the server's response to a LIST command. If there are no channels available to return, only the start and end reply must be sent.
*/
const RPL_LISTEND   = 323;

/**
"<channel> <mode> <mode params>"
*/
const RPL_CHANNELMODEIS = 324;

/**
<channel> :No topic is set"
When sending a TOPIC message to determine the channel topic, one of two replies is sent. If the topic is set, RPL_TOPIC is sent back else RPL_NOTOPIC.
*/
const RPL_NOTOPIC = 331;
/**
"<channel> :<topic>"
When sending a TOPIC message to determine the channel topic, one of two replies is sent. If the topic is set, RPL_TOPIC is sent back else RPL_NOTOPIC.
*/
const RPL_TOPIC   = 332;

/**
"<channel> <nick>"
Returned by the server to indicate that the attempted INVITE message was successful and is being passed onto the end client.
*/
const RPL_INVITING = 341;

/**
"<user> :Summoning user to IRC"
Returned by a server answering a SUMMON message to indicate that it is summoning that user.
*/
const RPL_SUMMONING = 342;

/**
"<version>.<debuglevel> <server> :<comments>"
Reply by the server showing its version details. The <version> is the version of the software being used (including any patchlevel revisions) and the <debuglevel> is used to indicate if the server is running in "debug mode".
The "comments" field may contain any comments about the version or further version details.
*/
const RPL_VERSION = 351;

/**
"<channel> <user> <host> <server> <nick> <H|G>[*][@|+] :<hopcount> <real name>"
The RPL_WHOREPLY and RPL_ENDOFWHO pair are used to answer a WHO message. The RPL_WHOREPLY is only sent if there is an appropriate match to the WHO query. If there is a list of parameters supplied with a WHO message, a RPL_ENDOFWHO must be sent after processing each list item with <name> being the item.
*/
const RPL_WHOREPLY = 351;
/**
"<name> :End of /WHO list"
The RPL_WHOREPLY and RPL_ENDOFWHO pair are used to answer a WHO message. The RPL_WHOREPLY is only sent if there is an appropriate match to the WHO query. If there is a list of parameters supplied with a WHO message, a RPL_ENDOFWHO must be sent after processing each list item with <name> being the item.
*/
const RPL_ENDOFWHO = 315;

/**
"<channel> :[[@|+]<nick> [[@|+]<nick> [...]]]"
To reply to a NAMES message, a reply pair consisting of RPL_NAMREPLY and RPL_ENDOFNAMES is sent by the server back to the client. If there is no channel found as in the query, then only RPL_ENDOFNAMES is returned. The exception to this is when a NAMES message is sent with no parameters and all visible channels and contents are sent back in a series of RPL_NAMEREPLY messages with a RPL_ENDOFNAMES to mark the end.
*/
const RPL_NAMEREPLY = 353;
/**
"<channel> :End of /NAMES list"
To reply to a NAMES message, a reply pair consisting of RPL_NAMREPLY and RPL_ENDOFNAMES is sent by the server back to the client. If there is no channel found as in the query, then only RPL_ENDOFNAMES is returned. The exception to this is when a NAMES message is sent with no parameters and all visible channels and contents are sent back in a series of RPL_NAMEREPLY messages with a RPL_ENDOFNAMES to mark the end.
*/
const RPL_ENDOFNAMES = 366;

/**
"<mask> <server> :<hopcount> <server info>"
In replying to the LINKS message, a server must send replies back using the RPL_LINKS numeric and mark the end of the list using an RPL_ENDOFLINKS reply.
*/
const RPL_LINKS = 364;
/**
"<mask> :End of /LINKS list"
In replying to the LINKS message, a server must send replies back using the RPL_LINKS numeric and mark the end of the list using an RPL_ENDOFLINKS reply.
*/
const RPL_ENDOFLINKS = 365;

/**
"<channel> <banid>"
When listing the active 'bans' for a given channel, a server is required to send the list back using the RPL_BANLIST and RPL_ENDOFBANLIST messages. A separate RPL_BANLIST is sent for each active banid. After the banids have been listed (or if none present) a RPL_ENDOFBANLIST must be sent.
*/
const RPL_BANLIST = 367;
/**
"<channel> :End of channel ban list"
When listing the active 'bans' for a given channel, a server is required to send the list back using the RPL_BANLIST and RPL_ENDOFBANLIST messages. A separate RPL_BANLIST is sent for each active banid. After the banids have been listed (or if none present) a RPL_ENDOFBANLIST must be sent.
*/
const RPL_ENDOFBANLIST = 368;

/**
":<string>"
A server responding to an INFO message is required to send all its 'info' in a series of RPL_INFO messages with a RPL_ENDOFINFO reply to indicate the end of the replies.
*/
const RPL_INFO = 371;
/**
":End of /INFO list"
A server responding to an INFO message is required to send all its 'info' in a series of RPL_INFO messages with a RPL_ENDOFINFO reply to indicate the end of the replies.
*/
const RPL_ENDOFINFO = 374;

/**
":- <server> Message of the day - "
When responding to the MOTD message and the MOTD file is found, the file is displayed line by line, with each line no longer than 80 characters, using RPL_MOTD format replies. These should be surrounded by a RPL_MOTDSTART (before the RPL_MOTDs) and an RPL_ENDOFMOTD (after).
*/
const RPL_MOTDSTART = 375;
/**
:- <text>"
When responding to the MOTD message and the MOTD file is found, the file is displayed line by line, with each line no longer than 80 characters, using RPL_MOTD format replies. These should be surrounded by a RPL_MOTDSTART (before the RPL_MOTDs) and an RPL_ENDOFMOTD (after).
*/
const RPL_MOTD = 372;
/**
":End of /MOTD command"
When responding to the MOTD message and the MOTD file is found, the file is displayed line by line, with each line no longer than 80 characters, using RPL_MOTD format replies. These should be surrounded by a RPL_MOTDSTART (before the RPL_MOTDs) and an RPL_ENDOFMOTD (after).
*/
const RPL_ENDOFMOTD = 376;

/**
":You are now an IRC operator"
RPL_YOUREOPER is sent back to a client which has just successfully issued an OPER message and gained operator status.
*/
const RPL_YOUREOPER = 381;
/**
"<config file> :Rehashing"
If the REHASH option is used and an operator sends a REHASH message, an RPL_REHASHING is sent back to the operator.
*/
const RPL_REHASHING = 382;

/**
"<server> :<string showing server's local time>"
When replying to the TIME message, a server must send the reply using the RPL_TIME format above. The string showing the time need only contain the correct day and time there. There is no further requirement for the time string.
*/
const RPL_TIME = 391;

/**
":UserID Terminal Host"
If the USERS message is handled by a server, the replies RPL_USERSTART, RPL_USERS, RPL_ENDOFUSERS and RPL_NOUSERS are used. RPL_USERSSTART must be sent first, following by either a sequence of RPL_USERS or a single RPL_NOUSER. Following this is RPL_ENDOFUSERS.
*/
const RPL_USERSSTART = 392;
/**
":%-8s %-9s %-8s"
If the USERS message is handled by a server, the replies RPL_USERSTART, RPL_USERS, RPL_ENDOFUSERS and RPL_NOUSERS are used. RPL_USERSSTART must be sent first, following by either a sequence of RPL_USERS or a single RPL_NOUSER. Following this is RPL_ENDOFUSERS.
*/
const RPL_USERS = 393;
/**
":End of users"
If the USERS message is handled by a server, the replies RPL_USERSTART, RPL_USERS, RPL_ENDOFUSERS and RPL_NOUSERS are used. RPL_USERSSTART must be sent first, following by either a sequence of RPL_USERS or a single RPL_NOUSER. Following this is RPL_ENDOFUSERS.
*/
const RPL_ENDOFUSERS = 394;
/**
":Nobody logged in"
If the USERS message is handled by a server, the replies RPL_USERSTART, RPL_USERS, RPL_ENDOFUSERS and RPL_NOUSERS are used. RPL_USERSSTART must be sent first, following by either a sequence of RPL_USERS or a single RPL_NOUSER. Following this is RPL_ENDOFUSERS.
*/
const RPL_NOUSERS = 395;

/**
"Link <version & debug level> <destination> <next server>"
The RPL_TRACE* are all returned by the server in response to the TRACE message. How many are returned is dependent on the the TRACE message and whether it was sent by an operator or not. There is no predefined order for which occurs first. RPL_TRACELINK is sent by any server which handles a TRACE message and has to pass it on to another server. The list of RPL_TRACELINKs sent in response to a TRACE command traversing the IRC network should reflect the actual connectivity of the servers themselves along that path.
*/
const RPL_TRACELINK       = 200;
/**
"Try. <class> <server>"
The RPL_TRACE* are all returned by the server in response to the TRACE message. How many are returned is dependent on the the TRACE message and whether it was sent by an operator or not. There is no predefined order for which occurs first. Replies RPL_TRACEUNKNOWN, RPL_TRACECONNECTING and RPL_TRACEHANDSHAKE are all used for connections which have not been fully established and are either unknown, still attempting to connect or in the process of completing the 'server handshake'.
*/
const RPL_TRACECONNECTING = 201;
/**
"H.S. <class> <server>"
The RPL_TRACE* are all returned by the server in response to the TRACE message. How many are returned is dependent on the the TRACE message and whether it was sent by an operator or not. There is no predefined order for which occurs first. Replies RPL_TRACEUNKNOWN, RPL_TRACECONNECTING and RPL_TRACEHANDSHAKE are all used for connections which have not been fully established and are either unknown, still attempting to connect or in the process of completing the 'server handshake'.
*/
const RPL_TRACEHANDSHAKE  = 202;
/**
"???? <class> [<client IP address in dot form>]"
The RPL_TRACE* are all returned by the server in response to the TRACE message. How many are returned is dependent on the the TRACE message and whether it was sent by an operator or not. There is no predefined order for which occurs first. Replies RPL_TRACEUNKNOWN, RPL_TRACECONNECTING and RPL_TRACEHANDSHAKE are all used for connections which have not been fully established and are either unknown, still attempting to connect or in the process of completing the 'server handshake'.
*/
const RPL_TRACEUNKNOWN    = 203;
/**
"Oper <class> <nick>"
The RPL_TRACE* are all returned by the server in response to the TRACE message. How many are returned is dependent on the the TRACE message and whether it was sent by an operator or not. There is no predefined order for which occurs first.
*/
const RPL_TRACEOPERATOR   = 204;
/**
"User <class> <nick>"
The RPL_TRACE* are all returned by the server in response to the TRACE message. How many are returned is dependent on the the TRACE message and whether it was sent by an operator or not. There is no predefined order for which occurs first.
*/
const RPL_TRACEUSER       = 205;
/**
"Serv <class> <int>S <int>C <server> <nick!user|*!*>@<host|server>"
The RPL_TRACE* are all returned by the server in response to the TRACE message. How many are returned is dependent on the the TRACE message and whether it was sent by an operator or not. There is no predefined order for which occurs first.
*/
const RPL_TRACESERVER     = 206;
/**
"<newtype> 0 <client name>"
The RPL_TRACE* are all returned by the server in response to the TRACE message. How many are returned is dependent on the the TRACE message and whether it was sent by an operator or not. There is no predefined order for which occurs first. RPL_TRACENEWTYPE is to be used for any connection which does not fit in the other categories but is being displayed anyway.
*/
const RPL_TRACENEWTYPE    = 208;
/**
"File <logfile> <debug level>"
The RPL_TRACE* are all returned by the server in response to the TRACE message. How many are returned is dependent on the the TRACE message and whether it was sent by an operator or not. There is no predefined order for which occurs first.
*/
const RPL_TRACELOG        = 269;

/**
"<linkname> <sendq> <sent messages> <sent bytes> <received messages> <received bytes> <time open>"
*/
const RPL_STATSLINKINFO = 211;
/**
"<command> <count>"
*/
const RPL_STATSCOMMANDS = 212;
/**
"C <host> * <name> <port> <class>"
*/
const RPL_STATSCLINE    = 213;
/**
"N <host> * <name> <port> <class>"
*/
const RPL_STATSNLINE    = 214;
/**
"I <host> * <host> <port> <class>"
*/
const RPL_STATSILINE    = 215;
/**
"K <host> * <username> <port> <class>"
*/
const RPL_STATSKLINE    = 216;
/**
"Y <class> <ping frequency> <connect frequency> <max sendq>"
*/
const RPL_STATSYLINE    = 218;
/**
"<stats letter> :End of /STATS report"
*/
const RPL_ENDOFSTATS    = 219;
/**
"L <hostmask> * <servername> <maxdepth>"
*/
const RPL_STATSLLINE    = 241;
/**
":Server Up %d days %d:%02d:%02d"
*/
const RPL_STATSUPTIME   = 242;
/**
"O <hostmask> * <name>"
*/
const RPL_STATSOLINE    = 243;

/**
"<user mode string>"
To answer a query about a client's own mode, RPL_UMODEIS is sent back.
*/
const RPL_UMODEIS = 221;

/**
":There are <integer> users and <integer> invisible on <integer> servers"
In processing an LUSERS message, the server sends a set of replies from RPL_LUSERCLIENT, RPL_LUSEROP, RPL_USERUNKNOWN, RPL_LUSERCHANNELS and RPL_LUSERME. When replying, a server must send back RPL_LUSERCLIENT and RPL_LUSERME. The other replies are only sent back if a non-zero count is found for them.
*/
const RPL_LUSERCLIENT = 251;
/**
"<integer> :operator(s) online"
In processing an LUSERS message, the server sends a set of replies from RPL_LUSERCLIENT, RPL_LUSEROP, RPL_USERUNKNOWN, RPL_LUSERCHANNELS and RPL_LUSERME. When replying, a server must send back RPL_LUSERCLIENT and RPL_LUSERME. The other replies are only sent back if a non-zero count is found for them.
*/
const RPL_LUSEROP = 252;
/**
"<integer> :unknown connection(s)"
In processing an LUSERS message, the server sends a set of replies from RPL_LUSERCLIENT, RPL_LUSEROP, RPL_USERUNKNOWN, RPL_LUSERCHANNELS and RPL_LUSERME. When replying, a server must send back RPL_LUSERCLIENT and RPL_LUSERME. The other replies are only sent back if a non-zero count is found for them.
*/
const RPL_LUSERUNKNOWN = 253;
/**
"<integer> :channels formed"
In processing an LUSERS message, the server sends a set of replies from RPL_LUSERCLIENT, RPL_LUSEROP, RPL_USERUNKNOWN, RPL_LUSERCHANNELS and RPL_LUSERME. When replying, a server must send back RPL_LUSERCLIENT and RPL_LUSERME. The other replies are only sent back if a non-zero count is found for them.
*/
const RPL_LUSERCHANNELS = 254;
/**
":I have <integer> clients and <integer> servers"
In processing an LUSERS message, the server sends a set of replies from RPL_LUSERCLIENT, RPL_LUSEROP, RPL_USERUNKNOWN, RPL_LUSERCHANNELS and RPL_LUSERME. When replying, a server must send back RPL_LUSERCLIENT and RPL_LUSERME. The other replies are only sent back if a non-zero count is found for them.
*/
const RPL_LUSERME = 255;

/**
"<server> :Administrative info"
When replying to an ADMIN message, a server is expected to use replies RLP_ADMINME through to RPL_ADMINEMAIL and provide a text message with each. For RPL_ADMINLOC1 a description of what city, state and country the server is in is expected, followed by details of the university and department (RPL_ADMINLOC2) and finally the administrative contact for the server (an email address here is required) in RPL_ADMINEMAIL.
*/
const RPL_ADMINME = 256;
/**
":<admin info>"
When replying to an ADMIN message, a server is expected to use replies RLP_ADMINME through to RPL_ADMINEMAIL and provide a text message with each. For RPL_ADMINLOC1 a description of what city, state and country the server is in is expected, followed by details of the university and department (RPL_ADMINLOC2) and finally the administrative contact for the server (an email address here is required) in RPL_ADMINEMAIL.
*/
const RPL_ADMINLOC1 = 257;
/**
":<admin info>"
When replying to an ADMIN message, a server is expected to use replies RLP_ADMINME through to RPL_ADMINEMAIL and provide a text message with each. For RPL_ADMINLOC1 a description of what city, state and country the server is in is expected, followed by details of the university and department (RPL_ADMINLOC2) and finally the administrative contact for the server (an email address here is required) in RPL_ADMINEMAIL.
*/
const RPL_ADMINLOC2 = 258;
/**
":<admin info>"
When replying to an ADMIN message, a server is expected to use replies RLP_ADMINME through to RPL_ADMINEMAIL and provide a text message with each. For RPL_ADMINLOC1 a description of what city, state and country the server is in is expected, followed by details of the university and department (RPL_ADMINLOC2) and finally the administrative contact for the server (an email address here is required) in RPL_ADMINEMAIL.
*/
const RPL_ADMINEMAIL = 259;