/*
* ngIRCd -- The Next Generation IRC Daemon
- * Copyright (c)2001-2003 by Alexander Barton (alex@barton.de)
+ * Copyright (c)2001-2012 Alexander Barton (alex@barton.de) and Contributors.
*
* 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.
* Please read the file COPYING, README and AUTHORS for more information.
- *
- * $Id: defines.h,v 1.51 2005/03/19 18:43:48 fw Exp $
- *
- * Global defines of ngIRCd.
*/
#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 */
+/* Internal flags */
-#define LINE_LEN 256 /* max. length of a line in the configuration file */
+/** Flag: there is no connection. */
+#define NONE -1
-#define HOST_LEN 256 /* max. lenght of fully qualified host names */
+/** Flag: connection is (still) established. */
+#define CONNECTED true
-#define MAX_LISTEN_PORTS 16 /* max. count of listening ports */
+/** Flag: connection isn't established (any more). */
+#define DISCONNECTED false
-#define MAX_OPERATORS 16 /* max. count of configurable operators */
+/** Tag for outbound server links. */
+#define TOKEN_OUTBOUND -2
-#define MAX_SERVERS 16 /* max. count of configurable servers ("peers") */
-#define MAX_DEFCHANNELS 16 /* max. count of preconfigurable channels */
+/* Generic buffer sizes */
-#define MAX_SERVICES 8 /* max. number of configurable services */
+/** Max. length of a line in the configuration file. */
+#define LINE_LEN 256
-#define CONNECTION_POOL 100 /* size of default connection pool */
+/** Max. length of a log message. */
+#define MAX_LOG_MSG_LEN 256
-#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 */
+/** Max. length of file name. */
+#define FNAME_LEN 256
-#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 */
+/** Max. length of fully qualified host names (e. g. "abc.domain.tld"). */
+#define HOST_LEN 256
-#define COMMAND_LEN 513 /* max. IRC command length, see. RFC 2812, 3.2 */
+/** Max. length of random salt */
+#define RANDOM_SALT_LEN 32
-#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) */
-#ifdef ZLIB
-#define ZREADBUFFER_LEN 1024 /* compressed read buffer of a connection (bytes) */
-#define ZWRITEBUFFER_LEN 4096 /* compressed write buffer of a connection (bytes) */
-#endif
+/* Size of structures */
-#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) */
+/** Max. count of configurable servers. */
+#define MAX_SERVERS 16
-#ifdef IRCPLUS
-# define IRCPLUSFLAGS "CL" /* standard IRC+ flags */
-#endif
+/** Max. number of WHOWAS list items that can be stored. */
+#define MAX_WHOWAS 64
-#define STARTUP_DELAY 1 /* delay outgoing connections n seconds after startup */
-#define RECONNECT_DELAY 3 /* time to delay re-connect attempts (seconds) */
+/** Size of default connection pool. */
+#define CONNECTION_POOL 100
-#define USERMODES "aios" /* supported user modes */
-#define CHANMODES "biklImnoPstv" /* supported channel modes */
-#define CONNECTED true /* internal status codes */
-#define DISCONNECTED false
+/* Hard-coded (default) options */
+
+/** Delay after startup before outgoing connections are initiated in seconds. */
+#define STARTUP_DELAY 1
-#define DEFAULT_AWAY_MSG "Away" /* away message for users connected to linked servers */
+/** Time to delay re-connect attempts in seconds. */
+#define RECONNECT_DELAY 3
+/** Configuration file name. */
#define CONFIG_FILE "/ngircd.conf"
+
+/** Name of the MOTD file. */
#define MOTD_FILE "/ngircd.motd"
-#define MOTD_PHRASE ""
+
+/** Default chroot() directory. */
#define CHROOT_DIR ""
+
+/** Default file for the process ID. */
#define PID_FILE ""
-#define ERROR_DIR "/tmp"
-#define MAX_LOG_MSG_LEN 256 /* max. length of a log message */
+/* Sizes of "IRC elements": nicks, users, ... */
-#define TOKEN_OUTBOUND -2 /* tag for outbound server links */
+/** Max. length of an IRC ID (incl. NULL); see RFC 2812 section 1.1 and 1.2.1. */
+#define CLIENT_ID_LEN 64
-#define NOTICE_TXTPREFIX "" /* prefix for NOTICEs from the server to users */
+/** Default nick length (including NULL), see. RFC 2812 section 1.2.1. */
+#define CLIENT_NICK_LEN_DEFAULT 10
+
+/** Maximum nick name length (including NULL). */
+#define CLIENT_NICK_LEN 32
+
+/** Max. password length (including NULL). */
+#define CLIENT_PASS_LEN 21
+
+/** Max. length of user name ("login"; incl. NULL), RFC 2812, section 1.2.1. */
+#define CLIENT_USER_LEN 10
+
+/** Max. length of "real names" (including NULL). */
+#define CLIENT_NAME_LEN 32
+
+/** Max. host name length (including NULL). */
+#define CLIENT_HOST_LEN 64
+
+/** Max. length of all client modes (including NULL). */
+#define CLIENT_MODE_LEN 21
+
+/** Max. length of server info texts (including NULL). */
+#define CLIENT_INFO_LEN 64
+
+/** Max. length of away messages (including NULL). */
+#define CLIENT_AWAY_LEN 128
+
+/** Max. length of client flags (including NULL). */
+#define CLIENT_FLAGS_LEN 16
+
+/** Max. length of a channel name (including NULL), see RFC 2812 section 1.3. */
+#define CHANNEL_NAME_LEN 51
+
+/** Max. length of channel modes (including NULL). */
+#define CHANNEL_MODE_LEN 21
+
+/** Max. IRC command length (including NULL), see. RFC 2812 section 3.2. */
+#define COMMAND_LEN 513
-#ifdef RENDEZVOUS
-#define RENDEZVOUS_TYPE "_ircu._tcp." /* service type to register with Rendezvous */
-#endif
+/* Read and write buffer sizes */
+/** Size of the read buffer of a connection in bytes. */
+#define READBUFFER_LEN 2048
+
+/** Size that triggers write buffer flushing if more space is needed. */
+#define WRITEBUFFER_FLUSH_LEN 4096
+
+/** Maximum size of the write buffer of a connection in bytes. */
+#define WRITEBUFFER_MAX_LEN 32768
+
+/** Maximum size of the write buffer of a server link connection in bytes. */
+#define WRITEBUFFER_SLINK_LEN 65536
+
+
+/* IRC/IRC+ protocol */
+
+/** Implemented IRC protocol version, see RFC 2813 section 4.1.1. */
+#define PROTOVER "0210"
+
+/** Protocol suffix, see RFC 2813 section 4.1.1. */
+#define PROTOIRC "-IRC"
+
+/** Protocol suffix used by the IRC+ protocol, see <doc/Protocol.txt>. */
+#define PROTOIRCPLUS "-IRC+"
+
+#ifdef IRCPLUS
+/** Standard IRC+ flags. */
+# define IRCPLUSFLAGS "CHLS"
#endif
+/** Supported user modes. */
+#define USERMODES "abBcCioqrRswx"
+
+/** Supported channel modes. */
+#define CHANMODES "abehiIklmMnoOPqQrRstvVz"
+
+/** Away message for users connected to linked servers. */
+#define DEFAULT_AWAY_MSG "Away"
+
+/** Default ID for "topic owner". */
+#define DEFAULT_TOPIC_ID "-Server-"
+
+/** Prefix for NOTICEs from the server to users. Some servers use '*'. */
+#define NOTICE_TXTPREFIX ""
+
+/** Suffix for oversized messages that have been shortened and cut off. */
+#define CUT_TXTSUFFIX "[CUT]"
+
+
+/* Defaults and limits for IRC commands */
+
+/** Max. number of elemets allowed in channel invite and ban lists. */
+#define MAX_HNDL_CHANNEL_LISTS 50
+
+/** Max. number of channel modes with arguments per MODE command. */
+#define MAX_HNDL_MODES_ARG 5
+
+/** Max. number of WHO replies. */
+#define MAX_RPL_WHO 25
+
+/** Max. number of WHOIS replies. */
+#define MAX_RPL_WHOIS 10
+
+/** Default count of WHOWAS command replies. */
+#define DEF_RPL_WHOWAS 5
+
+/** Max count of WHOWAS command replies. */
+#define MAX_RPL_WHOWAS 25
+
+
+#endif
/* -eof- */
projects / ngircd-alex.git / blobdiff