Module: Cinch::Constants

Defined in:
lib/cinch/constants.rb

Overview

All standard and some non-standard numeric replies used by the IRC protocol.

Constant Summary collapse

ERR_NOSUCHNICK =

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

401
ERR_NOSUCHSERVER =

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

402
ERR_NOSUCHCHANNEL =

Used to indicate the given channel name is invalid.

403
ERR_CANNOTSENDTOCHAN =

Sent to a user who is either - not on a channel which is mode +n - 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.

404
ERR_TOOMANYCHANNELS =

Sent to a user when they have joined the maximum number of allowed channels and they try to join another channel.

405
ERR_WASNOSUCHNICK =

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

406
ERR_TOOMANYTARGETS =

Returned to a client which is attempting to send PRIVMSG/NOTICE using the [email protected] destination format and for a [email protected] which has several occurrences.

407
ERR_NOORIGIN =

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

409
ERR_NORECIPIENT =
TODO:

Document this constant

411
ERR_NOTEXTTOSEND =
TODO:

Document this constant

412
ERR_NOTOPLEVEL =
TODO:

Document this constant

413
ERR_WILDTOPLEVEL =

412 - 414 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.

414
ERR_UNKNOWNCOMMAND =

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

421
ERR_NOMOTD =

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

422
ERR_NOADMININFO =

Returned by a server in response to an ADMIN message when there is an error in finding the appropriate information.

423
ERR_FILEERROR =

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

424
ERR_NONICKNAMEGIVEN =

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

431
ERR_ERRONEUSNICKNAME =

Returned after receiving a NICK message which contains characters which do not fall in the defined set.

432
ERR_NICKNAMEINUSE =

Returned when a NICK message is processed that results in an attempt to change to a currently existing nickname.

433
ERR_NICKCOLLISION =

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

436
ERR_USERNOTINCHANNEL =

Returned by the server to indicate that the target user of the command is not on the given channel.

441
ERR_NOTONCHANNEL =

Returned by the server whenever a client tries to perform a channel effecting command for which the client isn’t a member.

442
ERR_USERONCHANNEL =

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

443
ERR_NOLOGIN =

Returned by the summon after a SUMMON command for a user was unable to be performed since they were not logged in.

444
ERR_SUMMONDISABLED =

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

445
ERR_USERSDISABLED =

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

446
ERR_NOTREGISTERED =

Returned by the server to indicate that the client must be registered before the server will allow it to be parsed in detail.

451
ERR_NEEDMOREPARAMS =

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

461
ERR_ALREADYREGISTRED =

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

462
ERR_NOPERMFORHOST =

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.

463
ERR_PASSWDMISMATCH =

Returned to indicate a failed attempt at registering a connection for which a password was required and was either not given or incorrect.

464
ERR_YOUREBANNEDCREEP =

Returned after an attempt to connect and register yourself with a server which has been setup to explicitly deny connections to you.

465
ERR_KEYSET =
TODO:

Document this constant

467
ERR_CHANNELISFULL =
TODO:

Document this constant

471
ERR_UNKNOWNMODE =
TODO:

Document this constant

472
ERR_INVITEONLYCHAN =
TODO:

Document this constant

473
ERR_BANNEDFROMCHAN =
TODO:

Document this constant

474
ERR_BADCHANNELKEY =
TODO:

Document this constant

475
ERR_NOPRIVILEGES =

Any command requiring operator privileges to operate must return this error to indicate the attempt was unsuccessful.

481
ERR_CHANOPRIVSNEEDED =

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.

482
ERR_CANTKILLSERVER =

Any attempts to use the KILL command on a server are to be refused and this error returned directly to the client.

483
ERR_NOOPERHOST =

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.

491
ERR_UMODEUNKNOWNFLAG =

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.

501
ERR_USERSDONTMATCH =

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

502
RPL_NONE =
TODO:

Document this constant

300
RPL_USERHOST =

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

302
RPL_ISON =

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

303
RPL_AWAY =

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.

301
RPL_UNAWAY =

Replies RPL_UNAWAY and RPL_NOWAWAY are sent when the client removes and sets an AWAY message

305
RPL_NOWAWAY =

Replies RPL_UNAWAY and RPL_NOWAWAY are sent when the client removes and sets an AWAY message

306
RPL_WHOISUSER =
TODO:

Document this constant

311
RPL_WHOISSERVER =
TODO:

Document this constant

312
RPL_WHOISOPERATOR =
TODO:

Document this constant

313
RPL_WHOISIDLE =
TODO:

Document this constant

317
RPL_ENDOFWHOIS =
TODO:

Document this constant

318
RPL_WHOISCHANNELS =

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.

319
RPL_WHOWASUSER =
TODO:

Document this constant

314
RPL_ENDOFWHOWAS =

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

369
RPL_LISTSTART =
TODO:

Document this constant

321
RPL_LIST =
TODO:

Document this constant

322
RPL_LISTEND =

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.

323
RPL_CHANNELMODEIS =
TODO:

Document this constant

324
RPL_NOTOPIC =
TODO:

Document this constant

331
RPL_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.

332
RPL_INVITING =

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

341
RPL_SUMMONING =

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

342
RPL_VERSION =

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.

351
RPL_WHOREPLY =
TODO:

Document this constant

352
RPL_ENDOFWHO =

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.

315
RPL_NAMREPLY =
TODO:

Document this constant

353
RPL_NAMEREPLY =
TODO:

Document this constant

RPL_NAMREPLY
RPL_WHOSPCRPL =
TODO:

Document this constant

354
RPL_ENDOFNAMES =

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.

366
364
365
RPL_BANLIST =
TODO:

Document this constant

367
RPL_ENDOFBANLIST =

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.

368
RPL_INFO =
TODO:

Document this constant

371
RPL_ENDOFINFO =

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.

374
RPL_MOTDSTART =
TODO:

Document this constant

375
RPL_MOTD =
TODO:

Document this constant

372
RPL_ENDOFMOTD =

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

376
RPL_YOUREOPER =

RPL_YOUREOPER is sent back to a client which has just successfully issued an OPER message and gained operator status.

381
RPL_REHASHING =

If the REHASH option is used and an operator sends a REHASH message, an RPL_REHASHING is sent back to the operator.

382
RPL_QLIST =
TODO:

Document this constant

386
RPL_ENDOFQLIST =
TODO:

Document this constant

387
RPL_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.

391
RPL_USERSSTART =
TODO:

Document this constant

392
RPL_USERS =
TODO:

Document this constant

393
RPL_ENDOFUSERS =
TODO:

Document this constant

394
RPL_NOUSERS =

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.

395
200
RPL_TRACECONNECTING =
TODO:

Document this constant

201
RPL_TRACEHANDSHAKE =
TODO:

Document this constant

202
RPL_TRACEUNKNOWN =
TODO:

Document this constant

203
RPL_TRACEOPERATOR =
TODO:

Document this constant

204
RPL_TRACEUSER =
TODO:

Document this constant

205
RPL_TRACESERVER =
TODO:

Document this constant

206
RPL_TRACENEWTYPE =
TODO:

Document this constant

208
RPL_TRACELOG =

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.

261
RPL_STATSLINKINFO =
TODO:

Document this constant

211
RPL_STATSCOMMANDS =
TODO:

Document this constant

212
RPL_STATSCLINE =
TODO:

Document this constant

213
RPL_STATSNLINE =
TODO:

Document this constant

214
RPL_STATSILINE =
TODO:

Document this constant

215
RPL_STATSKLINE =
TODO:

Document this constant

216
RPL_STATSYLINE =
TODO:

Document this constant

218
RPL_ENDOFSTATS =
TODO:

Document this constant

219
RPL_STATSLLINE =
TODO:

Document this constant

241
RPL_STATSUPTIME =
TODO:

Document this constant

242
RPL_STATSOLINE =
TODO:

Document this constant

243
RPL_STATSHLINE =
TODO:

Document this constant

244
RPL_UMODEIS =

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

221
RPL_LUSERCLIENT =
TODO:

Document this constant

251
RPL_LUSEROP =
TODO:

Document this constant

252
RPL_LUSERUNKNOWN =
TODO:

Document this constant

253
RPL_LUSERCHANNELS =
TODO:

Document this constant

254
RPL_LUSERME =

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.

255
RPL_ADMINME =
TODO:

Document this constant

256
RPL_ADMINLOC1 =
TODO:

Document this constant

257
RPL_ADMINLOC2 =
TODO:

Document this constant

258
RPL_ADMINEMAIL =

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.

259
RPL_MONONLINE =
TODO:

Document this constant

730
RPL_MONOFFLINE =
TODO:

Document this constant

731
RPL_MONLIST =
TODO:

Document this constant

732
RPL_ENDOFMONLIST =
TODO:

Document this constant

733
ERR_MONLISTFULL =
TODO:

Document this constant

734
RPL_SASLLOGIN =
TODO:

Document this constant

900
RPL_SASLSUCCESS =
TODO:

Document this constant

903
RPL_SASLFAILED =
TODO:

Document this constant

904
RPL_SASLERROR =
TODO:

Document this constant

905
RPL_SASLABORT =
TODO:

Document this constant

906
RPL_SASLALREADYAUTH =
TODO:

Document this constant

907