defines.h: Code cleanup and (a little bit) more documentation
This commit is contained in:
Alexander Barton
parent
470d2e2362
commit
c2ac1ad3ba
|
|
@ -1,6 +1,6 @@
|
|||
/*
|
||||
* ngIRCd -- The Next Generation IRC Daemon
|
||||
* Copyright (c)2001-2012 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
|
||||
|
|
@ -17,101 +17,173 @@
|
|||
* Global constants ("#defines") used by the ngIRCd.
|
||||
*/
|
||||
|
||||
|
||||
/* Internal flags */
|
||||
|
||||
/** Flag: there is no connection. */
|
||||
#define NONE -1
|
||||
|
||||
#define FNAME_LEN 256 /* Max. length of file name */
|
||||
/** Flag: connection is (still) established. */
|
||||
#define CONNECTED true
|
||||
|
||||
#define LINE_LEN 256 /* Max. length of a line in the
|
||||
configuration file */
|
||||
|
||||
#define HOST_LEN 256 /* Max. lenght of fully qualified host
|
||||
names (e. g. "abc.domain.tld") */
|
||||
|
||||
#define MAX_SERVERS 16 /* Max. count of configurable servers */
|
||||
|
||||
#define MAX_WHOWAS 64 /* Max. number of WHOWAS items */
|
||||
#define DEFAULT_WHOWAS 5 /* default count for WHOWAS command */
|
||||
|
||||
#define MAX_CMODES_ARG 5 /* Max. number of channel modes with
|
||||
* arguments per MODE command */
|
||||
|
||||
#define CONNECTION_POOL 100 /* Size of default connection pool */
|
||||
|
||||
#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_DEFAULT 10 /* Default nick length, see. RFC 2812
|
||||
* section 1.2.1 */
|
||||
#define CLIENT_NICK_LEN 32 /* Maximum nick name length */
|
||||
#define CLIENT_PASS_LEN 21 /* Max. password length */
|
||||
#define CLIENT_USER_LEN 10 /* Max. length of user name ("login")
|
||||
see RFC 2812, section 1.2.1 */
|
||||
#define CLIENT_NAME_LEN 32 /* Max. length of "real names" */
|
||||
#define CLIENT_HOST_LEN 64 /* Max. host name length */
|
||||
#define CLIENT_MODE_LEN 16 /* Max. length 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 16 /* Max. length of client flags */
|
||||
|
||||
#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 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 in bytes. */
|
||||
#define WRITEBUFFER_FLUSH_LEN 4096 /* Size of a write buffer that triggers
|
||||
buffer flushing if more space is
|
||||
needed for storing data. */
|
||||
#define WRITEBUFFER_MAX_LEN 32768 /* Maximum size of the write buffer of a
|
||||
connection in bytes. */
|
||||
#define WRITEBUFFER_SLINK_LEN 65536 /* Maximum size of the write buffer of a
|
||||
server link connection in bytes. */
|
||||
|
||||
#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 "CHLS" /* 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
|
||||
in seconds. */
|
||||
|
||||
#define USERMODES "aciorRswx" /* Supported user modes. */
|
||||
#define CHANMODES "biIklmnoOPRstvz" /* Supported channel modes. */
|
||||
|
||||
#define CONNECTED true /* Internal status codes. */
|
||||
/** Flag: connection isn't established (any more). */
|
||||
#define DISCONNECTED false
|
||||
|
||||
#define DEFAULT_AWAY_MSG "Away" /* Away message for users connected to
|
||||
linked servers. */
|
||||
/** Tag for outbound server links. */
|
||||
#define TOKEN_OUTBOUND -2
|
||||
|
||||
#define DEFAULT_TOPIC_ID "-Server-" /* Default ID for "topic owner". */
|
||||
|
||||
#define CONFIG_FILE "/ngircd.conf" /* Configuration file name. */
|
||||
#define MOTD_FILE "/ngircd.motd" /* Name of the MOTD file. */
|
||||
#define CHROOT_DIR "" /* Default chroot() directory. */
|
||||
#define PID_FILE "" /* Default file for the process ID. */
|
||||
/* Generic buffer sizes */
|
||||
|
||||
#define ERROR_DIR "/tmp" /* Error directory used in debug mode */
|
||||
/** Max. length of a line in the configuration file. */
|
||||
#define LINE_LEN 256
|
||||
|
||||
#define MAX_LOG_MSG_LEN 256 /* Max. length of a log message. */
|
||||
/** Max. length of a log message. */
|
||||
#define MAX_LOG_MSG_LEN 256
|
||||
|
||||
#define TOKEN_OUTBOUND -2 /* Tag for outbound server links. */
|
||||
/** Max. length of file name. */
|
||||
#define FNAME_LEN 256
|
||||
|
||||
#define NOTICE_TXTPREFIX "" /* Prefix for NOTICEs from the server
|
||||
to users. Some servers use '*'. */
|
||||
/** Max. lenght of fully qualified host names (e. g. "abc.domain.tld"). */
|
||||
#define HOST_LEN 256
|
||||
|
||||
|
||||
/* Size of structures */
|
||||
|
||||
/** Max. count of configurable servers. */
|
||||
#define MAX_SERVERS 16
|
||||
|
||||
/** Max. number of WHOWAS list items that can be stored. */
|
||||
#define MAX_WHOWAS 64
|
||||
|
||||
/** Size of default connection pool. */
|
||||
#define CONNECTION_POOL 100
|
||||
|
||||
|
||||
/* Hard-coded (default) options */
|
||||
|
||||
/** Delay after startup before outgoing connections are initiated in seconds. */
|
||||
#define STARTUP_DELAY 1
|
||||
|
||||
/** 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"
|
||||
|
||||
/** Default chroot() directory. */
|
||||
#define CHROOT_DIR ""
|
||||
|
||||
/** Default file for the process ID. */
|
||||
#define PID_FILE ""
|
||||
|
||||
|
||||
/* Sizes of "IRC elements": nicks, users, ... */
|
||||
|
||||
/** Max. length of an IRC ID (incl. NULL); see RFC 2812 section 1.1 and 1.2.1. */
|
||||
#define CLIENT_ID_LEN 64
|
||||
|
||||
/** 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 16
|
||||
|
||||
/** 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 9
|
||||
|
||||
/** Max. IRC command length (including NULL), see. RFC 2812 section 3.2. */
|
||||
#define COMMAND_LEN 513
|
||||
|
||||
|
||||
/* 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 "aciorRswx"
|
||||
|
||||
/** Supported channel modes. */
|
||||
#define CHANMODES "biIklmnoOPRstvz"
|
||||
|
||||
/** 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 */
|
||||
|
||||
/** Default count of WHOWAS command replies */
|
||||
#define DEFAULT_WHOWAS 5
|
||||
|
||||
/** Max. number of channel modes with arguments per MODE command */
|
||||
#define MAX_CMODES_ARG 5
|
||||
|
||||
#define CUT_TXTSUFFIX "[CUT]" /* Suffix for oversized messages that
|
||||
have been shortened and cut off. */
|
||||
|
||||
#endif
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue