a47c81ea81b72ed0d9de6be6cd321e1a761b3369
[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 #if defined(__cplusplus) || defined(c_plusplus)
27 extern "C" {
28 #endif
29
30 #define AST_CACHE_DIR_LEN       512
31 #define AST_FILENAME_MAX        80
32
33 /*! \ingroup main_options */
34 enum ast_option_flags {
35         /*! Allow \#exec in config files */
36         AST_OPT_FLAG_EXEC_INCLUDES = (1 << 0),
37         /*! Do not fork() */
38         AST_OPT_FLAG_NO_FORK = (1 << 1),
39         /*! Keep quiet */
40         AST_OPT_FLAG_QUIET = (1 << 2),
41         /*! Console mode */
42         AST_OPT_FLAG_CONSOLE = (1 << 3),
43         /*! Run in realtime Linux priority */
44         AST_OPT_FLAG_HIGH_PRIORITY = (1 << 4),
45         /*! Initialize keys for RSA authentication */
46         AST_OPT_FLAG_INIT_KEYS = (1 << 5),
47         /*! Remote console */
48         AST_OPT_FLAG_REMOTE = (1 << 6),
49         /*! Execute an asterisk CLI command upon startup */
50         AST_OPT_FLAG_EXEC = (1 << 7),
51         /*! Don't use termcap colors */
52         AST_OPT_FLAG_NO_COLOR = (1 << 8),
53         /*! Are we fully started yet? */
54         AST_OPT_FLAG_FULLY_BOOTED = (1 << 9),
55         /*! Trascode via signed linear */
56         AST_OPT_FLAG_TRANSCODE_VIA_SLIN = (1 << 10),
57         /*! Dump core on a seg fault */
58         AST_OPT_FLAG_DUMP_CORE = (1 << 12),
59         /*! Cache sound files */
60         AST_OPT_FLAG_CACHE_RECORD_FILES = (1 << 13),
61         /*! Display timestamp in CLI verbose output */
62         AST_OPT_FLAG_TIMESTAMP = (1 << 14),
63         /*! Override config */
64         AST_OPT_FLAG_OVERRIDE_CONFIG = (1 << 15),
65         /*! Reconnect */
66         AST_OPT_FLAG_RECONNECT = (1 << 16),
67         /*! Transmit Silence during Record() */
68         AST_OPT_FLAG_TRANSMIT_SILENCE = (1 << 17),
69         /*! Suppress some warnings */
70         AST_OPT_FLAG_DONT_WARN = (1 << 18),
71         /*! End CDRs before the 'h' extension */
72         AST_OPT_FLAG_END_CDR_BEFORE_H_EXTEN = (1 << 19),
73         /*! Use Zaptel Timing for generators if available */
74         AST_OPT_FLAG_INTERNAL_TIMING = (1 << 20),
75         /*! Always fork, even if verbose or debug settings are non-zero */
76         AST_OPT_FLAG_ALWAYS_FORK = (1 << 21),
77         /*! Disable log/verbose output to remote consoles */
78         AST_OPT_FLAG_MUTE = (1 << 22)
79 };
80
81 /*! These are the options that set by default when Asterisk starts */
82 #define AST_DEFAULT_OPTIONS AST_OPT_FLAG_TRANSCODE_VIA_SLIN
83
84 #define ast_opt_exec_includes           ast_test_flag(&ast_options, AST_OPT_FLAG_EXEC_INCLUDES)
85 #define ast_opt_no_fork                 ast_test_flag(&ast_options, AST_OPT_FLAG_NO_FORK)
86 #define ast_opt_quiet                   ast_test_flag(&ast_options, AST_OPT_FLAG_QUIET)
87 #define ast_opt_console                 ast_test_flag(&ast_options, AST_OPT_FLAG_CONSOLE)
88 #define ast_opt_high_priority           ast_test_flag(&ast_options, AST_OPT_FLAG_HIGH_PRIORITY)
89 #define ast_opt_init_keys               ast_test_flag(&ast_options, AST_OPT_FLAG_INIT_KEYS)
90 #define ast_opt_remote                  ast_test_flag(&ast_options, AST_OPT_FLAG_REMOTE)
91 #define ast_opt_exec                    ast_test_flag(&ast_options, AST_OPT_FLAG_EXEC)
92 #define ast_opt_no_color                ast_test_flag(&ast_options, AST_OPT_FLAG_NO_COLOR)
93 #define ast_fully_booted                ast_test_flag(&ast_options, AST_OPT_FLAG_FULLY_BOOTED)
94 #define ast_opt_transcode_via_slin      ast_test_flag(&ast_options, AST_OPT_FLAG_TRANSCODE_VIA_SLIN)
95 #define ast_opt_dump_core               ast_test_flag(&ast_options, AST_OPT_FLAG_DUMP_CORE)
96 #define ast_opt_cache_record_files      ast_test_flag(&ast_options, AST_OPT_FLAG_CACHE_RECORD_FILES)
97 #define ast_opt_timestamp               ast_test_flag(&ast_options, AST_OPT_FLAG_TIMESTAMP)
98 #define ast_opt_override_config         ast_test_flag(&ast_options, AST_OPT_FLAG_OVERRIDE_CONFIG)
99 #define ast_opt_reconnect               ast_test_flag(&ast_options, AST_OPT_FLAG_RECONNECT)
100 #define ast_opt_transmit_silence        ast_test_flag(&ast_options, AST_OPT_FLAG_TRANSMIT_SILENCE)
101 #define ast_opt_dont_warn               ast_test_flag(&ast_options, AST_OPT_FLAG_DONT_WARN)
102 #define ast_opt_end_cdr_before_h_exten  ast_test_flag(&ast_options, AST_OPT_FLAG_END_CDR_BEFORE_H_EXTEN)
103 #define ast_opt_internal_timing         ast_test_flag(&ast_options, AST_OPT_FLAG_INTERNAL_TIMING)
104 #define ast_opt_always_fork             ast_test_flag(&ast_options, AST_OPT_FLAG_ALWAYS_FORK)
105 #define ast_opt_mute                    ast_test_flag(&ast_options, AST_OPT_FLAG_MUTE)
106
107 extern struct ast_flags ast_options;
108
109 extern int option_verbose;
110 extern int option_maxfiles;             /*!< Max number of open file handles (files, sockets) */
111 extern int option_debug;                /*!< Debugging */
112 extern int option_maxcalls;             /*!< Maximum number of simultaneous channels */
113 extern double option_maxload;
114 #if defined(HAVE_SYSINFO)
115 extern long option_minmemfree;          /*!< Minimum amount of free system memory - stop accepting calls if free memory falls below this watermark */
116 #endif
117 extern char defaultlanguage[];
118
119 extern time_t ast_startuptime;
120 extern time_t ast_lastreloadtime;
121 extern pid_t ast_mainpid;
122
123 extern char record_cache_dir[AST_CACHE_DIR_LEN];
124 extern char debug_filename[AST_FILENAME_MAX];
125
126 extern int ast_language_is_prefix;
127
128 #if defined(__cplusplus) || defined(c_plusplus)
129 }
130 #endif
131
132 #endif /* _ASTERISK_OPTIONS_H */