include/class.h

   1 /*
   2  * IRC - Internet Relay Chat, include/class.h
   3  * Copyright (C) 1990 Darren Reed
   4  * Copyright (C) 1996 - 1997 Carlo Wood
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2, or (at your option)
   9  * any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  19  *
  20  * $Id$
  21  */
  22 #ifndef INCLUDED_class_h
  23 #define INCLUDED_class_h
  24 #ifndef INCLUDED_sys_types_h
  25 #include <sys/types.h>
  26 #define INCLUDED_sys_types_h
  27 #endif
  28
  29 struct Client;
  30 struct ConfItem;
  31 struct StatDesc;
  32
  33 /*
  34  * Structures
  35  */
  36 struct ConnectionClass {
  37   struct ConnectionClass* next;
  38   char                    *cc_name;
  39   unsigned int            max_sendq;
  40   short                   ping_freq;
  41   short                   conn_freq;
  42   short                   max_links;
  43   unsigned char           valid;
  44   int                     ref_count;
  45 };
  46
  47 /*
  48  * Macro's
  49  */
  50
  51 #define ConClass(x)     ((x)->cc_name)
  52 #define PingFreq(x)     ((x)->ping_freq)
  53 #define ConFreq(x)      ((x)->conn_freq)
  54 #define MaxLinks(x)     ((x)->max_links)
  55 #define MaxSendq(x)     ((x)->max_sendq)
  56 #define Links(x)        ((x)->ref_count)
  57
  58 #define ConfClass(x)    ((x)->conn_class->cc_name)
  59 #define ConfPingFreq(x) ((x)->conn_class->ping_freq)
  60 #define ConfConFreq(x)  ((x)->conn_class->conn_freq)
  61 #define ConfMaxLinks(x) ((x)->conn_class->max_links)
  62 #define ConfSendq(x)    ((x)->conn_class->max_sendq)
  63 #define ConfLinks(x)    ((x)->conn_class->ref_count)
  64
  65 /*
  66  * Proto types
  67  */
  68
  69 extern void init_class(void);
  70
  71 extern const struct ConnectionClass* get_class_list(void);
  72 extern void class_mark_delete(void);
  73 extern void class_delete_marked(void);
  74
  75 extern struct ConnectionClass *find_class(const char *name);
  76 extern struct ConnectionClass *make_class(void);
  77 extern void free_class(struct ConnectionClass * tmp);
  78 extern unsigned int get_con_freq(struct ConnectionClass * clptr);
  79 extern char *get_conf_class(const struct ConfItem *aconf);
  80 extern int get_conf_ping(const struct ConfItem *aconf);
  81 extern char *get_client_class(struct Client *acptr);
  82 extern void add_class(char *name, unsigned int ping,
  83                       unsigned int confreq, unsigned int maxli,
  84                       unsigned int sendq);
  85 extern void check_class(void);
  86 extern void report_classes(struct Client *sptr, struct StatDesc *sd, int stat,
  87                            char *param);
  88 extern unsigned int get_sendq(struct Client* cptr);
  89
  90 extern void class_send_meminfo(struct Client* cptr);
  91 #endif /* INCLUDED_class_h */