ircd-hybrid-7.2/include/msg.h

/*
 *  ircd-hybrid: an advanced Internet Relay Chat Daemon(ircd).
 *  msg.h: A header for the message handler structure.
 *
 *  Copyright (C) 2002 by the past and present ircd coders, and others.
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307
 *  USA
 *
 *  $Id$
 */

#ifndef INCLUDED_msg_h
#define INCLUDED_msg_h

#include "ircd_handler.h"

/* 
 * Message table structure 
 */
struct Message
{
  const char *cmd;
  unsigned int count;      /* number of times command used */
  unsigned int rcount;     /* number of times command used by server */
  unsigned int parameters; /* at least this many args must be passed
                             * or an error will be sent to the user 
                             * before the m_func is even called 
                             */
  unsigned int maxpara;    /* maximum permitted parameters */
  unsigned int flags;      /* bit 0 set means that this command is allowed
                             * to be used only on the average of once per 2
                             * seconds -SRB
                             */
  unsigned long bytes;  /* bytes received for this message */
  /*
   * client_p = Connected client ptr
   * source_p = Source client ptr
   * parc = parameter count
   * parv = parameter variable array
   */
  /* handlers:
   * UNREGISTERED, CLIENT, SERVER, ENCAP, OPER, DUMMY, LAST
   */
  MessageHandler handlers[LAST_HANDLER_TYPE];
};

/*
 * Constants
 */
#define   MFLG_SLOW             0x001   /* Command can be executed roughly
                                         * once per 2 seconds.                
                                         */
#define   MFLG_UNREG            0x002   /* Command available to unregistered
                                         * clients.                          
                                         */
 
#define MAXPARA    15

#endif /* INCLUDED_msg_h */
Revision:	33
Committed:	Sun Oct 2 20:50:00 2005 UTC (19 years, 10 months ago) by knight
Content type:	text/x-chdr
Original Path:	*ircd-hybrid/include/msg.h*
File size:	2424 byte(s)
Log Message:	- svn:keywords
#	Content
1	/*
2	* ircd-hybrid: an advanced Internet Relay Chat Daemon(ircd).
3	* msg.h: A header for the message handler structure.
4	*
5	* Copyright (C) 2002 by the past and present ircd coders, and others.
6	*
7	* This program is free software; you can redistribute it and/or modify
8	* it under the terms of the GNU General Public License as published by
9	* the Free Software Foundation; either version 2 of the License, or
10	* (at your option) any later version.
11	*
12	* This program is distributed in the hope that it will be useful,
13	* but WITHOUT ANY WARRANTY; without even the implied warranty of
14	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15	* GNU General Public License for more details.
16	*
17	* You should have received a copy of the GNU General Public License
18	* along with this program; if not, write to the Free Software
19	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
20	* USA
21	*
22	* $Id$
23	*/
24
25	#ifndef INCLUDED_msg_h
26	#define INCLUDED_msg_h
27
28	#include "ircd_handler.h"
29
30	/*
31	* Message table structure
32	*/
33	struct Message
34	{
35	const char *cmd;
36	unsigned int count; /* number of times command used */
37	unsigned int rcount; /* number of times command used by server */
38	unsigned int parameters; /* at least this many args must be passed
39	* or an error will be sent to the user
40	* before the m_func is even called
41	*/
42	unsigned int maxpara; /* maximum permitted parameters */
43	unsigned int flags; /* bit 0 set means that this command is allowed
44	* to be used only on the average of once per 2
45	* seconds -SRB
46	*/
47	unsigned long bytes; /* bytes received for this message */
48	/*
49	* client_p = Connected client ptr
50	* source_p = Source client ptr
51	* parc = parameter count
52	* parv = parameter variable array
53	*/
54	/* handlers:
55	* UNREGISTERED, CLIENT, SERVER, ENCAP, OPER, DUMMY, LAST
56	*/
57	MessageHandler handlers[LAST_HANDLER_TYPE];
58	};
59
60	/*
61	* Constants
62	*/
63	#define MFLG_SLOW 0x001 /* Command can be executed roughly
64	* once per 2 seconds.
65	*/
66	#define MFLG_UNREG 0x002 /* Command available to unregistered
67	* clients.
68	*/
69
70	#define MAXPARA 15
71
72	#endif /* INCLUDED_msg_h */