Merged revisions 264248 via svnmerge from
[asterisk/asterisk.git] / include / asterisk / options.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2005, Digium, Inc.
5  *
6  * Mark Spencer <markster@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*! \file
20  * \brief Options provided by main asterisk program
21  */
22
23 #ifndef _ASTERISK_OPTIONS_H
24 #define _ASTERISK_OPTIONS_H
25
26 #include "asterisk/autoconfig.h"
27
28 #if defined(__cplusplus) || defined(c_plusplus)
29 extern "C" {
30 #endif
31
32 #define AST_CACHE_DIR_LEN       512
33 #define AST_FILENAME_MAX        80
34 #define AST_CHANNEL_NAME    80  /*!< Max length of an ast_channel name */
35
36
37 /*! \ingroup main_options */
38 enum ast_option_flags {
39         /*! Allow \#exec in config files */
40         AST_OPT_FLAG_EXEC_INCLUDES = (1 << 0),
41         /*! Do not fork() */
42         AST_OPT_FLAG_NO_FORK = (1 << 1),
43         /*! Keep quiet */
44         AST_OPT_FLAG_QUIET = (1 << 2),
45         /*! Console mode */
46         AST_OPT_FLAG_CONSOLE = (1 << 3),
47         /*! Run in realtime Linux priority */
48         AST_OPT_FLAG_HIGH_PRIORITY = (1 << 4),
49         /*! Initialize keys for RSA authentication */
50         AST_OPT_FLAG_INIT_KEYS = (1 << 5),
51         /*! Remote console */
52         AST_OPT_FLAG_REMOTE = (1 << 6),
53         /*! Execute an asterisk CLI command upon startup */
54         AST_OPT_FLAG_EXEC = (1 << 7),
55         /*! Don't use termcap colors */
56         AST_OPT_FLAG_NO_COLOR = (1 << 8),
57         /*! Are we fully started yet? */
58         AST_OPT_FLAG_FULLY_BOOTED = (1 << 9),
59         /*! Trascode via signed linear */
60         AST_OPT_FLAG_TRANSCODE_VIA_SLIN = (1 << 10),
61         /*! Dump core on a seg fault */
62         AST_OPT_FLAG_DUMP_CORE = (1 << 12),
63         /*! Cache sound files */
64         AST_OPT_FLAG_CACHE_RECORD_FILES = (1 << 13),
65         /*! Display timestamp in CLI verbose output */
66         AST_OPT_FLAG_TIMESTAMP = (1 << 14),
67         /*! Override config */
68         AST_OPT_FLAG_OVERRIDE_CONFIG = (1 << 15),
69         /*! Reconnect */
70         AST_OPT_FLAG_RECONNECT = (1 << 16),
71         /*! Transmit Silence during Record() and DTMF Generation */
72         AST_OPT_FLAG_TRANSMIT_SILENCE = (1 << 17),
73         /*! Suppress some warnings */
74         AST_OPT_FLAG_DONT_WARN = (1 << 18),
75         /*! End CDRs before the 'h' extension */
76         AST_OPT_FLAG_END_CDR_BEFORE_H_EXTEN = (1 << 19),
77         /*! Use DAHDI Timing for generators if available */
78         AST_OPT_FLAG_INTERNAL_TIMING = (1 << 20),
79         /*! Always fork, even if verbose or debug settings are non-zero */
80         AST_OPT_FLAG_ALWAYS_FORK = (1 << 21),
81         /*! Disable log/verbose output to remote consoles */
82         AST_OPT_FLAG_MUTE = (1 << 22),
83         /*! There is a per-module debug setting */
84         AST_OPT_FLAG_DEBUG_MODULE = (1 << 23),
85         /*! There is a per-module verbose setting */
86         AST_OPT_FLAG_VERBOSE_MODULE = (1 << 24),
87         /*! Terminal colors should be adjusted for a light-colored background */
88         AST_OPT_FLAG_LIGHT_BACKGROUND = (1 << 25),
89         /*! Count Initiated seconds in CDR's */
90         AST_OPT_FLAG_INITIATED_SECONDS = (1 << 26),
91         /*! Force black background */
92         AST_OPT_FLAG_FORCE_BLACK_BACKGROUND = (1 << 27),
93         /*! Hide remote console connect messages on console */
94         AST_OPT_FLAG_HIDE_CONSOLE_CONNECT = (1 << 28),
95         /*! Protect the configuration file path with a lock */
96         AST_OPT_FLAG_LOCK_CONFIG_DIR = (1 << 29),
97 };
98
99 /*! These are the options that set by default when Asterisk starts */
100 #if (defined(HAVE_DAHDI_VERSION) && HAVE_DAHDI_VERSION >= 230)
101 #define AST_DEFAULT_OPTIONS AST_OPT_FLAG_TRANSCODE_VIA_SLIN | AST_OPT_FLAG_INTERNAL_TIMING
102 #else
103 #define AST_DEFAULT_OPTIONS AST_OPT_FLAG_TRANSCODE_VIA_SLIN
104 #endif
105
106 #define ast_opt_exec_includes           ast_test_flag(&ast_options, AST_OPT_FLAG_EXEC_INCLUDES)
107 #define ast_opt_no_fork                 ast_test_flag(&ast_options, AST_OPT_FLAG_NO_FORK)
108 #define ast_opt_quiet                   ast_test_flag(&ast_options, AST_OPT_FLAG_QUIET)
109 #define ast_opt_console                 ast_test_flag(&ast_options, AST_OPT_FLAG_CONSOLE)
110 #define ast_opt_high_priority           ast_test_flag(&ast_options, AST_OPT_FLAG_HIGH_PRIORITY)
111 #define ast_opt_init_keys               ast_test_flag(&ast_options, AST_OPT_FLAG_INIT_KEYS)
112 #define ast_opt_remote                  ast_test_flag(&ast_options, AST_OPT_FLAG_REMOTE)
113 #define ast_opt_exec                    ast_test_flag(&ast_options, AST_OPT_FLAG_EXEC)
114 #define ast_opt_no_color                ast_test_flag(&ast_options, AST_OPT_FLAG_NO_COLOR)
115 #define ast_fully_booted                ast_test_flag(&ast_options, AST_OPT_FLAG_FULLY_BOOTED)
116 #define ast_opt_transcode_via_slin      ast_test_flag(&ast_options, AST_OPT_FLAG_TRANSCODE_VIA_SLIN)
117 #define ast_opt_dump_core               ast_test_flag(&ast_options, AST_OPT_FLAG_DUMP_CORE)
118 #define ast_opt_cache_record_files      ast_test_flag(&ast_options, AST_OPT_FLAG_CACHE_RECORD_FILES)
119 #define ast_opt_timestamp               ast_test_flag(&ast_options, AST_OPT_FLAG_TIMESTAMP)
120 #define ast_opt_override_config         ast_test_flag(&ast_options, AST_OPT_FLAG_OVERRIDE_CONFIG)
121 #define ast_opt_reconnect               ast_test_flag(&ast_options, AST_OPT_FLAG_RECONNECT)
122 #define ast_opt_transmit_silence        ast_test_flag(&ast_options, AST_OPT_FLAG_TRANSMIT_SILENCE)
123 #define ast_opt_dont_warn               ast_test_flag(&ast_options, AST_OPT_FLAG_DONT_WARN)
124 #define ast_opt_end_cdr_before_h_exten  ast_test_flag(&ast_options, AST_OPT_FLAG_END_CDR_BEFORE_H_EXTEN)
125 #define ast_opt_internal_timing         ast_test_flag(&ast_options, AST_OPT_FLAG_INTERNAL_TIMING)
126 #define ast_opt_always_fork             ast_test_flag(&ast_options, AST_OPT_FLAG_ALWAYS_FORK)
127 #define ast_opt_mute                    ast_test_flag(&ast_options, AST_OPT_FLAG_MUTE)
128 #define ast_opt_dbg_module              ast_test_flag(&ast_options, AST_OPT_FLAG_DEBUG_MODULE)
129 #define ast_opt_verb_module             ast_test_flag(&ast_options, AST_OPT_FLAG_VERBOSE_MODULE)
130 #define ast_opt_light_background        ast_test_flag(&ast_options, AST_OPT_FLAG_LIGHT_BACKGROUND)
131 #define ast_opt_force_black_background  ast_test_flag(&ast_options, AST_OPT_FLAG_FORCE_BLACK_BACKGROUND)
132 #define ast_opt_hide_connect            ast_test_flag(&ast_options, AST_OPT_FLAG_HIDE_CONSOLE_CONNECT)
133 #define ast_opt_lock_confdir            ast_test_flag(&ast_options, AST_OPT_FLAG_LOCK_CONFIG_DIR)
134
135 extern struct ast_flags ast_options;
136
137 enum ast_compat_flags {
138         AST_COMPAT_DELIM_PBX_REALTIME = (1 << 0),
139         AST_COMPAT_DELIM_RES_AGI = (1 << 1),
140         AST_COMPAT_APP_SET = (1 << 2),
141 };
142
143 #define ast_compat_pbx_realtime ast_test_flag(&ast_compat, AST_COMPAT_DELIM_PBX_REALTIME)
144 #define ast_compat_res_agi      ast_test_flag(&ast_compat, AST_COMPAT_DELIM_RES_AGI)
145 #define ast_compat_app_set      ast_test_flag(&ast_compat, AST_COMPAT_APP_SET)
146
147 extern struct ast_flags ast_compat;
148
149 extern int option_verbose;
150 extern int option_maxfiles;             /*!< Max number of open file handles (files, sockets) */
151 extern int option_debug;                /*!< Debugging */
152 extern int option_maxcalls;             /*!< Maximum number of simultaneous channels */
153 extern double option_maxload;
154 #if defined(HAVE_SYSINFO)
155 extern long option_minmemfree;          /*!< Minimum amount of free system memory - stop accepting calls if free memory falls below this watermark */
156 #endif
157 extern char defaultlanguage[];
158
159 extern struct timeval ast_startuptime;
160 extern struct timeval ast_lastreloadtime;
161 extern pid_t ast_mainpid;
162
163 extern char record_cache_dir[AST_CACHE_DIR_LEN];
164 extern char dahdi_chan_name[AST_CHANNEL_NAME];
165 extern int dahdi_chan_name_len;
166
167 extern int ast_language_is_prefix;
168
169 #if defined(__cplusplus) || defined(c_plusplus)
170 }
171 #endif
172
173 #endif /* _ASTERISK_OPTIONS_H */