- Client-Typ ("Status") besser unterteilt, My_Clients ist zudem nun global.
[ngircd-alex.git] / src / ngircd / client.h
1 /*
2  * ngIRCd -- The Next Generation IRC Daemon
3  * Copyright (c)2001 by Alexander Barton (alex@barton.de)
4  *
5  * Dieses Programm ist freie Software. Sie koennen es unter den Bedingungen
6  * der GNU General Public License (GPL), wie von der Free Software Foundation
7  * herausgegeben, weitergeben und/oder modifizieren, entweder unter Version 2
8  * der Lizenz oder (wenn Sie es wuenschen) jeder spaeteren Version.
9  * Naehere Informationen entnehmen Sie bitter der Datei COPYING. Eine Liste
10  * der an comBase beteiligten Autoren finden Sie in der Datei AUTHORS.
11  *
12  * $Id: client.h,v 1.3 2001/12/25 19:21:26 alex Exp $
13  *
14  * client.h: Konfiguration des ngircd (Header)
15  *
16  * $Log: client.h,v $
17  * Revision 1.3  2001/12/25 19:21:26  alex
18  * - Client-Typ ("Status") besser unterteilt, My_Clients ist zudem nun global.
19  *
20  * Revision 1.2  2001/12/23 22:03:47  alex
21  * - einige neue Funktionen,
22  * - Konstanten um "CLIENT_"-Prefix erweitert.
23  *
24  * Revision 1.1  2001/12/14 08:13:43  alex
25  * - neues Modul begonnen :-)
26  */
27
28
29 #ifndef __client_h__
30 #define __client_h__
31
32 #include "channel.h"
33 #include "conn.h"
34
35
36 #define CLIENT_ID_LEN 63                /* max. ID-Laenge; vgl. RFC 2812, 1.1 und 1.2.1 */
37 #define CLIENT_NICK_LEN 9               /* max. Nick-Laenge; vgl. RFC 2812, 1.2.1 */
38 #define CLIENT_PASS_LEN 9               /* max. Laenge des Passwortes */
39 #define CLIENT_USER_LEN 8               /* max. Laenge des Benutzernamen ("Login") */
40 #define CLIENT_NAME_LEN 32              /* max. Laenge des "langen Benutzernamen" */
41 #define CLIENT_HOST_LEN 63              /* max. Laenge des Hostname */
42
43 #define MAX_CHANNELS 32                 /* max. Anzahl Channels pro Nick */
44
45
46 typedef enum
47 {
48         CLIENT_UNKNOWN,                 /* Verbindung mit (noch) unbekanntem Typ */
49         CLIENT_GOTPASS,                 /* Client hat PASS gesendet */
50         CLIENT_GOTNICK,                 /* Client hat NICK gesendet */
51         CLIENT_GOTUSER,                 /* Client hat USER gesendet */
52         CLIENT_USER,                    /* Client ist ein Benutzer (USER wurde gesendet) */
53         CLIENT_SERVER,                  /* Client ist ein Server */
54         CLIENT_SERVICE                  /* Client ist ein Service */
55 } CLIENT_TYPE;
56
57
58 /* Das Verfahren, mit dem neue Client-Verbindungen beim Server registriert
59  * werden, ist in RFC 2812, Abschnitt 3.1 ff. definiert. */
60
61
62 typedef struct _CLIENT
63 {
64         POINTER *next;                  /* Zeiger auf naechste Client-Struktur */
65         CLIENT_TYPE type;               /* Typ des Client, vgl. CLIENT_TYPE */
66         CONN_ID conn_id;                /* ID der Connection (wenn lokal) bzw. NONE (remote) */
67         POINTER *introducer;            /* ID des Servers, der die Verbindung hat */
68         CHAR nick[CLIENT_ID_LEN + 1];   /* Nick (bzw. Server-ID, daher auch IDLEN!) */
69         CHAR pass[CLIENT_PASS_LEN + 1]; /* Passwort, welches der Client angegeben hat */
70         CHAR host[CLIENT_HOST_LEN + 1]; /* Hostname des Client */
71         CHAR user[CLIENT_USER_LEN + 1]; /* Benutzername ("Login") */
72         CHAR name[CLIENT_NAME_LEN + 1]; /* Langer Benutzername */
73         CHANNEL *channels[MAX_CHANNELS];/* IDs der Channel, bzw. NULL */
74 } CLIENT;
75
76
77 GLOBAL CLIENT *This_Server;
78 GLOBAL CLIENT *My_Clients;
79
80
81 GLOBAL VOID Client_Init( VOID );
82 GLOBAL VOID Client_Exit( VOID );
83
84 GLOBAL CLIENT *Client_New_Local( CONN_ID Idx, CHAR *Hostname );
85 GLOBAL VOID Client_Destroy( CLIENT *Client );
86 GLOBAL CLIENT *Client_GetFromConn( CONN_ID Idx );
87
88
89 #endif
90
91
92 /* -eof- */