Committer : entrope
CVSROOT : /cvsroot/undernet-ircu
Module : ircu2.10
Commit time: 2006-07-05 02:19:41 UTC
Modified files:
ChangeLog ircd/m_quit.c ircd/m_rehash.c ircd/m_reset.c
ircd/m_restart.c ircd/m_rping.c ircd/m_rpong.c
Log message:
Doxygenate m_quit.c and m_r*.c
---------------------- diff included ----------------------
Index: ircu2.10/ChangeLog
diff -u ircu2.10/ChangeLog:1.792 ircu2.10/ChangeLog:1.793
--- ircu2.10/ChangeLog:1.792 Tue Jul 4 13:37:32 2006
+++ ircu2.10/ChangeLog Tue Jul 4 19:19:31 2006
@@ -1,5 +1,27 @@
2006-07-04 Michael Poole <[EMAIL PROTECTED]>
+ * ircd/m_quit.c (m_functions): Delete duplicative comment.
+ (m_quit): Write doxygen comment.
+ (ms_quit): Write doxygen comment.
+
+ * ircd/m_rehash.c (m_functions): Delete duplicative comment.
+ (mo_rehash): Write doxygen comment.
+
+ * ircd/m_reset.c (m_functions): Delete duplicative comment.
+ (mo_reset): Write doxygen comment.
+
+ * ircd/m_restart.c (m_functions): Delete duplicative comment.
+ (mo_restart): Write doxygen comment.
+
+ * ircd/m_rping.c (m_functions): Delete duplicative comment.
+ (ms_rping): Write doxygen comment.
+ (mo_rping): Write doxygen comment.
+
+ * ircd/m_rpong.c (m_functions): Delete duplicative comment.
+ (mo_rpong): Write doxygen comment.
+
+2006-07-04 Michael Poole <[EMAIL PROTECTED]>
+
* ircd/m_part.c (m_functions): Delete duplicative comment.
(m_part): Write doxygen comment.
(ms_part): Write doxygen comment.
Index: ircu2.10/ircd/m_quit.c
diff -u ircu2.10/ircd/m_quit.c:1.14 ircu2.10/ircd/m_quit.c:1.15
--- ircu2.10/ircd/m_quit.c:1.14 Fri Dec 10 21:13:48 2004
+++ ircu2.10/ircd/m_quit.c Tue Jul 4 19:19:31 2006
@@ -20,65 +20,9 @@
* along with this program; if not, write to the Free Software
* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*
- * $Id: m_quit.c,v 1.14 2004/12/11 05:13:48 klmitch Exp $
+ * $Id: m_quit.c,v 1.15 2006/07/05 02:19:31 entrope Exp $
*/
-/*
- * m_functions execute protocol messages on this server:
- *
- * cptr is always NON-NULL, pointing to a *LOCAL* client
- * structure (with an open socket connected!). This
- * identifies the physical socket where the message
- * originated (or which caused the m_function to be
- * executed--some m_functions may call others...).
- *
- * sptr is the source of the message, defined by the
- * prefix part of the message if present. If not
- * or prefix not found, then sptr==cptr.
- *
- * (!IsServer(cptr)) => (cptr == sptr), because
- * prefixes are taken *only* from servers...
- *
- * (IsServer(cptr))
- * (sptr == cptr) => the message didn't
- * have the prefix.
- *
- * (sptr != cptr && IsServer(sptr) means
- * the prefix specified servername. (?)
- *
- * (sptr != cptr && !IsServer(sptr) means
- * that message originated from a remote
- * user (not local).
- *
- * combining
- *
- * (!IsServer(sptr)) means that, sptr can safely
- * taken as defining the target structure of the
- * message in this server.
- *
- * *Always* true (if 'parse' and others are working correct):
- *
- * 1) sptr->from == cptr (note: cptr->from == cptr)
- *
- * 2) MyConnect(sptr) <=> sptr == cptr (e.g. sptr
- * *cannot* be a local connection, unless it's
- * actually cptr!). [MyConnect(x) should probably
- * be defined as (x == x->from) --msa ]
- *
- * parc number of variable parameter strings (if zero,
- * parv is allowed to be NULL)
- *
- * parv a NULL terminated list of parameter pointers,
- *
- * parv[0], sender (prefix string), if not present
- * this points to an empty string.
- * parv[1]...parv[parc-1]
- * pointers to additional parameters
- * parv[parc] == NULL, *always*
- *
- * note: it is guaranteed that parv[0]..parv[parc-1] are all
- * non-NULL pointers.
- */
#include "config.h"
#include "channel.h"
@@ -93,11 +37,16 @@
/* #include <assert.h> -- Now using assert in ircd_log.h */
#include <string.h>
-/*
- * m_quit - client message handler
+/** Handle a QUIT message from a client connection.
*
- * parv[0] = sender prefix
- * parv[parc - 1] = comment
+ * \a parv has the following elements:
+ * \li \a parv[\a parc - 1] is the quit message
+ *
+ * See @ref m_functions for discussion of the arguments.
+ * @param[in] cptr Client that sent us the message.
+ * @param[in] sptr Original source of message.
+ * @param[in] parc Number of arguments.
+ * @param[in] parv Argument vector.
*/
int m_quit(struct Client* cptr, struct Client* sptr, int parc, char* parv[])
{
@@ -119,11 +68,16 @@
}
-/*
- * ms_quit - server message handler
+/** Handle a QUIT message from a server connection.
+ *
+ * \a parv has the following elements:
+ * \li \a parv[\a parc - 1] is the quit message
*
- * parv[0] = sender prefix
- * parv[parc - 1] = comment
+ * See @ref m_functions for discussion of the arguments.
+ * @param[in] cptr Client that sent us the message.
+ * @param[in] sptr Original source of message.
+ * @param[in] parc Number of arguments.
+ * @param[in] parv Argument vector.
*/
int ms_quit(struct Client* cptr, struct Client* sptr, int parc, char* parv[])
{
Index: ircu2.10/ircd/m_rehash.c
diff -u ircu2.10/ircd/m_rehash.c:1.10 ircu2.10/ircd/m_rehash.c:1.11
--- ircu2.10/ircd/m_rehash.c:1.10 Fri Dec 10 21:13:48 2004
+++ ircu2.10/ircd/m_rehash.c Tue Jul 4 19:19:31 2006
@@ -20,65 +20,9 @@
* along with this program; if not, write to the Free Software
* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*
- * $Id: m_rehash.c,v 1.10 2004/12/11 05:13:48 klmitch Exp $
+ * $Id: m_rehash.c,v 1.11 2006/07/05 02:19:31 entrope Exp $
*/
-/*
- * m_functions execute protocol messages on this server:
- *
- * cptr is always NON-NULL, pointing to a *LOCAL* client
- * structure (with an open socket connected!). This
- * identifies the physical socket where the message
- * originated (or which caused the m_function to be
- * executed--some m_functions may call others...).
- *
- * sptr is the source of the message, defined by the
- * prefix part of the message if present. If not
- * or prefix not found, then sptr==cptr.
- *
- * (!IsServer(cptr)) => (cptr == sptr), because
- * prefixes are taken *only* from servers...
- *
- * (IsServer(cptr))
- * (sptr == cptr) => the message didn't
- * have the prefix.
- *
- * (sptr != cptr && IsServer(sptr) means
- * the prefix specified servername. (?)
- *
- * (sptr != cptr && !IsServer(sptr) means
- * that message originated from a remote
- * user (not local).
- *
- * combining
- *
- * (!IsServer(sptr)) means that, sptr can safely
- * taken as defining the target structure of the
- * message in this server.
- *
- * *Always* true (if 'parse' and others are working correct):
- *
- * 1) sptr->from == cptr (note: cptr->from == cptr)
- *
- * 2) MyConnect(sptr) <=> sptr == cptr (e.g. sptr
- * *cannot* be a local connection, unless it's
- * actually cptr!). [MyConnect(x) should probably
- * be defined as (x == x->from) --msa ]
- *
- * parc number of variable parameter strings (if zero,
- * parv is allowed to be NULL)
- *
- * parv a NULL terminated list of parameter pointers,
- *
- * parv[0], sender (prefix string), if not present
- * this points to an empty string.
- * parv[1]...parv[parc-1]
- * pointers to additional parameters
- * parv[parc] == NULL, *always*
- *
- * note: it is guaranteed that parv[0]..parv[parc-1] are all
- * non-NULL pointers.
- */
#include "config.h"
#include "client.h"
@@ -93,12 +37,24 @@
/* #include <assert.h> -- Now using assert in ircd_log.h */
-/*
- * mo_rehash - oper message handler
- *
- * parv[1] = 'm' flushes the MOTD cache and returns
- * parv[1] = 'l' reopens the log files and returns
- * parv[1] = 'q' to not rehash the resolver (optional)
+/** Handle a REHASH message from an operator connection.
+ *
+ * \a parv has the following elements:
+ * \li \a parv[1] (optional) is a flag indicating what to rehash
+ *
+ * The following flags are recognized:
+ * \li 'm' flushes the MOTD cache
+ * \li 'l' reopens the log files
+ * \li 'q' reloads the configuration file but does not rehash the DNS
+ * resolver
+ * \li the default is to reload the configuration file and restart the
+ * DNS resolver
+ *
+ * See @ref m_functions for discussion of the arguments.
+ * @param[in] cptr Client that sent us the message.
+ * @param[in] sptr Original source of message.
+ * @param[in] parc Number of arguments.
+ * @param[in] parv Argument vector.
*/
int mo_rehash(struct Client* cptr, struct Client* sptr, int parc, char* parv[])
{
Index: ircu2.10/ircd/m_reset.c
diff -u ircu2.10/ircd/m_reset.c:1.4 ircu2.10/ircd/m_reset.c:1.5
--- ircu2.10/ircd/m_reset.c:1.4 Fri Dec 10 21:13:48 2004
+++ ircu2.10/ircd/m_reset.c Tue Jul 4 19:19:31 2006
@@ -20,65 +20,9 @@
* along with this program; if not, write to the Free Software
* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*
- * $Id: m_reset.c,v 1.4 2004/12/11 05:13:48 klmitch Exp $
+ * $Id: m_reset.c,v 1.5 2006/07/05 02:19:31 entrope Exp $
*/
-/*
- * m_functions execute protocol messages on this server:
- *
- * cptr is always NON-NULL, pointing to a *LOCAL* client
- * structure (with an open socket connected!). This
- * identifies the physical socket where the message
- * originated (or which caused the m_function to be
- * executed--some m_functions may call others...).
- *
- * sptr is the source of the message, defined by the
- * prefix part of the message if present. If not
- * or prefix not found, then sptr==cptr.
- *
- * (!IsServer(cptr)) => (cptr == sptr), because
- * prefixes are taken *only* from servers...
- *
- * (IsServer(cptr))
- * (sptr == cptr) => the message didn't
- * have the prefix.
- *
- * (sptr != cptr && IsServer(sptr) means
- * the prefix specified servername. (?)
- *
- * (sptr != cptr && !IsServer(sptr) means
- * that message originated from a remote
- * user (not local).
- *
- * combining
- *
- * (!IsServer(sptr)) means that, sptr can safely
- * taken as defining the target structure of the
- * message in this server.
- *
- * *Always* true (if 'parse' and others are working correct):
- *
- * 1) sptr->from == cptr (note: cptr->from == cptr)
- *
- * 2) MyConnect(sptr) <=> sptr == cptr (e.g. sptr
- * *cannot* be a local connection, unless it's
- * actually cptr!). [MyConnect(x) should probably
- * be defined as (x == x->from) --msa ]
- *
- * parc number of variable parameter strings (if zero,
- * parv is allowed to be NULL)
- *
- * parv a NULL terminated list of parameter pointers,
- *
- * parv[0], sender (prefix string), if not present
- * this points to an empty string.
- * parv[1]...parv[parc-1]
- * pointers to additional parameters
- * parv[parc] == NULL, *always*
- *
- * note: it is guaranteed that parv[0]..parv[parc-1] are all
- * non-NULL pointers.
- */
#include "config.h"
#include "client.h"
@@ -94,8 +38,24 @@
/* #include <assert.h> -- Now using assert in ircd_log.h */
-/*
- * mo_reset - oper message handler
+/** Handle a RESET message from an operator connection.
+ *
+ * Resets a configuration Feature to its default value.
+ * \a parv has the following elements:
+ * \li \a parv[1] is the Feature to reset
+ *
+ * If \a parv[1] is "LOG" and there are no further arguments, the
+ * "USER" facility is reset to its defaults. Otherwise, \a parv has
+ * the following elements:
+ * \li \a parv[2] is the log subsystem to reset
+ * \li \a parv[3] is the parameter to reset ("FILE", "FACILITY",
+ * "SNOMASK" or "LEVEL")
+ *
+ * See @ref m_functions for discussion of the arguments.
+ * @param[in] cptr Client that sent us the message.
+ * @param[in] sptr Original source of message.
+ * @param[in] parc Number of arguments.
+ * @param[in] parv Argument vector.
*/
int mo_reset(struct Client* cptr, struct Client* sptr, int parc, char* parv[])
{
Index: ircu2.10/ircd/m_restart.c
diff -u ircu2.10/ircd/m_restart.c:1.7 ircu2.10/ircd/m_restart.c:1.8
--- ircu2.10/ircd/m_restart.c:1.7 Fri Dec 10 21:13:48 2004
+++ ircu2.10/ircd/m_restart.c Tue Jul 4 19:19:31 2006
@@ -20,65 +20,9 @@
* along with this program; if not, write to the Free Software
* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*
- * $Id: m_restart.c,v 1.7 2004/12/11 05:13:48 klmitch Exp $
+ * $Id: m_restart.c,v 1.8 2006/07/05 02:19:31 entrope Exp $
*/
-/*
- * m_functions execute protocol messages on this server:
- *
- * cptr is always NON-NULL, pointing to a *LOCAL* client
- * structure (with an open socket connected!). This
- * identifies the physical socket where the message
- * originated (or which caused the m_function to be
- * executed--some m_functions may call others...).
- *
- * sptr is the source of the message, defined by the
- * prefix part of the message if present. If not
- * or prefix not found, then sptr==cptr.
- *
- * (!IsServer(cptr)) => (cptr == sptr), because
- * prefixes are taken *only* from servers...
- *
- * (IsServer(cptr))
- * (sptr == cptr) => the message didn't
- * have the prefix.
- *
- * (sptr != cptr && IsServer(sptr) means
- * the prefix specified servername. (?)
- *
- * (sptr != cptr && !IsServer(sptr) means
- * that message originated from a remote
- * user (not local).
- *
- * combining
- *
- * (!IsServer(sptr)) means that, sptr can safely
- * taken as defining the target structure of the
- * message in this server.
- *
- * *Always* true (if 'parse' and others are working correct):
- *
- * 1) sptr->from == cptr (note: cptr->from == cptr)
- *
- * 2) MyConnect(sptr) <=> sptr == cptr (e.g. sptr
- * *cannot* be a local connection, unless it's
- * actually cptr!). [MyConnect(x) should probably
- * be defined as (x == x->from) --msa ]
- *
- * parc number of variable parameter strings (if zero,
- * parv is allowed to be NULL)
- *
- * parv a NULL terminated list of parameter pointers,
- *
- * parv[0], sender (prefix string), if not present
- * this points to an empty string.
- * parv[1]...parv[parc-1]
- * pointers to additional parameters
- * parv[parc] == NULL, *always*
- *
- * note: it is guaranteed that parv[0]..parv[parc-1] are all
- * non-NULL pointers.
- */
#include "config.h"
#include "client.h"
@@ -92,8 +36,15 @@
/* #include <assert.h> -- Now using assert in ircd_log.h */
-/*
- * mo_restart - oper message handler
+/** Handle a RESTART message from an operator connection.
+ *
+ * \a parv is ignored.
+ *
+ * See @ref m_functions for discussion of the arguments.
+ * @param[in] cptr Client that sent us the message.
+ * @param[in] sptr Original source of message.
+ * @param[in] parc Number of arguments.
+ * @param[in] parv Argument vector.
*/
int mo_restart(struct Client* cptr, struct Client* sptr, int parc, char*
parv[])
{
Index: ircu2.10/ircd/m_rping.c
diff -u ircu2.10/ircd/m_rping.c:1.12 ircu2.10/ircd/m_rping.c:1.13
--- ircu2.10/ircd/m_rping.c:1.12 Fri Dec 10 21:13:48 2004
+++ ircu2.10/ircd/m_rping.c Tue Jul 4 19:19:31 2006
@@ -20,65 +20,9 @@
* along with this program; if not, write to the Free Software
* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*
- * $Id: m_rping.c,v 1.12 2004/12/11 05:13:48 klmitch Exp $
+ * $Id: m_rping.c,v 1.13 2006/07/05 02:19:31 entrope Exp $
*/
-/*
- * m_functions execute protocol messages on this server:
- *
- * cptr is always NON-NULL, pointing to a *LOCAL* client
- * structure (with an open socket connected!). This
- * identifies the physical socket where the message
- * originated (or which caused the m_function to be
- * executed--some m_functions may call others...).
- *
- * sptr is the source of the message, defined by the
- * prefix part of the message if present. If not
- * or prefix not found, then sptr==cptr.
- *
- * (!IsServer(cptr)) => (cptr == sptr), because
- * prefixes are taken *only* from servers...
- *
- * (IsServer(cptr))
- * (sptr == cptr) => the message didn't
- * have the prefix.
- *
- * (sptr != cptr && IsServer(sptr) means
- * the prefix specified servername. (?)
- *
- * (sptr != cptr && !IsServer(sptr) means
- * that message originated from a remote
- * user (not local).
- *
- * combining
- *
- * (!IsServer(sptr)) means that, sptr can safely
- * taken as defining the target structure of the
- * message in this server.
- *
- * *Always* true (if 'parse' and others are working correct):
- *
- * 1) sptr->from == cptr (note: cptr->from == cptr)
- *
- * 2) MyConnect(sptr) <=> sptr == cptr (e.g. sptr
- * *cannot* be a local connection, unless it's
- * actually cptr!). [MyConnect(x) should probably
- * be defined as (x == x->from) --msa ]
- *
- * parc number of variable parameter strings (if zero,
- * parv is allowed to be NULL)
- *
- * parv a NULL terminated list of parameter pointers,
- *
- * parv[0], sender (prefix string), if not present
- * this points to an empty string.
- * parv[1]...parv[parc-1]
- * pointers to additional parameters
- * parv[parc] == NULL, *always*
- *
- * note: it is guaranteed that parv[0]..parv[parc-1] are all
- * non-NULL pointers.
- */
#include "config.h"
#include "client.h"
@@ -105,21 +49,48 @@
* Parsing: j RI Z jAA 953865133 0 :<No client start time>
*/
-/*
- * ms_rping - server message handler
+/** Handle an RPING message from a server connection.
* -- by Run
*
- * parv[0] = sender (sptr->name thus)
- * if sender is a person: (traveling towards start server)
- * parv[1] = pinged server[mask]
- * parv[2] = start server (current target)
- * parv[3] = optional remark
- * if sender is a server: (traveling towards pinged server)
- * parv[1] = pinged server (current target)
- * parv[2] = original sender (person)
- * parv[3] = start time in s
- * parv[4] = start time in us
- * parv[5] = the optional remark
+ * This is a way for an operator somewhere on the network to request
+ * that some server on the network ping another server, even if the
+ * operator is not connected to either of those servers.
+ *
+ * The operator requests an remote ping:
+ * RPING ServerA.* ServerB.* :Rping message
+ * If ServerB.* is not the operator's server, this message goes to
+ * ServerB.* (OpNmN is the operator's numnick, RI is the RPING token,
+ * SA is ServerA.*'s numnick, SB is ServerB.*'s numnick):
+ * OpNmN RI SA SB :Rping message
+ * ServerB.* then rpings ServerA.*:
+ * SB RI SA OpNmN 123456789 12345 :Rping message
+ * ServerA.* responds (RO is the RPONG token):
+ * SA RO ServerB.* OpNmN 12345689 12 :Rping message
+ * ServerB.* eventually gets this, and may have to send it back to the
+ * operator's server (567 is the number of elapsed milliseconds):
+ * SB RO OpNmN ServerA.* 567 :Rping message
+ * The operator's server informs the operator:
+ * ServerB.* RPONG OperNick ServerA.* 567 :Rping message
+ *
+ * If \a sptr is a server, it is the rping source and \a parv has the
+ * following elements:
+ * \li \a parv[1] is the rping target's numnick
+ * \li \a parv[2] is the rping requester's numnick
+ * \li \a parv[3] is the rping start time (seconds part)
+ * \li \a parv[4] is the rping start time (microseconds part)
+ * \li \a parv[5] is the requester's remark
+ *
+ * If \a sptr is a user, it is the rping requester and \a parv has the
+ * following elements:
+ * \li \a parv[1] is the rping target's numnick
+ * \li \a parv[2] is the rping source's numnick
+ * \li \a parv[3] is the requester's remark
+ *
+ * See @ref m_functions for discussion of the arguments.
+ * @param[in] cptr Client that sent us the message.
+ * @param[in] sptr Original source of message.
+ * @param[in] parc Number of arguments.
+ * @param[in] parv Argument vector.
*/
int ms_rping(struct Client* cptr, struct Client* sptr, int parc, char* parv[])
{
@@ -178,23 +149,24 @@
return 0;
}
-/*
- * mo_rping - oper message handler
+/** Handle an RPING message from an operator connection.
* -- by Run
*
+ * This message is used for remotely initiated pings. See ms_rping()
+ * for the theory of operation.
*
- * Receive:
- * RPING blah.*
- * RPING blah.* :<start time>
- * RPING blah.* server.* :<start time>
- *
- * parv[0] = sender (sptr->name thus)
- * parv[1] = pinged server name or mask (required)
- * parv[2] = start server name or mask (optional, defaults to me)
- * parv[3] = client start time (optional)
- *
- * Send: NumNick(sptr) RPING blah.* server.net :<start time> (hunt_server)
- * NumServ(&me) RPING NumServ(blah.bar.net) NumNick(sptr) :<start time>
(here)
+ * \a parv has the following elements:
+ * \li \a parv[1] is the name of the rping target
+ * \li \a parv[2] (optional) is the name of the rping source (defaults
+ * to this server)
+ * \li \a parv[3] (optional) is a remark (defaults to "<No client
+ * start time>")
+ *
+ * See @ref m_functions for discussion of the arguments.
+ * @param[in] cptr Client that sent us the message.
+ * @param[in] sptr Original source of message.
+ * @param[in] parc Number of arguments.
+ * @param[in] parv Argument vector.
*/
int mo_rping(struct Client* cptr, struct Client* sptr, int parc, char* parv[])
{
Index: ircu2.10/ircd/m_rpong.c
diff -u ircu2.10/ircd/m_rpong.c:1.12 ircu2.10/ircd/m_rpong.c:1.13
--- ircu2.10/ircd/m_rpong.c:1.12 Fri Dec 10 21:13:48 2004
+++ ircu2.10/ircd/m_rpong.c Tue Jul 4 19:19:31 2006
@@ -20,65 +20,9 @@
* along with this program; if not, write to the Free Software
* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*
- * $Id: m_rpong.c,v 1.12 2004/12/11 05:13:48 klmitch Exp $
+ * $Id: m_rpong.c,v 1.13 2006/07/05 02:19:31 entrope Exp $
*/
-/*
- * m_functions execute protocol messages on this server:
- *
- * cptr is always NON-NULL, pointing to a *LOCAL* client
- * structure (with an open socket connected!). This
- * identifies the physical socket where the message
- * originated (or which caused the m_function to be
- * executed--some m_functions may call others...).
- *
- * sptr is the source of the message, defined by the
- * prefix part of the message if present. If not
- * or prefix not found, then sptr==cptr.
- *
- * (!IsServer(cptr)) => (cptr == sptr), because
- * prefixes are taken *only* from servers...
- *
- * (IsServer(cptr))
- * (sptr == cptr) => the message didn't
- * have the prefix.
- *
- * (sptr != cptr && IsServer(sptr) means
- * the prefix specified servername. (?)
- *
- * (sptr != cptr && !IsServer(sptr) means
- * that message originated from a remote
- * user (not local).
- *
- * combining
- *
- * (!IsServer(sptr)) means that, sptr can safely
- * taken as defining the target structure of the
- * message in this server.
- *
- * *Always* true (if 'parse' and others are working correct):
- *
- * 1) sptr->from == cptr (note: cptr->from == cptr)
- *
- * 2) MyConnect(sptr) <=> sptr == cptr (e.g. sptr
- * *cannot* be a local connection, unless it's
- * actually cptr!). [MyConnect(x) should probably
- * be defined as (x == x->from) --msa ]
- *
- * parc number of variable parameter strings (if zero,
- * parv is allowed to be NULL)
- *
- * parv a NULL terminated list of parameter pointers,
- *
- * parv[0], sender (prefix string), if not present
- * this points to an empty string.
- * parv[1]...parv[parc-1]
- * pointers to additional parameters
- * parv[parc] == NULL, *always*
- *
- * note: it is guaranteed that parv[0]..parv[parc-1] are all
- * non-NULL pointers.
- */
#include "config.h"
#include "client.h"
@@ -95,15 +39,32 @@
/* #include <assert.h> -- Now using assert in ircd_log.h */
-/*
- * ms_rpong - server message handler
+/** Handle an RPONG message from a server
* -- by Run too :)
*
- * parv[0] = sender prefix
- * parv[1] = from pinged server: start server; from start server: sender
- * parv[2] = from pinged server: sender; from start server: pinged server
- * parv[3] = pingtime in ms
- * parv[4] = client info (for instance start time)
+ * This message is used for reporting the results of remotely
+ * initiated pings. See ms_rping() for the theory of operation.
+ *
+ * Going from the rping target to the rping source, \a parv has the
+ * following elements:
+ * \li \a parv[1] is the rping source's name (numnick is also allowed)
+ * \li \a parv[2] is the rping requester's numnick
+ * \li \a parv[3] is the rping start time (seconds part)
+ * \li \a parv[4] is the rping start time (microseconds part)
+ * \li \a parv[5] is the requester's remark
+ *
+ * Going from the rping source to the rping requester, \a parv has the
+ * following elements:
+ * \li \a parv[1] is the rping source's name (numnick is also allowed)
+ * \li \a parv[2] is the rping requester's numnick
+ * \li \a parv[3] is the rping round trip time in milliseconds
+ * \li \a parv[4] is the requester's remark
+ *
+ * See @ref m_functions for discussion of the arguments.
+ * @param[in] cptr Client that sent us the message.
+ * @param[in] sptr Original source of message.
+ * @param[in] parc Number of arguments.
+ * @param[in] parv Argument vector.
*/
int ms_rpong(struct Client* cptr, struct Client* sptr, int parc, char* parv[])
{
----------------------- End of diff -----------------------
_______________________________________________
Patches mailing list
[email protected]
http://undernet.sbg.org/mailman/listinfo/patches
