Mon Mar 12 2012 21:41:16

Asterisk developer's documentation

Defines | Enumerations | Variables
options.h File Reference

Options provided by main asterisk program. More...

#include "asterisk/autoconfig.h"
Include dependency graph for options.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Defines

#define AST_CACHE_DIR_LEN   512
#define AST_CHANNEL_NAME   80
#define ast_compat_app_set   ast_test_flag(&ast_compat, AST_COMPAT_APP_SET)
#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_DEFAULT_OPTIONS   AST_OPT_FLAG_TRANSCODE_VIA_SLIN | AST_OPT_FLAG_INTERNAL_TIMING
#define AST_FILENAME_MAX   80
#define ast_fully_booted   ast_test_flag(&ast_options, AST_OPT_FLAG_FULLY_BOOTED)
#define ast_opt_always_fork   ast_test_flag(&ast_options, AST_OPT_FLAG_ALWAYS_FORK)
#define ast_opt_cache_record_files   ast_test_flag(&ast_options, AST_OPT_FLAG_CACHE_RECORD_FILES)
#define ast_opt_console   ast_test_flag(&ast_options, AST_OPT_FLAG_CONSOLE)
#define ast_opt_dbg_module   ast_test_flag(&ast_options, AST_OPT_FLAG_DEBUG_MODULE)
#define ast_opt_dont_warn   ast_test_flag(&ast_options, AST_OPT_FLAG_DONT_WARN)
#define ast_opt_dump_core   ast_test_flag(&ast_options, AST_OPT_FLAG_DUMP_CORE)
#define ast_opt_end_cdr_before_h_exten   ast_test_flag(&ast_options, AST_OPT_FLAG_END_CDR_BEFORE_H_EXTEN)
#define ast_opt_exec   ast_test_flag(&ast_options, AST_OPT_FLAG_EXEC)
#define ast_opt_exec_includes   ast_test_flag(&ast_options, AST_OPT_FLAG_EXEC_INCLUDES)
#define ast_opt_force_black_background   ast_test_flag(&ast_options, AST_OPT_FLAG_FORCE_BLACK_BACKGROUND)
#define ast_opt_generic_plc   ast_test_flag(&ast_options, AST_OPT_FLAG_GENERIC_PLC)
#define ast_opt_hide_connect   ast_test_flag(&ast_options, AST_OPT_FLAG_HIDE_CONSOLE_CONNECT)
#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_internal_timing   ast_test_flag(&ast_options, AST_OPT_FLAG_INTERNAL_TIMING)
#define ast_opt_light_background   ast_test_flag(&ast_options, AST_OPT_FLAG_LIGHT_BACKGROUND)
#define ast_opt_lock_confdir   ast_test_flag(&ast_options, AST_OPT_FLAG_LOCK_CONFIG_DIR)
#define ast_opt_mute   ast_test_flag(&ast_options, AST_OPT_FLAG_MUTE)
#define ast_opt_no_color   ast_test_flag(&ast_options, AST_OPT_FLAG_NO_COLOR)
#define ast_opt_no_fork   ast_test_flag(&ast_options, AST_OPT_FLAG_NO_FORK)
#define ast_opt_override_config   ast_test_flag(&ast_options, AST_OPT_FLAG_OVERRIDE_CONFIG)
#define ast_opt_quiet   ast_test_flag(&ast_options, AST_OPT_FLAG_QUIET)
#define ast_opt_reconnect   ast_test_flag(&ast_options, AST_OPT_FLAG_RECONNECT)
#define ast_opt_remote   ast_test_flag(&ast_options, AST_OPT_FLAG_REMOTE)
#define ast_opt_timestamp   ast_test_flag(&ast_options, AST_OPT_FLAG_TIMESTAMP)
#define ast_opt_transcode_via_slin   ast_test_flag(&ast_options, AST_OPT_FLAG_TRANSCODE_VIA_SLIN)
#define ast_opt_transmit_silence   ast_test_flag(&ast_options, AST_OPT_FLAG_TRANSMIT_SILENCE)
#define ast_opt_verb_module   ast_test_flag(&ast_options, AST_OPT_FLAG_VERBOSE_MODULE)

Enumerations

enum  ast_compat_flags { AST_COMPAT_DELIM_PBX_REALTIME = (1 << 0), AST_COMPAT_DELIM_RES_AGI = (1 << 1), AST_COMPAT_APP_SET = (1 << 2) }
enum  ast_option_flags {
  AST_OPT_FLAG_EXEC_INCLUDES = (1 << 0), AST_OPT_FLAG_NO_FORK = (1 << 1), AST_OPT_FLAG_QUIET = (1 << 2), AST_OPT_FLAG_CONSOLE = (1 << 3),
  AST_OPT_FLAG_HIGH_PRIORITY = (1 << 4), AST_OPT_FLAG_INIT_KEYS = (1 << 5), AST_OPT_FLAG_REMOTE = (1 << 6), AST_OPT_FLAG_EXEC = (1 << 7),
  AST_OPT_FLAG_NO_COLOR = (1 << 8), AST_OPT_FLAG_FULLY_BOOTED = (1 << 9), AST_OPT_FLAG_TRANSCODE_VIA_SLIN = (1 << 10), AST_OPT_FLAG_DUMP_CORE = (1 << 12),
  AST_OPT_FLAG_CACHE_RECORD_FILES = (1 << 13), AST_OPT_FLAG_TIMESTAMP = (1 << 14), AST_OPT_FLAG_OVERRIDE_CONFIG = (1 << 15), AST_OPT_FLAG_RECONNECT = (1 << 16),
  AST_OPT_FLAG_TRANSMIT_SILENCE = (1 << 17), AST_OPT_FLAG_DONT_WARN = (1 << 18), AST_OPT_FLAG_END_CDR_BEFORE_H_EXTEN = (1 << 19), AST_OPT_FLAG_INTERNAL_TIMING = (1 << 20),
  AST_OPT_FLAG_ALWAYS_FORK = (1 << 21), AST_OPT_FLAG_MUTE = (1 << 22), AST_OPT_FLAG_DEBUG_MODULE = (1 << 23), AST_OPT_FLAG_VERBOSE_MODULE = (1 << 24),
  AST_OPT_FLAG_LIGHT_BACKGROUND = (1 << 25), AST_OPT_FLAG_INITIATED_SECONDS = (1 << 26), AST_OPT_FLAG_FORCE_BLACK_BACKGROUND = (1 << 27), AST_OPT_FLAG_HIDE_CONSOLE_CONNECT = (1 << 28),
  AST_OPT_FLAG_LOCK_CONFIG_DIR = (1 << 29), AST_OPT_FLAG_GENERIC_PLC = (1 << 30)
}

Variables

struct ast_flags ast_compat
int ast_language_is_prefix
struct timeval ast_lastreloadtime
pid_t ast_mainpid
struct ast_flags ast_options
struct timeval ast_startuptime
char dahdi_chan_name [AST_CHANNEL_NAME]
int dahdi_chan_name_len
char defaultlanguage []
int option_debug
int option_maxcalls
int option_maxfiles
double option_maxload
long option_minmemfree
int option_verbose
char record_cache_dir [AST_CACHE_DIR_LEN]

Detailed Description

Options provided by main asterisk program.

Definition in file options.h.

Define Documentation

#define AST_CACHE_DIR_LEN   512

Definition at line 32 of file options.h.

Referenced by ast_readconfig().

#define AST_CHANNEL_NAME   80

Max length of an ast_channel name

Definition at line 34 of file options.h.

#define ast_compat_app_set   ast_test_flag(&ast_compat, AST_COMPAT_APP_SET)

Definition at line 148 of file options.h.

Referenced by ast_compile_ael2(), gen_prios(), and pbx_builtin_setvar().

#define ast_compat_pbx_realtime   ast_test_flag(&ast_compat, AST_COMPAT_DELIM_PBX_REALTIME)

Definition at line 146 of file options.h.

Referenced by realtime_exec().

#define ast_compat_res_agi   ast_test_flag(&ast_compat, AST_COMPAT_DELIM_RES_AGI)

Definition at line 147 of file options.h.

Referenced by handle_exec().

#define AST_DEFAULT_OPTIONS   AST_OPT_FLAG_TRANSCODE_VIA_SLIN | AST_OPT_FLAG_INTERNAL_TIMING

These are the options that set by default when Asterisk starts

Definition at line 103 of file options.h.

#define AST_FILENAME_MAX   80

Definition at line 33 of file options.h.

#define ast_fully_booted   ast_test_flag(&ast_options, AST_OPT_FLAG_FULLY_BOOTED)

Definition at line 117 of file options.h.

Referenced by ast_module_reload(), ast_process_pending_reloads(), scan_thread(), and start_resource().

#define ast_opt_always_fork   ast_test_flag(&ast_options, AST_OPT_FLAG_ALWAYS_FORK)

Definition at line 128 of file options.h.

Referenced by main().

#define ast_opt_cache_record_files   ast_test_flag(&ast_options, AST_OPT_FLAG_CACHE_RECORD_FILES)

Definition at line 120 of file options.h.

Referenced by ast_writefile().

#define ast_opt_console   ast_test_flag(&ast_options, AST_OPT_FLAG_CONSOLE)

Definition at line 111 of file options.h.

Referenced by ast_term_init(), console_verboser(), main(), quit_handler(), and start_resource().

#define ast_opt_dbg_module   ast_test_flag(&ast_options, AST_OPT_FLAG_DEBUG_MODULE)

Definition at line 130 of file options.h.

#define ast_opt_dont_warn   ast_test_flag(&ast_options, AST_OPT_FLAG_DONT_WARN)

Definition at line 125 of file options.h.

Referenced by filter(), pbx_exec(), pbx_load_config(), and show_codecs().

#define ast_opt_dump_core   ast_test_flag(&ast_options, AST_OPT_FLAG_DUMP_CORE)

Definition at line 119 of file options.h.

Referenced by main().

#define ast_opt_end_cdr_before_h_exten   ast_test_flag(&ast_options, AST_OPT_FLAG_END_CDR_BEFORE_H_EXTEN)

Definition at line 126 of file options.h.

Referenced by __ast_pbx_run(), and ast_bridge_call().

#define ast_opt_exec   ast_test_flag(&ast_options, AST_OPT_FLAG_EXEC)

Definition at line 115 of file options.h.

Referenced by ast_el_read_char(), ast_remotecontrol(), main(), and quit_handler().

#define ast_opt_exec_includes   ast_test_flag(&ast_options, AST_OPT_FLAG_EXEC_INCLUDES)

Definition at line 108 of file options.h.

Referenced by process_text_line().

#define ast_opt_force_black_background   ast_test_flag(&ast_options, AST_OPT_FLAG_FORCE_BLACK_BACKGROUND)

Definition at line 133 of file options.h.

Referenced by ast_term_color_code(), ast_term_init(), term_color(), term_color_code(), and term_prompt().

#define ast_opt_generic_plc   ast_test_flag(&ast_options, AST_OPT_FLAG_GENERIC_PLC)

Definition at line 136 of file options.h.

Referenced by ast_channel_make_compatible_helper(), and ast_write().

#define ast_opt_hide_connect   ast_test_flag(&ast_options, AST_OPT_FLAG_HIDE_CONSOLE_CONNECT)

Definition at line 134 of file options.h.

Referenced by listener(), and netconsole().

#define ast_opt_high_priority   ast_test_flag(&ast_options, AST_OPT_FLAG_HIGH_PRIORITY)

Definition at line 112 of file options.h.

Referenced by app_exec(), ast_safe_system(), icesencode(), main(), mp3play(), NBScatplay(), send_waveform_to_fd(), spawn_mp3(), and spawn_ras().

#define ast_opt_init_keys   ast_test_flag(&ast_options, AST_OPT_FLAG_INIT_KEYS)

Definition at line 113 of file options.h.

Referenced by load_module(), and try_load_key().

#define ast_opt_internal_timing   ast_test_flag(&ast_options, AST_OPT_FLAG_INTERNAL_TIMING)

Definition at line 127 of file options.h.

Referenced by ast_internal_timing_enabled().

#define ast_opt_light_background   ast_test_flag(&ast_options, AST_OPT_FLAG_LIGHT_BACKGROUND)

Definition at line 132 of file options.h.

Referenced by ast_term_init(), check_fgcolor(), term_color(), and term_prompt().

#define ast_opt_lock_confdir   ast_test_flag(&ast_options, AST_OPT_FLAG_LOCK_CONFIG_DIR)

Definition at line 135 of file options.h.

Referenced by ast_module_reload().

#define ast_opt_mute   ast_test_flag(&ast_options, AST_OPT_FLAG_MUTE)

Definition at line 129 of file options.h.

Referenced by ast_el_read_char(), and ast_remotecontrol().

#define ast_opt_no_color   ast_test_flag(&ast_options, AST_OPT_FLAG_NO_COLOR)

Definition at line 116 of file options.h.

Referenced by ast_term_init().

#define ast_opt_no_fork   ast_test_flag(&ast_options, AST_OPT_FLAG_NO_FORK)

Definition at line 109 of file options.h.

Referenced by main().

#define ast_opt_override_config   ast_test_flag(&ast_options, AST_OPT_FLAG_OVERRIDE_CONFIG)

Definition at line 122 of file options.h.

Referenced by ast_readconfig().

#define ast_opt_quiet   ast_test_flag(&ast_options, AST_OPT_FLAG_QUIET)

Definition at line 110 of file options.h.

Referenced by load_modules().

#define ast_opt_reconnect   ast_test_flag(&ast_options, AST_OPT_FLAG_RECONNECT)

Definition at line 123 of file options.h.

Referenced by ast_el_read_char().

#define ast_opt_remote   ast_test_flag(&ast_options, AST_OPT_FLAG_REMOTE)

Definition at line 114 of file options.h.

Referenced by cli_complete(), cli_prompt(), main(), and quit_handler().

#define ast_opt_timestamp   ast_test_flag(&ast_options, AST_OPT_FLAG_TIMESTAMP)

Definition at line 121 of file options.h.

Referenced by __ast_verbose_ap().

#define ast_opt_transcode_via_slin   ast_test_flag(&ast_options, AST_OPT_FLAG_TRANSCODE_VIA_SLIN)

Definition at line 118 of file options.h.

Referenced by ast_channel_make_compatible_helper().

#define ast_opt_transmit_silence   ast_test_flag(&ast_options, AST_OPT_FLAG_TRANSMIT_SILENCE)

Definition at line 124 of file options.h.

Referenced by __ast_play_and_record(), ast_bridge_call(), ast_dtmf_stream(), ast_readstring_full(), ast_safe_sleep_conditional(), record_exec(), waitfor_exec(), and waitforring_exec().

#define ast_opt_verb_module   ast_test_flag(&ast_options, AST_OPT_FLAG_VERBOSE_MODULE)

Definition at line 131 of file options.h.

Enumeration Type Documentation

enum ast_compat_flags
Enumerator:
AST_COMPAT_DELIM_PBX_REALTIME 
AST_COMPAT_DELIM_RES_AGI 
AST_COMPAT_APP_SET 

Definition at line 140 of file options.h.

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

Variable Documentation

int ast_language_is_prefix

Definition at line 59 of file file.c.

Referenced by ast_readconfig(), handle_show_settings(), and main().

struct timeval ast_lastreloadtime

Definition at line 214 of file asterisk.c.

Referenced by action_corestatus(), ast_module_reload(), ast_var_Config(), handle_show_settings(), handle_showuptime(), and main().

pid_t ast_mainpid

Definition at line 195 of file asterisk.c.

Referenced by safe_append(), and scan_service().

struct timeval ast_startuptime

Definition at line 213 of file asterisk.c.

Referenced by action_corestatus(), ast_var_Config(), handle_show_settings(), handle_showcalls(), handle_showuptime(), and main().

char dahdi_chan_name[AST_CHANNEL_NAME]
int dahdi_chan_name_len
char defaultlanguage[]

Definition at line 222 of file asterisk.c.

Referenced by __ast_channel_alloc_ap(), ast_readconfig(), and handle_show_settings().

char record_cache_dir[AST_CACHE_DIR_LEN]

Definition at line 191 of file asterisk.c.

Referenced by ast_writefile().