irccd  3.0.3
Classes | Enumerations
irccd::daemon::irc Namespace Reference

IRC related classes. More...

Classes

class  connection
 Abstract connection to a server. More...
 
struct  message
 Describe a IRC message. More...
 
struct  user
 Describe a user. More...
 

Enumerations

enum  err {
  err::nosuchnick = 401, err::nosuchserver = 402, err::nosuchchannel = 403, err::cannotsendtochan = 404,
  err::toomanychannels = 405, err::wasnosuchnick = 406, err::toomanytargets = 407, err::noorigin = 409,
  err::norecipient = 411, err::notexttosend = 412, err::notoplevel = 413, err::wildtoplevel = 414,
  err::unknowncommand = 421, err::nomotd = 422, err::noadmininfo = 423, err::fileerror = 424,
  err::nonicknamegiven = 431, err::erroneusnickname = 432, err::nicknameinuse = 433, err::nickcollision = 436,
  err::usernotinchannel = 441, err::notonchannel = 442, err::useronchannel = 443, err::nologin = 444,
  err::summondisabled = 445, err::usersdisabled = 446, err::notregistered = 451, err::needmoreparams = 461,
  err::alreadyregistred = 462, err::nopermforhost = 463, err::passwdmismatch = 464, err::yourebannedcreep = 465,
  err::keyset = 467, err::channelisfull = 471, err::unknownmode = 472, err::inviteonlychan = 473,
  err::bannedfromchan = 474, err::badchannelkey = 475, err::noprivileges = 481, err::chanoprivsneeded = 482,
  err::cantkillserver = 483, err::nooperhost = 491, err::umodeunknownflag = 501, err::usersdontmatch = 502
}
 Describe errors. More...
 
enum  rpl {
  rpl::none = 300, rpl::userhost = 302, rpl::ison = 303, rpl::away = 301,
  rpl::unaway = 305, rpl::nowaway = 306, rpl::whoisuser = 311, rpl::whoisserver = 312,
  rpl::whoisoperator = 313, rpl::whoisidle = 317, rpl::endofwhois = 318, rpl::whoischannels = 319,
  rpl::whowasuser = 314, rpl::endofwhowas = 369, rpl::liststart = 321, rpl::list = 322,
  rpl::listend = 323, rpl::channelmodeis = 324, rpl::notopic = 331, rpl::topic = 332,
  rpl::inviting = 341, rpl::summoning = 342, rpl::version = 351, rpl::whoreply = 352,
  rpl::endofwho = 315, rpl::namreply = 353, rpl::endofnames = 366, rpl::links = 364,
  rpl::endoflinks = 365, rpl::banlist = 367, rpl::endofbanlist = 368, rpl::info = 371,
  rpl::endofinfo = 374, rpl::motdstart = 375, rpl::motd = 372, rpl::endofmotd = 376,
  rpl::youreoper = 381, rpl::rehashing = 382, rpl::time = 391, rpl::userstart = 392,
  rpl::users = 393, rpl::endofusers = 394, rpl::nousers = 395, rpl::tracelink = 200,
  rpl::traceconnecting = 201, rpl::tracehandshake = 202, rpl::traceunknown = 203, rpl::traceoperator = 204,
  rpl::traceuser = 205, rpl::traceserver = 206, rpl::tracenewtype = 208, rpl::tracelog = 261,
  rpl::statslinkinfo = 211, rpl::statscommands = 212, rpl::statscline = 213, rpl::statsnline = 214,
  rpl::statsiline = 215, rpl::statskline = 216, rpl::statsyline = 218, rpl::endofstats = 219,
  rpl::statslline = 241, rpl::statsuptime = 242, rpl::statsoline = 243, rpl::statshline = 244,
  rpl::umodeis = 221, rpl::luserclient = 251, rpl::luserop = 252, rpl::luserunknown = 253,
  rpl::luserchannels = 254, rpl::luserme = 255, rpl::adminme = 256, rpl::adminloc1 = 257,
  rpl::adminloc2 = 258, rpl::adminemail = 259
}
 Describe numeric replies. More...
 

Detailed Description

IRC related classes.

Enumeration Type Documentation

◆ err

Describe errors.

See RFC1459 (6.1).

Enumerator
nosuchnick 

ERR_NOSUCHNICK

"<nickname> :No such nick/channel"

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

nosuchserver 

ERR_NOSUCHSERVER

"<server name> :No such server"

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

nosuchchannel 

ERR_NOSUCHCHANNEL

"<channel name> :No such channel"

Used to indicate the given channel name is invalid.

cannotsendtochan 

ERR_CANNOTSENDTOCHAN

"<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.

toomanychannels 

ERR_TOOMANYCHANNELS

"<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.

wasnosuchnick 

ERR_WASNOSUCHNICK

"<nickname> :There was no such nickname"

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

toomanytargets 

ERR_TOOMANYTARGETS

"<target> :Duplicate recipients. No message delivered"

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.

noorigin 

ERR_NOORIGIN

":No origin specified"

PING or PONG message missing the originator parameter which is required since these commands must work without valid prefixes.

norecipient 

ERR_NORECIPIENT

":No recipient given (<command>)"
notexttosend 

ERR_NOTEXTTOSEND

":No text to send"
notoplevel 

ERR_NOTOPLEVEL

"<mask> :No toplevel domain specified"
wildtoplevel 

ERR_WILDTOPLEVEL

"<mask> :Wildcard in toplevel domain"

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.

unknowncommand 

ERR_UNKNOWNCOMMAND

"<command> :Unknown command"

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

nomotd 

ERR_NOMOTD

":MOTD File is missing"

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

noadmininfo 

ERR_NOADMININFO

"<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.

fileerror 

ERR_FILEERROR

":File error doing <file op> on <file>"

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

nonicknamegiven 

ERR_NONICKNAMEGIVEN

":No nickname given"

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

erroneusnickname 

ERR_ERRONEUSNICKNAME

"<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.

nicknameinuse 

ERR_NICKNAMEINUSE

"<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.

nickcollision 

ERR_NICKCOLLISION

"<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).

usernotinchannel 

ERR_USERNOTINCHANNEL

"<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.

notonchannel 

ERR_NOTONCHANNEL

"<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.

useronchannel 

ERR_USERONCHANNEL

"<user> <channel> :is already on channel"

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

nologin 

ERR_NOLOGIN

"<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.

summondisabled 

ERR_SUMMONDISABLED

":SUMMON has been disabled"

Returned as a response to the SUMMON command. Must be returned by any server which does not implement it.

usersdisabled 

ERR_USERSDISABLED

":USERS has been disabled"

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

notregistered 

ERR_NOTREGISTERED

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

needmoreparams 

ERR_NEEDMOREPARAMS

"<command> :Not enough parameters"

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

alreadyregistred 

ERR_ALREADYREGISTRED

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

nopermforhost 

ERR_NOPERMFORHOST

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

passwdmismatch 

ERR_PASSWDMISMATCH

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

yourebannedcreep 

ERR_YOUREBANNEDCREEP

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

keyset 

ERR_KEYSET

"<channel> :Channel key already set"
channelisfull 

ERR_CHANNELISFULL

"<channel> :Cannot join channel (+l)"
unknownmode 

ERR_UNKNOWNMODE

"<char> :is unknown mode char to me"
inviteonlychan 

ERR_INVITEONLYCHAN

"<channel> :Cannot join channel (+i)"
bannedfromchan 

ERR_BANNEDFROMCHAN

"<channel> :Cannot join channel (+b)"
badchannelkey 

ERR_BADCHANNELKEY

"<channel> :Cannot join channel (+k)"
noprivileges 

ERR_NOPRIVILEGES

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

chanoprivsneeded 

ERR_CHANOPRIVSNEEDED

"<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.

cantkillserver 

ERR_CANTKILLSERVER

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

nooperhost 

ERR_NOOPERHOST

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

umodeunknownflag 

ERR_UMODEUNKNOWNFLAG

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

usersdontmatch 

ERR_USERSDONTMATCH

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

◆ rpl

Describe numeric replies.

See RFC1459 (6.2).

Enumerator
none 

RPL_NONE

Dummy reply number. Not used.

userhost 

RPL_USERHOST

":[<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.

ison 

RPL_ISON

":[<nick> {<space><nick>}]"

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

away 

RPL_AWAY

"<nick> :<away message>"
unaway 

RPL_UNAWAY

":You are no longer marked as being away"
nowaway 

RPL_NOWAWAY

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

whoisuser 

RPL_WHOISUSER

"<nick> <user> <host> * :<real name>"
whoisserver 

RPL_WHOISSERVER

"<nick> <server> :<server info>"
whoisoperator 

RPL_WHOISOPERATOR

"<nick> :is an IRC operator"
whoisidle 

RPL_WHOISIDLE

"<nick> <integer> :seconds idle"
endofwhois 

RPL_ENDOFWHOIS

"<nick> :End of /WHOIS list"
whoischannels 

RPL_WHOISCHANNELS

"<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.

whowasuser 

RPL_WHOWASUSER

"<nick> <user> <host> * :<real name>"
endofwhowas 

RPL_ENDOFWHOWAS

"<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).

liststart 

RPL_LISTSTART

"Channel :Users  Name"
list 

RPL_LIST

"<channel> <# visible> :<topic>"
listend 

RPL_LISTEND

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

channelmodeis 

RPL_CHANNELMODEIS

"<channel> <mode> <mode params>"
notopic 

RPL_NOTOPIC

"<channel> :No topic is set"
topic 

RPL_TOPIC

"<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.

inviting 

RPL_INVITING

"<channel> <nick>"

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

summoning 

RPL_SUMMONING

"<user> :Summoning user to IRC"

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

version 

RPL_VERSION

"<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.

whoreply 

RPL_WHOREPLY

"<channel> <user> <host> <server> <nick> \
 <H|G>[*][@|+] :<hopcount> <real name>"
endofwho 

RPL_ENDOFWHO

"<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.

namreply 

RPL_NAMREPLY

"<channel> :[[@|+]<nick> [[@|+]<nick> [...]]]"
endofnames 

RPL_ENDOFNAMES

"<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.

links 

RPL_LINKS

"<mask> <server> :<hopcount> <server info>"
endoflinks 

RPL_ENDOFLINKS

"<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.

banlist 

RPL_BANLIST

"<channel> <banid>"
endofbanlist 

RPL_ENDOFBANLIST

"<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.

info 

RPL_INFO

":<string>"
endofinfo 

RPL_ENDOFINFO

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

motdstart 

RPL_MOTDSTART

":- <server> Message of the day - "
motd 

RPL_MOTD

":- <text>"
endofmotd 

RPL_ENDOFMOTD

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

youreoper 

RPL_YOUREOPER

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

rehashing 

RPL_REHASHING

"<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.

time 

RPL_TIME

"<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.

userstart 

RPL_USERSSTART

":UserID   Terminal  Host"
users 

RPL_USERS

":%-8s %-9s %-8s"
endofusers 

RPL_ENDOFUSERS

":End of users"
nousers 

RPL_NOUSERS

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

tracelink 

RPL_TRACELINK

"Link <version & debug level> <destination> <next server>"
traceconnecting 

RPL_TRACECONNECTING

"Try. <class> <server>"
tracehandshake 

RPL_TRACEHANDSHAKE

"H.S. <class> <server>"
traceunknown 

RPL_TRACEUNKNOWN

"???? <class> [<client IP address in dot form>]"
traceoperator 

RPL_TRACEOPERATOR

"Oper <class> <nick>"
traceuser 

RPL_TRACEUSER

"User <class> <nick>"
traceserver 

RPL_TRACESERVER

"Serv <class> <int>S <int>C <server> \
 <nick!user|*!*>@<host|server>
tracenewtype 

RPL_TRACENEWTYPE

"<newtype> 0 <client name>"
tracelog 

RPL_TRACELOG

"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. 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.

statslinkinfo 

RPL_STATSLINKINFO

"<linkname> <sendq> <sent messages> \
 <sent bytes> <received messages> \
 <received bytes> <time open>"
statscommands 

RPL_STATSCOMMANDS

"<command> <count>"
statscline 

RPL_STATSCLINE

"C <host> * <name> <port> <class>"
statsnline 

RPL_STATSNLINE

"N <host> * <name> <port> <class>"
statsiline 

RPL_STATSILINE

"I <host> * <host> <port> <class>"
statskline 

RPL_STATSKLINE

K <host> * <username> <port> <class>"
statsyline 

RPL_STATSYLINE

"Y <class> <ping frequency> <connect frequency> <max sendq>"
endofstats 

RPL_ENDOFSTATS

"<stats letter> :End of /STATS report"
statslline 

RPL_STATSLLINE

"L <hostmask> * <servername> <maxdepth>"
statsuptime 

RPL_STATSUPTIME

":Server Up %d days %d:%02d:%02d"
statsoline 

RPL_STATSOLINE

"O <hostmask> * <name>"
statshline 

RPL_STATSHLINE

"H <hostmask> * <servername>"
umodeis 

RPL_UMODEIS

"<user mode string>"

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

luserclient 

RPL_LUSERCLIENT

":There are <integer> users and <integer> \
 invisible on <integer> servers"
luserop 

RPL_LUSEROP

"<integer> :operator(s) online"
luserunknown 

RPL_LUSERUNKNOWN

"<integer> :unknown connection(s)"
luserchannels 

RPL_LUSERCHANNELS

"<integer> :channels formed"
luserme 

RPL_LUSERME

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

adminme 

RPL_ADMINME

"<server> :Administrative info"
adminloc1 

RPL_ADMINLOC1

":<admin info>"
adminloc2 

RPL_ADMINLOC2

":<admin info>"
adminemail 

RPL_ADMINEMAIL

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