Implement a per-connection-class default usermode option.
[ircu2.10.12-pk.git] / 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   char                    *default_umode;
40   unsigned int            max_sendq;
41   short                   ping_freq;
42   short                   conn_freq;
43   short                   max_links;
44   unsigned char           valid;
45   int                     ref_count;
46 };
47
48 /*
49  * Macro's
50  */
51
52 #define ConClass(x)     ((x)->cc_name)
53 #define PingFreq(x)     ((x)->ping_freq)
54 #define ConFreq(x)      ((x)->conn_freq)
55 #define MaxLinks(x)     ((x)->max_links)
56 #define MaxSendq(x)     ((x)->max_sendq)
57 #define Links(x)        ((x)->ref_count)
58
59 #define ConfClass(x)    ((x)->conn_class->cc_name)
60 #define ConfPingFreq(x) ((x)->conn_class->ping_freq)
61 #define ConfConFreq(x)  ((x)->conn_class->conn_freq)
62 #define ConfMaxLinks(x) ((x)->conn_class->max_links)
63 #define ConfSendq(x)    ((x)->conn_class->max_sendq)
64 #define ConfLinks(x)    ((x)->conn_class->ref_count)
65 #define ConfUmode(x)    ((x)->conn_class->default_umode)
66
67 /*
68  * Proto types
69  */
70
71 extern void init_class(void);
72
73 extern const struct ConnectionClass* get_class_list(void);
74 extern void class_mark_delete(void);
75 extern void class_delete_marked(void);
76
77 extern struct ConnectionClass *find_class(const char *name);
78 extern struct ConnectionClass *make_class(void);
79 extern void free_class(struct ConnectionClass * tmp);
80 extern unsigned int get_con_freq(struct ConnectionClass * clptr);
81 extern char *get_conf_class(const struct ConfItem *aconf);
82 extern int get_conf_ping(const struct ConfItem *aconf);
83 extern char *get_client_class(struct Client *acptr);
84 extern void add_class(char *name, unsigned int ping,
85                       unsigned int confreq, unsigned int maxli,
86                       unsigned int sendq);
87 extern void check_class(void);
88 extern void report_classes(struct Client *sptr, struct StatDesc *sd, int stat,
89                            char *param);
90 extern unsigned int get_sendq(struct Client* cptr);
91
92 extern void class_send_meminfo(struct Client* cptr);
93 #endif /* INCLUDED_class_h */