commit 43d644ed92600770e9f5a3008adbf4e74754c01d from: Alexander Barton date: Sat Jul 02 14:33:45 2005 UTC Code and comment cleanups, new #define "CUT_TXTSUFFIX". commit - eeccc193dd9111295211eaf22d6cc4f0d2a91016 commit + 43d644ed92600770e9f5a3008adbf4e74754c01d blob - 5f5adcd368f3e5cb4d7a8158ab71350bffcb94a4 blob + d02ca5bdeac12cefdd64af02470b7215ba85376e --- src/ngircd/defines.h +++ src/ngircd/defines.h @@ -1,6 +1,6 @@ /* * ngIRCd -- The Next Generation IRC Daemon - * Copyright (c)2001-2003 by Alexander Barton (alex@barton.de) + * Copyright (c)2001-2005 Alexander Barton (alex@barton.de) * * 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 @@ -8,98 +8,121 @@ * (at your option) any later version. * Please read the file COPYING, README and AUTHORS for more information. * - * $Id: defines.h,v 1.52 2005/05/16 12:22:32 alex Exp $ - * - * Global defines of ngIRCd. + * $Id: defines.h,v 1.53 2005/07/02 14:33:45 alex Exp $ */ + #ifndef __defines_h__ #define __defines_h__ +/** + * @file + * Global constants ("#defines") used by the ngIRCd. + */ #define NONE -1 -#define FNAME_LEN 256 /* max. length of file name */ +#define FNAME_LEN 256 /* Max. length of file name */ -#define LINE_LEN 256 /* max. length of a line in the configuration file */ +#define LINE_LEN 256 /* Max. length of a line in the + configuration file */ -#define HOST_LEN 256 /* max. lenght of fully qualified host names */ +#define HOST_LEN 256 /* Max. lenght of fully qualified host + names (e. g. "abc.domain.tld") */ -#define MAX_LISTEN_PORTS 16 /* max. count of listening ports */ +#define MAX_LISTEN_PORTS 16 /* Max. count of listening ports */ -#define MAX_OPERATORS 16 /* max. count of configurable operators */ +#define MAX_OPERATORS 16 /* Max. count of configurable IRC Ops */ -#define MAX_SERVERS 16 /* max. count of configurable servers ("peers") */ +#define MAX_SERVERS 16 /* Max. count of configurable servers */ -#define MAX_DEFCHANNELS 16 /* max. count of preconfigurable channels */ +#define MAX_DEFCHANNELS 16 /* Max. count of predefined channels */ -#define MAX_SERVICES 8 /* max. number of configurable services */ +#define MAX_SERVICES 8 /* Max. count of services */ -#define MAX_WHOWAS 64 /* max. number of WHOWAS items */ +#define MAX_WHOWAS 64 /* Max. number of WHOWAS items */ #define DEFAULT_WHOWAS 5 /* default count for WHOWAS command */ -#define CONNECTION_POOL 100 /* size of default connection pool */ +#define CONNECTION_POOL 100 /* Size of default connection pool */ -#define CLIENT_ID_LEN 64 /* max. length of an IRC ID; see RFC 2812, 1.1 and 1.2.1 */ -#define CLIENT_NICK_LEN 10 /* max. nick length; see. RFC 2812, 1.2.1 */ -#define CLIENT_PASS_LEN 21 /* max. password length */ -#define CLIENT_USER_LEN 9 /* max. length of user name ("login") */ -#define CLIENT_NAME_LEN 32 /* max. length of "real names" */ -#define CLIENT_HOST_LEN 64 /* max. host name length */ -#define CLIENT_MODE_LEN 8 /* max. lenth of all client modes */ -#define CLIENT_INFO_LEN 64 /* max. length of server info texts */ -#define CLIENT_AWAY_LEN 128 /* max. length of away messages */ -#define CLIENT_FLAGS_LEN 100 /* max. length of client flags */ +#define CLIENT_ID_LEN 64 /* Max. length of an IRC ID; see RFC + RFC 2812 section 1.1 and 1.2.1 */ +#define CLIENT_NICK_LEN 10 /* Max. nick length, see. RFC 2812 + section 1.2.1 */ +#define CLIENT_PASS_LEN 21 /* Max. password length */ +#define CLIENT_USER_LEN 9 /* Max. length of user name ("login") */ +#define CLIENT_NAME_LEN 32 /* Max. length of "real names" */ +#define CLIENT_HOST_LEN 64 /* Max. host name length */ +#define CLIENT_MODE_LEN 8 /* Max. lenth of all client modes */ +#define CLIENT_INFO_LEN 64 /* Max. length of server info texts */ +#define CLIENT_AWAY_LEN 128 /* Max. length of away messages */ +#define CLIENT_FLAGS_LEN 100 /* Max. length of client flags */ -#define CHANNEL_NAME_LEN 51 /* max. length of a channel name, see. RFC 2812, 1.3 */ -#define CHANNEL_MODE_LEN 9 /* max. length of channel modes */ -#define CHANNEL_TOPIC_LEN 128 /* max. length of a channel topic */ +#define CHANNEL_NAME_LEN 51 /* Max. length of a channel name, see + RFC 2812 section 1.3 */ +#define CHANNEL_MODE_LEN 9 /* Max. length of channel modes */ +#define CHANNEL_TOPIC_LEN 128 /* Max. length of a channel topic */ -#define COMMAND_LEN 513 /* max. IRC command length, see. RFC 2812, 3.2 */ +#define COMMAND_LEN 513 /* Max. IRC command length, see. RFC + 2812 section 3.2 */ -#define READBUFFER_LEN 2048 /* size of the read buffer of a connection (bytes) */ -#define WRITEBUFFER_LEN 4096 /* size of the write buffer of a connection (bytes) */ +#define READBUFFER_LEN 2048 /* Size of the read buffer of a + connection in bytes. */ +#define WRITEBUFFER_LEN 4096 /* Size of the write buffer of a + connection in bytes. */ #ifdef ZLIB -#define ZREADBUFFER_LEN 1024 /* compressed read buffer of a connection (bytes) */ -#define ZWRITEBUFFER_LEN 4096 /* compressed write buffer of a connection (bytes) */ +#define ZREADBUFFER_LEN 1024 /* Size of the compressed read buffer + of a connection in bytes. */ +#define ZWRITEBUFFER_LEN 4096 /* Size of the compressed write buffer + of a connection in bytes. */ #endif -#define PROTOVER "0210" /* implemented IRC protocol version (see RFC 2813, 4.1.1) */ -#define PROTOIRC "-IRC" /* protocol suffix (see RFC 2813, 4.1.1) */ -#define PROTOIRCPLUS "-IRC+" /* protokol suffix for IRC+ protocol (see doc/Protocol.txt) */ +#define PROTOVER "0210" /* Implemented IRC protocol version, + see RFC 2813 section 4.1.1. */ +#define PROTOIRC "-IRC" /* Protocol suffix, see RFC 2813 + section 4.1.1 */ +#define PROTOIRCPLUS "-IRC+" /* Protocol suffix used by the IRC+ + protocol, see doc/Protocol.txt */ #ifdef IRCPLUS -# define IRCPLUSFLAGS "CL" /* standard IRC+ flags */ +# define IRCPLUSFLAGS "CL" /* Standard IRC+ flags */ #endif -#define STARTUP_DELAY 1 /* delay outgoing connections n seconds after startup */ -#define RECONNECT_DELAY 3 /* time to delay re-connect attempts (seconds) */ +#define STARTUP_DELAY 1 /* Delay outgoing connections n seconds + after startup. */ +#define RECONNECT_DELAY 3 /* Time to delay re-connect attempts + in seconds. */ -#define USERMODES "aios" /* supported user modes */ -#define CHANMODES "biklImnoPstv" /* supported channel modes */ +#define USERMODES "aios" /* Supported user modes. */ +#define CHANMODES "biklImnoPstv" /* Supported channel modes. */ -#define CONNECTED true /* internal status codes */ +#define CONNECTED true /* Internal status codes. */ #define DISCONNECTED false -#define DEFAULT_AWAY_MSG "Away" /* away message for users connected to linked servers */ +#define DEFAULT_AWAY_MSG "Away" /* Away message for users connected to + linked servers. */ -#define CONFIG_FILE "/ngircd.conf" -#define MOTD_FILE "/ngircd.motd" -#define MOTD_PHRASE "" -#define CHROOT_DIR "" -#define PID_FILE "" +#define CONFIG_FILE "/ngircd.conf" /* Configuration file name. */ +#define MOTD_FILE "/ngircd.motd" /* Name of the MOTD file. */ +#define MOTD_PHRASE "" /* Default MOTD phrase string. */ +#define CHROOT_DIR "" /* Default chroot() directory. */ +#define PID_FILE "" /* Default file for the process ID. */ -#define ERROR_DIR "/tmp" +#define ERROR_DIR "/tmp" /* Error directory used in debug mode */ -#define MAX_LOG_MSG_LEN 256 /* max. length of a log message */ +#define MAX_LOG_MSG_LEN 256 /* Max. length of a log message. */ -#define TOKEN_OUTBOUND -2 /* tag for outbound server links */ +#define TOKEN_OUTBOUND -2 /* Tag for outbound server links. */ -#define NOTICE_TXTPREFIX "" /* prefix for NOTICEs from the server to users */ +#define NOTICE_TXTPREFIX "" /* Prefix for NOTICEs from the server + to users. Some servers use '*'. */ +#define CUT_TXTSUFFIX "[CUT]" /* Suffix for oversized messages that + have been shortened and cut off. */ + #ifdef RENDEZVOUS -#define RENDEZVOUS_TYPE "_ircu._tcp." /* service type to register with Rendezvous */ +#define RENDEZVOUS_TYPE "_ircu._tcp." /* Service type to register with mDNS */ #endif