options.h

Go to the documentation of this file.

/*
 * Asterisk -- An open source telephony toolkit.
 *
 * Copyright (C) 1999 - 2005, Digium, Inc.
 *
 * Mark Spencer <markster@digium.com>
 *
 * See http://www.asterisk.org for more information about
 * the Asterisk project. Please do not directly contact
 * any of the maintainers of this project for assistance;
 * the project provides a web site, mailing lists and IRC
 * channels for your use.
 *
 * This program is free software, distributed under the terms of
 * the GNU General Public License Version 2. See the LICENSE file
 * at the top of the source tree.
 */

/*! \file
 * \brief Options provided by main asterisk program
 */

#ifndef _ASTERISK_OPTIONS_H
#define _ASTERISK_OPTIONS_H

#if defined(__cplusplus) || defined(c_plusplus)
extern "C" {
#endif

#define AST_CACHE_DIR_LEN  512
#define AST_FILENAME_MAX   80
#define AST_CHANNEL_NAME    80  /*!< Max length of an ast_channel name */


/*! \ingroup main_options */
enum ast_option_flags {
   /*! Allow \#exec in config files */
   AST_OPT_FLAG_EXEC_INCLUDES = (1 << 0),
   /*! Do not fork() */
   AST_OPT_FLAG_NO_FORK = (1 << 1),
   /*! Keep quiet */
   AST_OPT_FLAG_QUIET = (1 << 2),
   /*! Console mode */
   AST_OPT_FLAG_CONSOLE = (1 << 3),
   /*! Run in realtime Linux priority */
   AST_OPT_FLAG_HIGH_PRIORITY = (1 << 4),
   /*! Initialize keys for RSA authentication */
   AST_OPT_FLAG_INIT_KEYS = (1 << 5),
   /*! Remote console */
   AST_OPT_FLAG_REMOTE = (1 << 6),
   /*! Execute an asterisk CLI command upon startup */
   AST_OPT_FLAG_EXEC = (1 << 7),
   /*! Don't use termcap colors */
   AST_OPT_FLAG_NO_COLOR = (1 << 8),
   /*! Are we fully started yet? */
   AST_OPT_FLAG_FULLY_BOOTED = (1 << 9),
   /*! Trascode via signed linear */
   AST_OPT_FLAG_TRANSCODE_VIA_SLIN = (1 << 10),
   /*! Dump core on a seg fault */
   AST_OPT_FLAG_DUMP_CORE = (1 << 12),
   /*! Cache sound files */
   AST_OPT_FLAG_CACHE_RECORD_FILES = (1 << 13),
   /*! Display timestamp in CLI verbose output */
   AST_OPT_FLAG_TIMESTAMP = (1 << 14),
   /*! Override config */
   AST_OPT_FLAG_OVERRIDE_CONFIG = (1 << 15),
   /*! Reconnect */
   AST_OPT_FLAG_RECONNECT = (1 << 16),
   /*! Transmit Silence during Record() and DTMF Generation */
   AST_OPT_FLAG_TRANSMIT_SILENCE = (1 << 17),
   /*! Suppress some warnings */
   AST_OPT_FLAG_DONT_WARN = (1 << 18),
   /*! End CDRs before the 'h' extension */
   AST_OPT_FLAG_END_CDR_BEFORE_H_EXTEN = (1 << 19),
   /*! Use DAHDI Timing for generators if available */
   AST_OPT_FLAG_INTERNAL_TIMING = (1 << 20),
   /*! Always fork, even if verbose or debug settings are non-zero */
   AST_OPT_FLAG_ALWAYS_FORK = (1 << 21),
   /*! Disable log/verbose output to remote consoles */
   AST_OPT_FLAG_MUTE = (1 << 22),
   /*! There is a per-file debug setting */
   AST_OPT_FLAG_DEBUG_FILE = (1 << 23),
   /*! There is a per-file verbose setting */
   AST_OPT_FLAG_VERBOSE_FILE = (1 << 24),
   /*! Terminal colors should be adjusted for a light-colored background */
   AST_OPT_FLAG_LIGHT_BACKGROUND = (1 << 25),
   /*! Count Initiated seconds in CDR's */
   AST_OPT_FLAG_INITIATED_SECONDS = (1 << 26),
   /*! Force black background */
   AST_OPT_FLAG_FORCE_BLACK_BACKGROUND = (1 << 27),
   /*! Hide remote console connect messages on console */
   AST_OPT_FLAG_HIDE_CONSOLE_CONNECT = (1 << 28),
};

/*! These are the options that set by default when Asterisk starts */
#define AST_DEFAULT_OPTIONS AST_OPT_FLAG_TRANSCODE_VIA_SLIN

#define ast_opt_exec_includes    ast_test_flag(&ast_options, AST_OPT_FLAG_EXEC_INCLUDES)
#define ast_opt_no_fork       ast_test_flag(&ast_options, AST_OPT_FLAG_NO_FORK)
#define ast_opt_quiet         ast_test_flag(&ast_options, AST_OPT_FLAG_QUIET)
#define ast_opt_console       ast_test_flag(&ast_options, AST_OPT_FLAG_CONSOLE)
#define ast_opt_high_priority    ast_test_flag(&ast_options, AST_OPT_FLAG_HIGH_PRIORITY)
#define ast_opt_init_keys     ast_test_flag(&ast_options, AST_OPT_FLAG_INIT_KEYS)
#define ast_opt_remote        ast_test_flag(&ast_options, AST_OPT_FLAG_REMOTE)
#define ast_opt_exec       ast_test_flag(&ast_options, AST_OPT_FLAG_EXEC)
#define ast_opt_no_color      ast_test_flag(&ast_options, AST_OPT_FLAG_NO_COLOR)
#define ast_fully_booted      ast_test_flag(&ast_options, AST_OPT_FLAG_FULLY_BOOTED)
#define ast_opt_transcode_via_slin  ast_test_flag(&ast_options, AST_OPT_FLAG_TRANSCODE_VIA_SLIN)
#define ast_opt_dump_core     ast_test_flag(&ast_options, AST_OPT_FLAG_DUMP_CORE)
#define ast_opt_cache_record_files  ast_test_flag(&ast_options, AST_OPT_FLAG_CACHE_RECORD_FILES)
#define ast_opt_timestamp     ast_test_flag(&ast_options, AST_OPT_FLAG_TIMESTAMP)
#define ast_opt_override_config     ast_test_flag(&ast_options, AST_OPT_FLAG_OVERRIDE_CONFIG)
#define ast_opt_reconnect     ast_test_flag(&ast_options, AST_OPT_FLAG_RECONNECT)
#define ast_opt_transmit_silence ast_test_flag(&ast_options, AST_OPT_FLAG_TRANSMIT_SILENCE)
#define ast_opt_dont_warn     ast_test_flag(&ast_options, AST_OPT_FLAG_DONT_WARN)
#define ast_opt_end_cdr_before_h_exten ast_test_flag(&ast_options, AST_OPT_FLAG_END_CDR_BEFORE_H_EXTEN)
#define ast_opt_internal_timing     ast_test_flag(&ast_options, AST_OPT_FLAG_INTERNAL_TIMING)
#define ast_opt_always_fork      ast_test_flag(&ast_options, AST_OPT_FLAG_ALWAYS_FORK)
#define ast_opt_mute       ast_test_flag(&ast_options, AST_OPT_FLAG_MUTE)
#define ast_opt_dbg_file      ast_test_flag(&ast_options, AST_OPT_FLAG_DEBUG_FILE)
#define ast_opt_verb_file     ast_test_flag(&ast_options, AST_OPT_FLAG_VERBOSE_FILE)
#define ast_opt_light_background    ast_test_flag(&ast_options, AST_OPT_FLAG_LIGHT_BACKGROUND)
#define ast_opt_force_black_background    ast_test_flag(&ast_options, AST_OPT_FLAG_FORCE_BLACK_BACKGROUND)
#define ast_opt_hide_connect     ast_test_flag(&ast_options, AST_OPT_FLAG_HIDE_CONSOLE_CONNECT)

extern struct ast_flags ast_options;

enum ast_compat_flags {
   AST_COMPAT_DELIM_PBX_REALTIME = (1 << 0),
   AST_COMPAT_DELIM_RES_AGI = (1 << 1),
   AST_COMPAT_APP_SET = (1 << 2),
};

#define  ast_compat_pbx_realtime ast_test_flag(&ast_compat, AST_COMPAT_DELIM_PBX_REALTIME)
#define ast_compat_res_agi ast_test_flag(&ast_compat, AST_COMPAT_DELIM_RES_AGI)
#define  ast_compat_app_set   ast_test_flag(&ast_compat, AST_COMPAT_APP_SET)

extern struct ast_flags ast_compat;

extern int option_verbose;
extern int option_maxfiles;      /*!< Max number of open file handles (files, sockets) */
extern int option_debug;      /*!< Debugging */
extern int option_maxcalls;      /*!< Maximum number of simultaneous channels */
extern double option_maxload;
#if defined(HAVE_SYSINFO)
extern long option_minmemfree;      /*!< Minimum amount of free system memory - stop accepting calls if free memory falls below this watermark */
#endif
extern char defaultlanguage[];

extern struct timeval ast_startuptime;
extern struct timeval ast_lastreloadtime;
extern pid_t ast_mainpid;

extern char record_cache_dir[AST_CACHE_DIR_LEN];
extern char dahdi_chan_name[AST_CHANNEL_NAME];
extern int dahdi_chan_name_len;

extern int ast_language_is_prefix;

#if defined(__cplusplus) || defined(c_plusplus)
}
#endif

#endif /* _ASTERISK_OPTIONS_H */