Wed Oct 28 11:45:39 2009

Asterisk developer's documentation


options.h

Go to the documentation of this file.
00001 /*
00002  * Asterisk -- An open source telephony toolkit.
00003  *
00004  * Copyright (C) 1999 - 2005, Digium, Inc.
00005  *
00006  * Mark Spencer <markster@digium.com>
00007  *
00008  * See http://www.asterisk.org for more information about
00009  * the Asterisk project. Please do not directly contact
00010  * any of the maintainers of this project for assistance;
00011  * the project provides a web site, mailing lists and IRC
00012  * channels for your use.
00013  *
00014  * This program is free software, distributed under the terms of
00015  * the GNU General Public License Version 2. See the LICENSE file
00016  * at the top of the source tree.
00017  */
00018 
00019 /*! \file
00020  * \brief Options provided by main asterisk program
00021  */
00022 
00023 #ifndef _ASTERISK_OPTIONS_H
00024 #define _ASTERISK_OPTIONS_H
00025 
00026 #if defined(__cplusplus) || defined(c_plusplus)
00027 extern "C" {
00028 #endif
00029 
00030 #define AST_CACHE_DIR_LEN  512
00031 #define AST_FILENAME_MAX   80
00032 #define AST_CHANNEL_NAME    80  /*!< Max length of an ast_channel name */
00033 
00034 
00035 /*! \ingroup main_options */
00036 enum ast_option_flags {
00037    /*! Allow \#exec in config files */
00038    AST_OPT_FLAG_EXEC_INCLUDES = (1 << 0),
00039    /*! Do not fork() */
00040    AST_OPT_FLAG_NO_FORK = (1 << 1),
00041    /*! Keep quiet */
00042    AST_OPT_FLAG_QUIET = (1 << 2),
00043    /*! Console mode */
00044    AST_OPT_FLAG_CONSOLE = (1 << 3),
00045    /*! Run in realtime Linux priority */
00046    AST_OPT_FLAG_HIGH_PRIORITY = (1 << 4),
00047    /*! Initialize keys for RSA authentication */
00048    AST_OPT_FLAG_INIT_KEYS = (1 << 5),
00049    /*! Remote console */
00050    AST_OPT_FLAG_REMOTE = (1 << 6),
00051    /*! Execute an asterisk CLI command upon startup */
00052    AST_OPT_FLAG_EXEC = (1 << 7),
00053    /*! Don't use termcap colors */
00054    AST_OPT_FLAG_NO_COLOR = (1 << 8),
00055    /*! Are we fully started yet? */
00056    AST_OPT_FLAG_FULLY_BOOTED = (1 << 9),
00057    /*! Trascode via signed linear */
00058    AST_OPT_FLAG_TRANSCODE_VIA_SLIN = (1 << 10),
00059    /*! Dump core on a seg fault */
00060    AST_OPT_FLAG_DUMP_CORE = (1 << 12),
00061    /*! Cache sound files */
00062    AST_OPT_FLAG_CACHE_RECORD_FILES = (1 << 13),
00063    /*! Display timestamp in CLI verbose output */
00064    AST_OPT_FLAG_TIMESTAMP = (1 << 14),
00065    /*! Override config */
00066    AST_OPT_FLAG_OVERRIDE_CONFIG = (1 << 15),
00067    /*! Reconnect */
00068    AST_OPT_FLAG_RECONNECT = (1 << 16),
00069    /*! Transmit Silence during Record() and DTMF Generation */
00070    AST_OPT_FLAG_TRANSMIT_SILENCE = (1 << 17),
00071    /*! Suppress some warnings */
00072    AST_OPT_FLAG_DONT_WARN = (1 << 18),
00073    /*! End CDRs before the 'h' extension */
00074    AST_OPT_FLAG_END_CDR_BEFORE_H_EXTEN = (1 << 19),
00075    /*! Use DAHDI Timing for generators if available */
00076    AST_OPT_FLAG_INTERNAL_TIMING = (1 << 20),
00077    /*! Always fork, even if verbose or debug settings are non-zero */
00078    AST_OPT_FLAG_ALWAYS_FORK = (1 << 21),
00079    /*! Disable log/verbose output to remote consoles */
00080    AST_OPT_FLAG_MUTE = (1 << 22),
00081    /*! There is a per-file debug setting */
00082    AST_OPT_FLAG_DEBUG_FILE = (1 << 23),
00083    /*! There is a per-file verbose setting */
00084    AST_OPT_FLAG_VERBOSE_FILE = (1 << 24),
00085 };
00086 
00087 /*! These are the options that set by default when Asterisk starts */
00088 #define AST_DEFAULT_OPTIONS AST_OPT_FLAG_TRANSCODE_VIA_SLIN
00089 
00090 #define ast_opt_exec_includes    ast_test_flag(&ast_options, AST_OPT_FLAG_EXEC_INCLUDES)
00091 #define ast_opt_no_fork       ast_test_flag(&ast_options, AST_OPT_FLAG_NO_FORK)
00092 #define ast_opt_quiet         ast_test_flag(&ast_options, AST_OPT_FLAG_QUIET)
00093 #define ast_opt_console       ast_test_flag(&ast_options, AST_OPT_FLAG_CONSOLE)
00094 #define ast_opt_high_priority    ast_test_flag(&ast_options, AST_OPT_FLAG_HIGH_PRIORITY)
00095 #define ast_opt_init_keys     ast_test_flag(&ast_options, AST_OPT_FLAG_INIT_KEYS)
00096 #define ast_opt_remote        ast_test_flag(&ast_options, AST_OPT_FLAG_REMOTE)
00097 #define ast_opt_exec       ast_test_flag(&ast_options, AST_OPT_FLAG_EXEC)
00098 #define ast_opt_no_color      ast_test_flag(&ast_options, AST_OPT_FLAG_NO_COLOR)
00099 #define ast_fully_booted      ast_test_flag(&ast_options, AST_OPT_FLAG_FULLY_BOOTED)
00100 #define ast_opt_transcode_via_slin  ast_test_flag(&ast_options, AST_OPT_FLAG_TRANSCODE_VIA_SLIN)
00101 #define ast_opt_dump_core     ast_test_flag(&ast_options, AST_OPT_FLAG_DUMP_CORE)
00102 #define ast_opt_cache_record_files  ast_test_flag(&ast_options, AST_OPT_FLAG_CACHE_RECORD_FILES)
00103 #define ast_opt_timestamp     ast_test_flag(&ast_options, AST_OPT_FLAG_TIMESTAMP)
00104 #define ast_opt_override_config     ast_test_flag(&ast_options, AST_OPT_FLAG_OVERRIDE_CONFIG)
00105 #define ast_opt_reconnect     ast_test_flag(&ast_options, AST_OPT_FLAG_RECONNECT)
00106 #define ast_opt_transmit_silence ast_test_flag(&ast_options, AST_OPT_FLAG_TRANSMIT_SILENCE)
00107 #define ast_opt_dont_warn     ast_test_flag(&ast_options, AST_OPT_FLAG_DONT_WARN)
00108 #define ast_opt_end_cdr_before_h_exten ast_test_flag(&ast_options, AST_OPT_FLAG_END_CDR_BEFORE_H_EXTEN)
00109 #define ast_opt_internal_timing     ast_test_flag(&ast_options, AST_OPT_FLAG_INTERNAL_TIMING)
00110 #define ast_opt_always_fork      ast_test_flag(&ast_options, AST_OPT_FLAG_ALWAYS_FORK)
00111 #define ast_opt_mute       ast_test_flag(&ast_options, AST_OPT_FLAG_MUTE)
00112 #define ast_opt_dbg_file      ast_test_flag(&ast_options, AST_OPT_FLAG_DEBUG_FILE)
00113 #define ast_opt_verb_file     ast_test_flag(&ast_options, AST_OPT_FLAG_VERBOSE_FILE)
00114 
00115 extern struct ast_flags ast_options;
00116 
00117 enum ast_compat_flags {
00118    AST_COMPAT_DELIM_PBX_REALTIME = (1 << 0),
00119    AST_COMPAT_DELIM_RES_AGI = (1 << 1),
00120    AST_COMPAT_APP_SET = (1 << 2),
00121 };
00122 
00123 #define  ast_compat_pbx_realtime ast_test_flag(&ast_compat, AST_COMPAT_DELIM_PBX_REALTIME)
00124 #define ast_compat_res_agi ast_test_flag(&ast_compat, AST_COMPAT_DELIM_RES_AGI)
00125 #define  ast_compat_app_set   ast_test_flag(&ast_compat, AST_COMPAT_APP_SET)
00126 
00127 extern struct ast_flags ast_compat;
00128 
00129 extern int option_verbose;
00130 extern int option_maxfiles;      /*!< Max number of open file handles (files, sockets) */
00131 extern int option_debug;      /*!< Debugging */
00132 extern int option_maxcalls;      /*!< Maximum number of simultaneous channels */
00133 extern double option_maxload;
00134 #if defined(HAVE_SYSINFO)
00135 extern long option_minmemfree;      /*!< Minimum amount of free system memory - stop accepting calls if free memory falls below this watermark */
00136 #endif
00137 extern char defaultlanguage[];
00138 
00139 extern struct timeval ast_startuptime;
00140 extern struct timeval ast_lastreloadtime;
00141 extern pid_t ast_mainpid;
00142 
00143 extern char record_cache_dir[AST_CACHE_DIR_LEN];
00144 
00145 extern int ast_language_is_prefix;
00146 
00147 #if defined(__cplusplus) || defined(c_plusplus)
00148 }
00149 #endif
00150 
00151 #endif /* _ASTERISK_OPTIONS_H */

Generated on Wed Oct 28 11:45:39 2009 for Asterisk - the Open Source PBX by  doxygen 1.5.6