libircpp
Version: 0.0.1
 All Classes Namespaces Functions Variables Enumerations Enumerator Pages
Namespaces | Classes | Enumerations
irc Namespace Reference

Detailed Description

irc is the top level namespace of libircpp, this contains all of the compoents required to use the library.

Namespaces

 ctcp
 CTCP namespace.
 

Classes

class  channel
 IRC channel class. More...
 
class  connection
 IRC connection class. More...
 
struct  message
 IRC message struct. More...
 
struct  prefix
 irc::message prefix. More...
 
class  session
 IRC session class. More...
 
class  user
 The user class models and IRC user. More...
 

Enumerations

enum  command {
  command::RPL_WELCOME = 001,
  command::RPL_YOURHOST = 002,
  command::RPL_CREATED = 003,
  command::RPL_MYINFO = 004,
  command::RPL_BOUNCE = 005,
  command::RPL_TRACELINK = 200,
  command::RPL_TRACECONNECTING = 201,
  command::RPL_TRACEHANDSHAKE = 202,
  command::RPL_TRACEUNKNOWN = 203,
  command::RPL_TRACEOPERATOR = 204,
  command::RPL_TRACEUSER = 205,
  command::RPL_TRACESERVER = 206,
  command::RPL_TRACESERVICE = 207,
  command::RPL_TRACENEWTYPE = 208,
  command::RPL_TRACECLASS = 209,
  command::RPL_TRACERECONNECT = 210,
  command::RPL_STATSLINKINFO = 211,
  command::RPL_STATSCOMMANDS = 212,
  command::RPL_STATSCLINE = 213,
  command::RPL_STATSNLINE = 214,
  command::RPL_STATSILINE = 215,
  command::RPL_STATSKLINE = 216,
  command::RPL_STATSQLINE = 217,
  command::RPL_STATSYLINE = 218,
  command::RPL_ENDOFSTATS = 219,
  command::RPL_UMODEIS = 221,
  command::RPL_SERVICEINFO = 231,
  command::RPL_ENDOFSERVICES = 232,
  command::RPL_SERVICE = 233,
  command::RPL_SERVLIST = 234,
  command::RPL_SERVLISTEND = 235,
  command::RPL_STATSVLINE = 240,
  command::RPL_STATSLLINE = 241,
  command::RPL_STATSUPTIME = 242,
  command::RPL_STATSOLINE = 243,
  command::RPL_STATSHLINE = 244,
  command::RPL_STATSPING = 246,
  command::RPL_STATSBLINE = 247,
  command::RPL_STATSDLINE = 250,
  command::RPL_LUSERCLIENT = 251,
  command::RPL_LUSEROP = 252,
  command::RPL_LUSERUNKNOWN = 253,
  command::RPL_LUSERCHANNELS = 254,
  command::RPL_LUSERME = 255,
  command::RPL_ADMINME = 256,
  command::RPL_ADMINLOC1 = 257,
  command::RPL_ADMINLOC2 = 258,
  command::RPL_ADMINEMAIL = 259,
  command::RPL_TRACELOG = 261,
  command::RPL_TRACEEND = 262,
  command::RPL_TRYAGAIN = 263,
  command::RPL_NONE = 300,
  command::RPL_AWAY = 301,
  command::RPL_USERHOST = 302,
  command::RPL_ISON = 303,
  command::RPL_UNAWAY = 305,
  command::RPL_NOWAWAY = 306,
  command::RPL_WHOISUSER = 311,
  command::RPL_WHOISSERVER = 312,
  command::RPL_WHOISOPERATOR = 313,
  command::RPL_WHOWASUSER = 314,
  command::RPL_ENDOFWHO = 315,
  command::RPL_WHOISCHANOP = 316,
  command::RPL_WHOISIDLE = 317,
  command::RPL_ENDOFWHOIS = 318,
  command::RPL_WHOISCHANNELS = 319,
  command::RPL_LISTSTART = 321,
  command::RPL_LIST = 322,
  command::RPL_LISTEND = 323,
  command::RPL_CHANNELMODEIS = 324,
  command::RPL_UNIQOPIS = 325,
  command::RPL_NOTOPIC = 331,
  command::RPL_TOPIC = 332,
  command::RPL_INVITING = 341,
  command::RPL_SUMMONING = 342,
  command::RPL_INVITELIST = 346,
  command::RPL_ENDOFINVITELIST = 347,
  command::RPL_EXCEPTLIST = 348,
  command::RPL_ENDOFEXCEPTLIST = 349,
  command::RPL_VERSION = 351,
  command::RPL_WHOREPLY = 352,
  command::RPL_NAMREPLY = 353,
  command::RPL_KILLDONE = 361,
  command::RPL_CLOSING = 362,
  command::RPL_CLOSEEND = 363,
  command::RPL_LINKS = 364,
  command::RPL_ENDOFLINKS = 365,
  command::RPL_ENDOFNAMES = 366,
  command::RPL_BANLIST = 367,
  command::RPL_ENDOFBANLIST = 368,
  command::RPL_ENDOFWHOWAS = 369,
  command::RPL_INFO = 371,
  command::RPL_MOTD = 372,
  command::RPL_INFOSTART = 373,
  command::RPL_ENDOFINFO = 374,
  command::RPL_MOTDSTART = 375,
  command::RPL_ENDOFMOTD = 376,
  command::RPL_YOUREOPER = 381,
  command::RPL_REHASHING = 382,
  command::RPL_YOURESERVICE = 383,
  command::RPL_MYPORTIS = 384,
  command::RPL_TIME = 391,
  command::RPL_USERSSTART = 392,
  command::RPL_USERS = 393,
  command::RPL_ENDOFUSERS = 394,
  command::RPL_NOUSERS = 395,
  command::ERR_NOSUCHNICK = 401,
  command::ERR_NOSUCHSERVER = 402,
  command::ERR_NOSUCHCHANNEL = 403,
  command::ERR_CANNOTSENDTOCHAN = 404,
  command::ERR_TOOMANYCHANNELS = 405,
  command::ERR_WASNOSUCHNICK = 406,
  command::ERR_TOOMANYTARGETS = 407,
  command::ERR_NOSUCHSERVICE = 408,
  command::ERR_NOORIGIN = 409,
  command::ERR_NORECIPIENT = 411,
  command::ERR_NOTEXTTOSEND = 412,
  command::ERR_NOTOPLEVEL = 413,
  command::ERR_WILDTOPLEVEL = 414,
  command::ERR_BADMASK = 415,
  command::ERR_UNKNOWNCOMMAND = 421,
  command::ERR_NOMOTD = 422,
  command::ERR_NOADMININFO = 423,
  command::ERR_FILEERROR = 424,
  command::ERR_NONICKNAMEGIVEN = 431,
  command::ERR_ERRONEUSNICKNAME = 432,
  command::ERR_NICKNAMEINUSE = 433,
  command::ERR_NICKCOLLISION = 436,
  command::ERR_UNAVAILRESOURCE = 437,
  command::ERR_USERNOTINCHANNEL = 441,
  command::ERR_NOTONCHANNEL = 442,
  command::ERR_USERONCHANNEL = 443,
  command::ERR_NOLOGIN = 444,
  command::ERR_SUMMONDISABLED = 445,
  command::ERR_USERSDISABLED = 446,
  command::ERR_NOTREGISTERED = 451,
  command::ERR_NEEDMOREPARAMS = 461,
  command::ERR_ALREADYREGISTRED = 462,
  command::ERR_NOPERMFORHOST = 463,
  command::ERR_PASSWDMISMATCH = 464,
  command::ERR_YOUREBANNEDCREEP = 465,
  command::ERR_YOUWILLBEBANNED = 466,
  command::ERR_KEYSET = 467,
  command::ERR_CHANNELISFULL = 471,
  command::ERR_UNKNOWNMODE = 472,
  command::ERR_INVITEONLYCHAN = 473,
  command::ERR_BANNEDFROMCHAN = 474,
  command::ERR_BADCHANNELKEY = 475,
  command::ERR_BADCHANMASK = 476,
  command::ERR_NOCHANMODES = 477,
  command::ERR_BANLISTFULL = 478,
  command::ERR_NOPRIVILEGES = 481,
  command::ERR_CHANOPRIVSNEEDED = 482,
  command::ERR_CANTKILLSERVER = 483,
  command::ERR_RESTRICTED = 484,
  command::ERR_UNIQOPPRIVSNEEDED = 485,
  command::ERR_NOOPERHOST = 491,
  command::ERR_NOSERVICEHOST = 492,
  command::ERR_UMODEUNKNOWNFLAG = 501,
  command::ERR_USERSDONTMATCH = 502,
  command::error = rpl_max + 1,
  command::join,
  command::kick,
  command::mode,
  command::nick,
  command::notice,
  command::part,
  command::ping,
  command::pong,
  command::privmsg,
  command::quit,
  command::topic
}
 Reply codes and errors. More...
 

Enumeration Type Documentation

enum irc::command
strong

Reply codes and errors.

RFC 2812: Error replies are found in the range from 400 to 599.

Todo:
list, names, invite, channel mode command documentation.
Enumerator
RPL_WELCOME 

RFC 2812: "Welcome to the Internet Relay Network <nick>!<user>@<host>".

RPL_YOURHOST 

RFC 2812: "Your host is <servername>, running version <ver>".

RPL_CREATED 

RFC 2812: "This server was created <date>".

RPL_MYINFO 

RFC 2812: "<servername> <version> <available user modes> <available channel modes>".

  • The server sends Replies 001 to 004 to a user upon successful registration.
RPL_BOUNCE 

RFC 2812: "Try server <server name>, port <port number>".

  • Sent by the server to a user to suggest an alternative server. This is often used when the connection is refused because the server is already full.
RPL_TRACELINK 

RFC 2812: "Link <version & debug level> <destination> <next server> V<protocol version> <link uptime in seconds> <backstream sendq> <upstream sendq>".

RPL_TRACECONNECTING 

RFC 2812: "Try. <class> <server>".

RPL_TRACEHANDSHAKE 

RFC 2812: "H.S. <class> <server>".

RPL_TRACEUNKNOWN 

RFC 2812: "???? <class> [<client IP address in dot form>]".

RPL_TRACEOPERATOR 

RFC 2812: "Oper <class> <nick>".

RPL_TRACEUSER 

RFC 2812: "User <class> <nick>".

RPL_TRACESERVER 

RFC 2812: "Serv <class> <int>S <int>C <server> <nick!user|*!*>@<host|server> V<protocol version>".

RPL_TRACESERVICE 

RFC 2812: "Service <class> <name> <type> <active type>".

RPL_TRACENEWTYPE 

RFC 2812: "<newtype> 0 <client name>".

RPL_TRACECLASS 

RFC 2812: "Class <class> <count>".

RPL_TRACERECONNECT 

RFC 2812: Unused.

RPL_STATSLINKINFO 

RFC 2812: "<linkname> <sendq> <sent messages> <sent Kbytes> <received messages> <received Kbytes> <time open>".

  • reports statistics on a connection. <linkname> identifies the particular connection, <sendq> is the amount of data that is queued and waiting to be sent <sent messages> the number of messages sent, and <sent Kbytes> the amount of data sent, in Kbytes. <received messages> and <received Kbytes> are the equivalent of <sent messages> and <sent Kbytes> for received data, respectively. <time open> indicates how long ago the connection was opened, in seconds.
RPL_STATSCOMMANDS 

RFC 2812: "<command> <count> <byte count> <remote count>".

  • reports statistics on commands usage.
RPL_STATSCLINE 

RFC 1459: "C <host> * <name> <port> <class>" RFC 2812: Unused / reserved / non-generic 'feature'.

RPL_STATSNLINE 

RFC 1459: "N <host> * <name> <port> <class>" RFC 2812: Unused / reserved / non-generic 'feature'.

RPL_STATSILINE 

RFC 1459: "I <host> * <host> <port> <class>" RFC 2812: Unused / reserved / non-generic 'feature'.

RPL_STATSKLINE 

RFC 1459: "K <host> * <username> <port> <class>" RFC 2812: Unused / reserved / non-generic 'feature'.

RPL_STATSQLINE 

RFC 1459,2812: Unused / reserved / non-generic 'feature'.

RPL_STATSYLINE 

RFC 1459: "Y <class> <ping frequency> <connect frequency> <max sendq>" RFC 2812: Unused / reserved / non-generic 'feature'.

RPL_ENDOFSTATS 

RFC 2812: "<stats letter> :End of STATS report".

RPL_UMODEIS 

RFC 2812: "<user mode string>".

  • To answer a query about a client's own mode, RPL_UMODEIS is sent back.
RPL_SERVICEINFO 

RFC 1459,2812: Unused / reserved / non-generic 'feature'.

RPL_ENDOFSERVICES 

RFC 1459,2812: Unused / reserved / non-generic 'feature'.

RPL_SERVICE 

RFC 1459,2812: Unused / reserved / non-generic 'feature'.

RPL_SERVLIST 

RFC 2812: "<name> <server> <mask> <type> <hopcount> <info>".

RPL_SERVLISTEND 

RFC 2812: "<mask> <type> :End of service listing".

  • When listing services in reply to a SERVLIST message, a server is required to send the list back using the RPL_SERVLIST and RPL_SERVLISTEND messages. A separate RPL_SERVLIST is sent for each service. After the services have been listed (or if none present) a RPL_SERVLISTEND MUST be sent.
RPL_STATSVLINE 

RFC 2812: Unused / reserved / non-generic 'feature'.

RPL_STATSLLINE 

RFC 2812: Unused / reserved / non-generic 'feature'.

RPL_STATSUPTIME 

RFC 2812: ":Server Up %d days %d:%02d:%02d".

RPL_STATSOLINE 

RFC 2812: "O <hostmask> * <name>".

  • reports the allowed hosts from where user may become IRC operators.
RPL_STATSHLINE 

RFC 1459: "H <hostmask> * <servername>" RFC 2812: Unused / reserved / non-generic 'feature'.

RPL_STATSPING 

RFC 2812: Unused / reserved / non-generic 'feature'.

RPL_STATSBLINE 

RFC 2812: Unused / reserved / non-generic 'feature'.

RPL_STATSDLINE 

RFC 2812: Unused / reserved / non-generic 'feature'.

RPL_LUSERCLIENT 

RFC 2812: ":There are <integer> users and <integer> services on <integer> servers".

RPL_LUSEROP 

RFC 2812: "<integer> :operator(s) online".

RPL_LUSERUNKNOWN 

RFC 2812: "<integer> :unknown connection(s)".

RPL_LUSERCHANNELS 

RFC 2812: "<integer> :channels formed".

RPL_LUSERME 

RFC 2812: ":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.
RPL_ADMINME 

RFC 2812: "<server> :Administrative info".

RPL_ADMINLOC1 

RFC 2812:":<admin info>".

RPL_ADMINLOC2 

RFC 2812: ":<admin info>".

RPL_ADMINEMAIL 

RFC 2812: ":<admin info>".

RPL_TRACELOG 

RFC 2812: "File <logfile> <debug level>".

  • When replying to an ADMIN message, a server is expected to use replies RPL_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 institution (RPL_ADMINLOC2) and finally the administrative contact for the server (an email address here is REQUIRED) in RPL_ADMINEMAIL.
RPL_TRACEEND 

RFC 2812: "<server name> <version & debug level> :End of TRACE".

  • The RPL_TRACE* are all returned by the server in response to the TRACE message. How many are returned is dependent on 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'. 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. RPL_TRACENEWTYPE is to be used for any connection which does not fit in the other categories but is being displayed anyway. RPL_TRACEEND is sent to indicate the end of the list.
RPL_TRYAGAIN 

RFC 2812: "<command> :Please wait a while and try again.".

  • When a server drops a command without processing it, it MUST use the reply RPL_TRYAGAIN to inform the originating client.
RPL_NONE 

RFC 1459: Dummy reply number, not used.

RFC 2812: Unused / reserved / non-generic 'feature'.

RPL_AWAY 

RFC 2812: "<nick> :<away message>".

RPL_USERHOST 

RFC 2812: ":*1<reply> *( " " <reply> )".

  • Reply format used by USERHOST to list replies to the query list. The reply string is composed as follows:

    reply = nickname [ "*" ] "=" ( "+" / "-" ) 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.

RPL_ISON 

RFC 2812: ":*1<nick> *( " " <nick> )".

  • Reply format used by ISON to list replies to the query list.
RPL_UNAWAY 

RFC 2812: ":You are no longer marked as being away".

RPL_NOWAWAY 

RFC 2812: ":You have been marked as being away".

  • These replies are 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. Replies RPL_UNAWAY and RPL_NOWAWAY are sent when the client removes and sets an AWAY message.
RPL_WHOISUSER 

RFC 2812: "<nick> <user> <host> * :<real name>".

RPL_WHOISSERVER 

RFC 2812: "<nick> <server> :<server info>".

RPL_WHOISOPERATOR 

RFC 2812: "<nick> :is an IRC operator".

RPL_WHOWASUSER 

RFC 2812: "<nick> <user> <host> * :<real name>".

RPL_ENDOFWHO 

RFC 2812: "<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.
RPL_WHOISCHANOP 

RFC 1459,2812: Unused / reserved / non-generic 'feature'.

RPL_WHOISIDLE 

RFC 2812: "<nick> <integer> :seconds idle".

RPL_ENDOFWHOIS 

RFC 2812: "<nick> :End of WHOIS list".

RPL_WHOISCHANNELS 

RFC 2812: "<nick> :*( ( "" / "+" ) <channel> " " )".

  • 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.
RPL_LISTSTART 

RFC 2812: Obsolete.

Not used.

RPL_LIST 

RFC 2812: "<channel> <# visible> :<topic>".

RPL_LISTEND 

RFC 2812: ":End of LIST".

  • Replies RPL_LIST, RPL_LISTEND mark the 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 end reply MUST be sent.
RPL_CHANNELMODEIS 

RFC 2812: "<channel> <mode> <mode params>".

RPL_UNIQOPIS 

RFC 2812: "<channel> <nickname>".

RPL_NOTOPIC 

RFC 2812: "<channel> :No topic is set".

RPL_TOPIC 

RFC 2812: "<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.
RPL_INVITING 

RFC 2812: "<channel> <nick>".

  • Returned by the server to indicate that the attempted INVITE message was successful and is being passed onto the end client.
RPL_SUMMONING 

RFC 2812: "<user> :Summoning user to IRC".

  • Returned by a server answering a SUMMON message to indicate that it is summoning that user.
RPL_INVITELIST 

RFC 2812: "<channel> <invitemask>".

RPL_ENDOFINVITELIST 

RFC 2812: "<channel> :End of channel invite list".

  • When listing the 'invitations masks' for a given channel, a server is required to send the list back using the RPL_INVITELIST and RPL_ENDOFINVITELIST messages. A separate RPL_INVITELIST is sent for each active mask. After the masks have been listed (or if none present) a RPL_ENDOFINVITELIST MUST be sent.
RPL_EXCEPTLIST 

RFC 2812: "<channel> <exceptionmask>".

RPL_ENDOFEXCEPTLIST 

RFC 2812: "<channel> :End of channel exception list".

  • When listing the 'exception masks' for a given channel, a server is required to send the list back using the RPL_EXCEPTLIST and RPL_ENDOFEXCEPTLIST messages. A separate RPL_EXCEPTLIST is sent for each active mask. After the masks have been listed (or if none present) a RPL_ENDOFEXCEPTLIST MUST be sent.
RPL_VERSION 

RFC 2812: "<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.

RPL_WHOREPLY 

RFC 2812: "<channel> <user> <host> <server> <nick> ( "H" / "G" > ["*"] [ ( "" / "+" ) ] :<hopcount> <real name>".

RPL_NAMREPLY 

RFC 2812: "( "=" / "*" / "" ) <channel> :[ "@" / "+" ] <nick> *( " " [ "@" / "+" ] <nick> )

  • "@" is used for secret channels, "*" for private channels, and "=" for others (public channels).
RPL_KILLDONE 

RFC 1459,2812: Unused / reserved / non-generic 'feature'.

RPL_CLOSING 

RFC 1459,2812: Unused / reserved / non-generic 'feature'.

RPL_CLOSEEND 

RFC 1459,2812: Unused / reserved / non-generic 'feature'.

RPL_LINKS 

RFC 2812: "<mask> <server> :<hopcount> <server info>".

RPL_ENDOFLINKS 

RFC 2812: "<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.
RPL_ENDOFNAMES 

RFC 2812: "<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.
RPL_BANLIST 

RFC 2812: "<channel> <banmask>".

RPL_ENDOFBANLIST 

RFC 2812: "<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 banmask. After the banmasks have been listed (or if none present) a RPL_ENDOFBANLIST MUST be sent.
RPL_ENDOFWHOWAS 

RFC 2812: "<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).
RPL_INFO 

RFC 2812: ":<string>".

RPL_MOTD 

RFC 2812: ":- <text>".

RPL_INFOSTART 

RFC 1459,2812: Unused / reserved / non-generic 'feature'.

RPL_ENDOFINFO 

RFC 2812: ":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.
RPL_MOTDSTART 

RFC 2812: ":- <server> Message of the day - ".

RPL_ENDOFMOTD 

RFC 2812: ":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 MUST be surrounded by a RPL_MOTDSTART (before the RPL_MOTDs) and an RPL_ENDOFMOTD (after).
RPL_YOUREOPER 

RFC 2812: ":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.
RPL_REHASHING 

RFC 2812: "<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.
RPL_YOURESERVICE 

RFC 2812: "You are service <servicename>".

  • Sent by the server to a service upon successful registration.
RPL_MYPORTIS 

RFC 1459,2812: Unused / reserved / non-generic 'feature'.

RPL_TIME 

RFC 2812: "<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.
RPL_USERSSTART 

RFC 2812: ":UserID Terminal Host".

RPL_USERS 

RFC 2812: ":<username> <ttyline> <hostname>".

RPL_ENDOFUSERS 

RFC 2812: ":End of users".

RPL_NOUSERS 

RFC 2812: ":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.
ERR_NOSUCHNICK 

RFC 2812: "<nickname> :No such nick/channel".

  • Used to indicate the nickname parameter supplied to a command is currently unused.
ERR_NOSUCHSERVER 

RFC 2812: "<server name> :No such server".

  • Used to indicate the server name given currently doesn't exist.
ERR_NOSUCHCHANNEL 

RFC 2812: "<channel name> :No such channel".

  • Used to indicate the given channel name is invalid.
ERR_CANNOTSENDTOCHAN 

RFC 2812: "<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 or where the user is banned and is trying to send a PRIVMSG message to that channel.
ERR_TOOMANYCHANNELS 

RFC 2812: "<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.
ERR_WASNOSUCHNICK 

RFC 2812: "<nickname> :There was no such nickname".

  • Returned by WHOWAS to indicate there is no history information for that nickname.
ERR_TOOMANYTARGETS 

RFC 2812: "<target> :<error code> recipients. <abort message>".

  • Returned to a client which is attempting to send a PRIVMSG/NOTICE using the user@host destination format and for a user@host which has several occurrences.
  • Returned to a client which trying to send a PRIVMSG/NOTICE to too many recipients.
  • Returned to a client which is attempting to JOIN a safe channel using the shortname when there are more than one such channel.
ERR_NOSUCHSERVICE 

RFC 2812: "<service name> :No such service".

  • Returned to a client which is attempting to send a SQUERY to a service which does not exist.
ERR_NOORIGIN 

RFC 2812: ":No origin specified".

  • PING or PONG message missing the originator parameter.
ERR_NORECIPIENT 

RFC 2812: ":No recipient given (<command>)".

ERR_NOTEXTTOSEND 

RFC 2812: ":No text to send".

ERR_NOTOPLEVEL 

RFC 2812: "<mask> :No toplevel domain specified".

ERR_WILDTOPLEVEL 

RFC 2812: "<mask> :Wildcard in toplevel domain".

ERR_BADMASK 

RFC 2812: "<mask> :Bad Server/host mask".

  • 412 - 415 are returned by PRIVMSG to indicate that the message wasn't delivered for some reason. ERR_NOTOPLEVEL and ERR_WILDTOPLEVEL are errors that are returned when an invalid use of "PRIVMSG $<server>" or "PRIVMSG #<host>" is attempted.
ERR_UNKNOWNCOMMAND 

RFC 2812: "<command> :Unknown command".

  • Returned to a registered client to indicate that the command sent is unknown by the server.
ERR_NOMOTD 

RFC 2812: ":MOTD File is missing".

  • Server's MOTD file could not be opened by the server.
ERR_NOADMININFO 

RFC 2812: "<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.
ERR_FILEERROR 

RFC 2812: ":File error doing <file op> on <file>".

  • Generic error message used to report a failed file operation during the processing of a message.
ERR_NONICKNAMEGIVEN 

RFC 2812: ":No nickname given".

  • Returned when a nickname parameter expected for a command and isn't found.
ERR_ERRONEUSNICKNAME 

RFC 2812: "<nick> :Erroneous nickname".

  • Returned after receiving a NICK message which contains characters which do not fall in the defined set. See section 2.3.1 for details on valid nicknames.
ERR_NICKNAMEINUSE 

RFC 2812: "<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.
ERR_NICKCOLLISION 

RFC 2812: "<nick> :Nickname collision KILL from <user>@<host>".

  • Returned by a server to a client when it detects a nickname collision (registered of a NICK that already exists by another server).
ERR_UNAVAILRESOURCE 

RFC 2812: "<nick/channel> :Nick/channel is temporarily unavailable".

  • Returned by a server to a user trying to join a channel currently blocked by the channel delay mechanism.
  • Returned by a server to a user trying to change nickname when the desired nickname is blocked by the nick delay mechanism.
ERR_USERNOTINCHANNEL 

RFC 2812: "<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.
ERR_NOTONCHANNEL 

RFC 2812: "<channel> :You're not on that channel".

  • Returned by the server whenever a client tries to perform a channel affecting command for which the client isn't a member.
ERR_USERONCHANNEL 

RFC 2812: "<user> <channel> :is already on channel".

  • Returned when a client tries to invite a user to a channel they are already on.
ERR_NOLOGIN 

RFC 2812: "<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.
ERR_SUMMONDISABLED 

RFC 2812: ":SUMMON has been disabled".

  • Returned as a response to the SUMMON command. MUST be returned by any server which doesn't implement it.
ERR_USERSDISABLED 

RFC 2812: ":USERS has been disabled".

  • Returned as a response to the USERS command. MUST be returned by any server which does not implement it.
ERR_NOTREGISTERED 

RFC 2812: ":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.
ERR_NEEDMOREPARAMS 

RFC 2812: "<command> :Not enough parameters".

  • Returned by the server by numerous commands to indicate to the client that it didn't supply enough parameters.
ERR_ALREADYREGISTRED 

RFC 2812: ":Unauthorized command (already registered)".

  • 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).
ERR_NOPERMFORHOST 

RFC 2812: ":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.
ERR_PASSWDMISMATCH 

RFC 2812: ":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.
ERR_YOUREBANNEDCREEP 

RFC 2812: ":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.
ERR_YOUWILLBEBANNED 

RFC 2812: - Sent by a server to a user to inform that access to the server will soon be denied.

ERR_KEYSET 

RFC 2812: "<channel> :Channel key already set".

ERR_CHANNELISFULL 

RFC 2812: "<channel> :Cannot join channel (+l)".

ERR_UNKNOWNMODE 

RFC 2812: "<char> :is unknown mode char to me for <channel>".

ERR_INVITEONLYCHAN 

RFC 2812: "<channel> :Cannot join channel (+i)".

ERR_BANNEDFROMCHAN 

RFC 2812: "<channel> :Cannot join channel (+b)".

ERR_BADCHANNELKEY 

RFC 2812: "<channel> :Cannot join channel (+k)".

ERR_BADCHANMASK 

RFC 2812: "<channel> :Bad Channel Mask".

ERR_NOCHANMODES 

RFC 2812: "<channel> :Channel doesn't support modes".

ERR_BANLISTFULL 

RFC 2812: "<channel> <char> :Channel list is full".

ERR_NOPRIVILEGES 

RFC 2812: ":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.
ERR_CHANOPRIVSNEEDED 

RFC 2812: "<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.
ERR_CANTKILLSERVER 

RFC 2812: ":You can't 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.
ERR_RESTRICTED 

RFC 2812: ":Your connection is restricted!".

  • Sent by the server to a user upon connection to indicate the restricted nature of the connection (user mode "+r").
ERR_UNIQOPPRIVSNEEDED 

RFC 2812: ":You're not the original channel operator".

  • Any MODE requiring "channel creator" privileges MUST return this error if the client making the attempt is not a chanop on the specified channel.
ERR_NOOPERHOST 

RFC 2812: ":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.
ERR_NOSERVICEHOST 

RFC 1459,2812: Unused / reserved / non-generic 'feature'.

ERR_UMODEUNKNOWNFLAG 

RFC 2812: ":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.
ERR_USERSDONTMATCH 

RFC 2812: ":Cannot change mode for other users".

  • Error sent to any user trying to view or change the user mode for a user other than themselves.
error 

Parameters: <error message>

The ERROR command is for use by servers when reporting a serious or fatal error to its peers. It may also be sent from one server to another but MUST NOT be accepted from any normal unknown clients.

Only an ERROR message SHOULD be used for reporting errors which occur with a server-to-server link. An ERROR message is sent to the server at the other end (which reports it to appropriate local users and logs) and to appropriate local users and logs. It is not to be passed onto any other servers by a server if it is received from a server.

The ERROR message is also used before terminating a client connection.

When a server sends a received ERROR message to its operators, the message SHOULD be encapsulated inside a NOTICE message, indicating that the client was not responsible for the error.

Numerics:

  • None.

Examples:

ERROR :Server *.fi already exists
; ERROR message to the other server which caused this error.

NOTICE WiZ :ERROR from csd.bu.edu – Server *.fi already exists
; Same ERROR message as above but sent to user WiZ on the other server.

join 

Parameters: ( <channel> *( "," <channel> ) [ <key> *( "," <key> ) ] ) / "0".

The JOIN command is used by a user to request to start listening to the specific channel. Servers MUST be able to parse arguments in the form of a list of target, but SHOULD NOT use lists when sending JOIN messages to clients.

Once a user has joined a channel, he receives information about all commands his server receives affecting the channel. This includes command::join, command::mode, command::kick, command::part, command::quit and of course command::privmsg / command::notice. This allows channel members to keep track of the other channel members, as well as channel modes.

If a JOIN is successful, the user receives a JOIN message as confirmation and is then sent the channel's topic (using RPL_TOPIC) and the list of users who are on the channel (using RPL_NAMREPLY), which MUST include the user joining.

Note that this message accepts a special argument ("0"), which is a special request to leave all channels the user is currently a member of. The server will process this message as if the user had sent a command::part command (See Section 3.2.2) for each channel he is a member of.

Numeric Replies:

Examples:

JOIN #foobar
; Command to join channel #foobar.

JOIN &foo fubar
; Command to join channel &foo using key "fubar".

kick 

Parameters: <channel> *( "," <channel> ) <user> *( "," <user> ) [<comment>].

The KICK command can be used to request the forced removal of a user from a channel. It causes the <user> to PART from the <channel> by force. For the message to be syntactically correct, there MUST be either one channel parameter and multiple user parameter, or as many channel parameters as there are user parameters. If a "comment" is given, this will be sent instead of the default message, the nickname of the user issuing the KICK.

The server MUST NOT send KICK messages with multiple channels or users to clients. This is necessarily to maintain backward compatibility with old client software.

Numeric Replies:

Examples:

KICK &Melbourne Matthew
; Command to kick Matthew from &Melbourne

KICK #Finnish John :Speaking English
; Command to kick John from #Finnish using "Speaking English" as the reason (comment).

:WiZ!jto@tolsun.oulu.fi KICK #Finnish John
; KICK message on channel #Finnish from WiZ to remove John from channel.

mode 

Parameters: <nickname> *( ( "+" / "-" ) *( "i" / "w" / "o" / "O" / "r" ) )

The user MODE's are typically changes which affect either how the client is seen by others or what 'extra' messages the client is sent.

A user MODE command MUST only be accepted if both the sender of the message and the nickname given as a parameter are both the same. If no other parameter is given, then the server will return the current settings for the nick.

The available modes are as follows:

  • a - user is flagged as away;
  • i - marks a users as invisible;
  • w - user receives wallops;
  • r - restricted user connection;
  • o - operator flag;
  • O - local operator flag;
  • s - marks a user for receipt of server notices.

Additional modes may be available later on.

The flag 'a' SHALL NOT be toggled by the user using the MODE command, instead use of the AWAY command is REQUIRED.

If a user attempts to make themselves an operator using the "+o" or "+O" flag, the attempt SHOULD be ignored as users could bypass the authentication mechanisms of the OPER command. There is no restriction, however, on anyone `deopping' themselves (using "-o" or "-O").

On the other hand, if a user attempts to make themselves unrestricted using the "-r" flag, the attempt SHOULD be ignored. There is no restriction, however, on anyone `deopping' themselves (using "+r"). This flag is typically set by the server upon connection for administrative reasons. While the restrictions imposed are left up to the implementation, it is typical that a restricted user not be allowed to change nicknames, nor make use of the channel operator status on channels.

The flag 's' is obsolete but MAY still be used.

Numeric Replies:

Examples:

MODE WiZ -w
; Command by WiZ to turn off reception of WALLOPS messages.

MODE Angel +i
; Command from Angel to make herself invisible.

MODE WiZ -o
; WiZ 'deopping' (removing operator status).

nick 

Parameters: <nickname>

NICK command is used to give user a nickname or change the existing one.

Numeric Replies:

Examples:

NICK Wiz
; Introducing new nick "Wiz" if session is still unregistered, or user changing his nickname to "Wiz"

:WiZ!jto@tolsun.oulu.fi NICK Kilroy
; Server telling that WiZ changed his nickname to Kilroy.

notice 

Parameters: <msgtarget> <text>

The NOTICE command is used similarly to PRIVMSG. The difference between NOTICE and PRIVMSG is that automatic replies MUST NEVER be sent in response to a NOTICE message. This rule applies to servers too

  • they MUST NOT send any error reply back to the client on receipt of a notice. The object of this rule is to avoid loops between clients automatically sending something in response to something it received.

This command is available to services as well as users.

This is typically used by services, and automatons (clients with either an AI or other interactive program controlling their actions).

See Also
command::privmsg for more details on replies and examples.
part 

Parameters: <channel> *( "," <channel> ) [ <Part Message> ].

The PART command causes the user sending the message to be removed from the list of active members for all given channels listed in the parameter string. If a "Part Message" is given, this will be sent instead of the default message, the nickname. This request is always granted by the server.

Servers MUST be able to parse arguments in the form of a list of target, but SHOULD NOT use lists when sending PART messages to clients.

Numeric Replies:

Examples:

PART #twilight_zone
; Command to leave channel "#twilight_zone"

PART #oz-ops,&group5
; Command to leave both channels "&group5" and "#oz-ops".

:WiZ!jto@tolsun.oulu.fi PART #playzone :I lost
; User WiZ leaving channel "#playzone" with the message "I lost".

ping 

Parameters: <server1> [ <server2> ].

The PING command is used to test the presence of an active client or server at the other end of the connection. Servers send a PING message at regular intervals if no other activity detected coming from a connection. If a connection fails to respond to a PING message within a set amount of time, that connection is closed. A PING message MAY be sent even if the connection is active.

When a PING message is received, the appropriate PONG message MUST be sent as reply to <server1> (server which sent the PING message out) as soon as possible. If the <server2> parameter is specified, it represents the target of the ping, and the message gets forwarded there.

Numeric Replies:

Examples:

PING tolsun.oulu.fi
; Command to send a PING message to server

PING WiZ tolsun.oulu.fi
; Command from WiZ to send a PING message to server "tolsun.oulu.fi"

PING :irc.funet.fi
; Ping message sent by server "irc.funet.fi"

pong 

Parameters: <server> [ <server2> ].

PONG message is a reply to ping message. If parameter <server2> is given, this message MUST be forwarded to given target. The <server> parameter is the name of the entity who has responded to PING message and generated this message.

Numeric Replies:

Example:

PONG csd.bu.edu tolsun.oulu.fi
; PONG message from csd.bu.edu to tolsun.oulu.fi

privmsg 

Parameters: <msgtarget> <text to be sent>

PRIVMSG is used to send private messages between users, as well as to send messages to channels. <msgtarget> is usually the nickname of the recipient of the message, or a channel name.

The <msgtarget> parameter may also be a host mask (#<mask>) or server mask ($<mask>). In both cases the server will only send the PRIVMSG to those who have a server or host matching the mask. The mask MUST have at least 1 (one) "." in it and no wildcards following the last ".". This requirement exists to prevent people sending messages to "#*" or "$*", which would broadcast to all users. Wildcards are the '*' and '?' characters. This extension to the PRIVMSG command is only available to operators.

Numeric Replies:

Examples:

:Angel!wings@irc.org PRIVMSG Wiz :Are you receiving this message ?
; Message from Angel to Wiz.

PRIVMSG Angel :yes I'm receiving it !
; Command to send a message to Angel.

PRIVMSG jto@tolsun.oulu.fi :Hello !
; Command to send a message to a user on server tolsun.oulu.fi with username of "jto".

PRIVMSG kaltmillennium.stealth.net@irc.stealth.net :Are you a frog?
; Message to a user on server irc.stealth.net with username of "kalt", and connected from the host millennium.stealth.net.

PRIVMSG kaltmillennium.stealth.net :Do you like cheese?
; Message to a user on the local server with username of "kalt", and connected from the host millennium.stealth.net.

PRIVMSG Wiz!jto@tolsun.oulu.fi :Hello !
; Message to the user with nickname Wiz who is connected from the host tolsun.oulu.fi and has the username "jto".

PRIVMSG $*.fi :Server tolsun.oulu.fi rebooting.
; Message to everyone on a server which has a name matching *.fi.

PRIVMSG #*.edu :NSFNet is undergoing work, expect interruptions
; Message to all users who come from a host which has a name matching *.edu.

quit 

Parameters: [ <Quit Message> ].

A client session is terminated with a quit message. The server acknowledges this by sending an ERROR message to the client.

Numeric Replies:

  • None.

Example:

QUIT :Gone to have lunch
; Preferred message format.

:syrk!kalt@millennium.stealth.net QUIT :Gone to have lunch
; User syrk has quit IRC to have lunch.

topic 

Parameters: <channel> [ <topic> ].

The TOPIC command is used to change or view the topic of a channel. The topic for channel <channel> is returned if there is no <topic> given. If the <topic> parameter is present, the topic for that channel will be changed, if this action is allowed for the user requesting it. If the <topic> parameter is an empty string, the topic for that channel will be removed.

Numeric Replies:

Examples:

:WiZ!jto@tolsun.oulu.fi TOPIC #test
:New topic ; User Wiz setting the topic.

TOPIC #test :another topic
; Command to set the topic on #test to "another topic".

TOPIC #test :
; Command to clear the topic on #test.

TOPIC #test
; Command to check the topic for #test.