Thu Jun 7 02:15:01 2012

Asterisk developer's documentation


Main Configuration Options

Main configuration options from asterisk.conf or the operating system command line when starting Asterisk Some of them can be changed in the CLI. More...

Enumerations

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_PRIORITY_JUMPING = (1 << 11),
  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_GENERIC_PLC = (1 << 23),
  AST_OPT_FLAG_SEND_FULLYBOOTED = (1 << 24)
}

Variables

struct ast_flags ast_options = { AST_DEFAULT_OPTIONS }
int option_debug
int option_maxcalls
int option_maxfiles = 0
double option_maxload
int option_verbose

Detailed Description

Main configuration options from asterisk.conf or the operating system command line when starting Asterisk Some of them can be changed in the CLI.


Enumeration Type Documentation

Enumerator:
AST_OPT_FLAG_EXEC_INCLUDES 

Allow #exec in config files

AST_OPT_FLAG_NO_FORK 

Do not fork()

AST_OPT_FLAG_QUIET 

Keep quiet

AST_OPT_FLAG_CONSOLE 

Console mode

AST_OPT_FLAG_HIGH_PRIORITY 

Run in realtime Linux priority

AST_OPT_FLAG_INIT_KEYS 

Initialize keys for RSA authentication

AST_OPT_FLAG_REMOTE 

Remote console

AST_OPT_FLAG_EXEC 

Execute an asterisk CLI command upon startup

AST_OPT_FLAG_NO_COLOR 

Don't use termcap colors

AST_OPT_FLAG_FULLY_BOOTED 

Are we fully started yet?

AST_OPT_FLAG_TRANSCODE_VIA_SLIN 

Trascode via signed linear

AST_OPT_FLAG_PRIORITY_JUMPING 

Enable priority jumping in applications

AST_OPT_FLAG_DUMP_CORE 

Dump core on a seg fault

AST_OPT_FLAG_CACHE_RECORD_FILES 

Cache sound files

AST_OPT_FLAG_TIMESTAMP 

Display timestamp in CLI verbose output

AST_OPT_FLAG_OVERRIDE_CONFIG 

Override config

AST_OPT_FLAG_RECONNECT 

Reconnect

AST_OPT_FLAG_TRANSMIT_SILENCE 

Transmit Silence during Record() and DTMF Generation

AST_OPT_FLAG_DONT_WARN 

Suppress some warnings

AST_OPT_FLAG_END_CDR_BEFORE_H_EXTEN 

End CDRs before the 'h' extension

AST_OPT_FLAG_INTERNAL_TIMING 

Use DAHDI Timing for generators if available

AST_OPT_FLAG_ALWAYS_FORK 

Always fork, even if verbose or debug settings are non-zero

AST_OPT_FLAG_MUTE 

Disable log/verbose output to remote consoles

AST_OPT_FLAG_GENERIC_PLC 

Generic PLC

AST_OPT_FLAG_SEND_FULLYBOOTED 

Send the FullyBooted AMI event when all modules are loaded

Definition at line 37 of file options.h.

00037                       {
00038    /*! Allow \#exec in config files */
00039    AST_OPT_FLAG_EXEC_INCLUDES = (1 << 0),
00040    /*! Do not fork() */
00041    AST_OPT_FLAG_NO_FORK = (1 << 1),
00042    /*! Keep quiet */
00043    AST_OPT_FLAG_QUIET = (1 << 2),
00044    /*! Console mode */
00045    AST_OPT_FLAG_CONSOLE = (1 << 3),
00046    /*! Run in realtime Linux priority */
00047    AST_OPT_FLAG_HIGH_PRIORITY = (1 << 4),
00048    /*! Initialize keys for RSA authentication */
00049    AST_OPT_FLAG_INIT_KEYS = (1 << 5),
00050    /*! Remote console */
00051    AST_OPT_FLAG_REMOTE = (1 << 6),
00052    /*! Execute an asterisk CLI command upon startup */
00053    AST_OPT_FLAG_EXEC = (1 << 7),
00054    /*! Don't use termcap colors */
00055    AST_OPT_FLAG_NO_COLOR = (1 << 8),
00056    /*! Are we fully started yet? */
00057    AST_OPT_FLAG_FULLY_BOOTED = (1 << 9),
00058    /*! Trascode via signed linear */
00059    AST_OPT_FLAG_TRANSCODE_VIA_SLIN = (1 << 10),
00060    /*! Enable priority jumping in applications */
00061    AST_OPT_FLAG_PRIORITY_JUMPING = (1 << 11),
00062    /*! Dump core on a seg fault */
00063    AST_OPT_FLAG_DUMP_CORE = (1 << 12),
00064    /*! Cache sound files */
00065    AST_OPT_FLAG_CACHE_RECORD_FILES = (1 << 13),
00066    /*! Display timestamp in CLI verbose output */
00067    AST_OPT_FLAG_TIMESTAMP = (1 << 14),
00068    /*! Override config */
00069    AST_OPT_FLAG_OVERRIDE_CONFIG = (1 << 15),
00070    /*! Reconnect */
00071    AST_OPT_FLAG_RECONNECT = (1 << 16),
00072    /*! Transmit Silence during Record() and DTMF Generation */
00073    AST_OPT_FLAG_TRANSMIT_SILENCE = (1 << 17),
00074    /*! Suppress some warnings */
00075    AST_OPT_FLAG_DONT_WARN = (1 << 18),
00076    /*! End CDRs before the 'h' extension */
00077    AST_OPT_FLAG_END_CDR_BEFORE_H_EXTEN = (1 << 19),
00078    /*! Use DAHDI Timing for generators if available */
00079    AST_OPT_FLAG_INTERNAL_TIMING = (1 << 20),
00080    /*! Always fork, even if verbose or debug settings are non-zero */
00081    AST_OPT_FLAG_ALWAYS_FORK = (1 << 21),
00082    /*! Disable log/verbose output to remote consoles */
00083    AST_OPT_FLAG_MUTE = (1 << 22),
00084    /*! Generic PLC */
00085    AST_OPT_FLAG_GENERIC_PLC = (1 << 23),
00086    /*! Send the FullyBooted AMI event when all modules are loaded */
00087    AST_OPT_FLAG_SEND_FULLYBOOTED = (1 << 24),
00088 };


Variable Documentation

struct ast_flags ast_options = { AST_DEFAULT_OPTIONS }

Debug level

Definition at line 164 of file asterisk.c.

Referenced by __ast_context_create(), __ast_context_destroy(), __ast_pbx_run(), __ast_play_and_record(), __ast_read(), __dahdi_exception(), __expire_registry(), __find_callno(), __login_exec(), __schedule_action(), __send_ping(), __sip_ack(), __sip_autodestruct(), __sip_destroy(), __sip_reliable_xmit(), __sip_semi_ack(), _macro_exec(), action_waitevent(), add_realm_authentication(), add_sdp(), add_to_interfaces(), adsi_load_vmail(), agent_bridgedchannel(), agent_call(), agent_cont_sleep(), agent_hangup(), agent_request(), aji_act_hook(), aji_handle_presence(), aji_log_hook(), aji_recv_loop(), alloc_sub(), app_exec(), array(), ast_add_extension2(), ast_add_hint(), ast_append_ha(), ast_apply_ha(), ast_audiohook_write_frame(), ast_bridge_call(), ast_carefulwrite(), ast_cdr_detach(), ast_cdr_submit_batch(), ast_channel_bridge(), ast_channel_free(), ast_channel_inherit_variables(), ast_channel_masquerade(), ast_channel_register(), ast_channel_start_silence_generator(), ast_channel_stop_silence_generator(), ast_channel_unregister(), ast_codec_choose(), ast_control_streamfile(), ast_db_del(), ast_db_get(), ast_device_state(), ast_device_state_changed_literal(), ast_do_masquerade(), ast_dsp_busydetect(), ast_generic_bridge(), ast_get_txt(), ast_hangup(), ast_indicate_data(), ast_ivr_menu_run_internal(), ast_lock_path(), ast_log(), ast_merge_contexts_and_delete(), ast_moh_files_next(), ast_monitor_change_fname(), ast_parse_allow_disallow(), ast_pickup_call(), ast_prod(), ast_read_generator_actions(), ast_rtcp_new(), ast_rtcp_read(), ast_rtp_bridge(), ast_rtp_change_source(), ast_rtp_codec_setpref(), ast_rtp_early_bridge(), ast_rtp_make_compatible(), ast_rtp_new_source(), ast_rtp_new_with_bindaddr(), ast_rtp_raw_write(), ast_rtp_read(), ast_rtp_senddigit_end_with_duration(), ast_rtp_write(), ast_sched_add_variable(), ast_sched_del(), ast_senddigit_begin(), ast_settimeout(), ast_sip_ouraddrfor(), ast_softhangup_nolock(), ast_unlock_path(), ast_write(), asyncgoto_exec(), attempt_transfer(), audiohook_inheritance_fixup(), audiohook_read_frame_both(), bridge_native_loop(), bridge_p2p_loop(), bridge_p2p_rtp_write(), build_peer(), build_reply_digest(), build_route(), builtin_atxfer(), cache_get_callno_locked(), calc_metric(), calc_rxstamp(), calc_timestamp(), callerid_feed_jp(), calltoken_required(), channel_find_locked(), check_availability(), check_beep(), check_key(), check_pendings(), check_provisioning(), check_srcaddr(), clear_dialed_interfaces(), close_mailbox(), conf_run(), config_text_file_load(), config_text_file_save(), create_addr_from_peer(), create_dtmf_frame(), create_followme_number(), dahdi_disable_ec(), dahdi_enable_ec(), dahdi_handle_dtmf(), dahdi_handle_event(), dahdi_hangup(), dahdi_request(), dahdi_restart(), dahdi_sendtext(), dahdi_setoption(), dahdi_softhangup_all(), dahdi_translate(), dahdi_write(), decode_frame(), decode_length(), do_cdr(), do_monitor(), do_parking_thread(), do_proxy_auth(), do_setnat(), do_state_change(), dump_agents(), encrypt_frame(), feature_interpret(), feature_interpret_helper(), find_call(), find_subchannel_and_lock(), find_tpeer(), findmeexec(), func_inheritance_write(), g726_open(), generator_force(), get_also_info(), get_destination(), get_refer_info(), get_sip_pvt_byid_locked(), getproviderstate(), gtalk_alloc(), gtalk_answer(), gtalk_parser(), gtalk_rtp_read(), gtalk_update_stun(), handle_debuglevel_deprecated(), handle_invite_replaces(), handle_nodebug(), handle_request(), handle_request_bye(), handle_request_cancel(), handle_request_invite(), handle_request_notify(), handle_request_refer(), handle_request_subscribe(), handle_response(), handle_response_invite(), handle_response_refer(), handle_response_register(), handle_set_debug(), handle_set_debug_deprecated(), handle_statechange(), hangup_cause2sip(), iax2_answer(), iax2_destroy(), iax2_devicestate(), iax2_do_register(), iax2_hangup(), iax2_indicate(), iax2_provision(), iax2_transfer(), iax2_trunk_queue(), iax2_write(), iax_provision_version(), icesencode(), initialize_initreq(), is_our_turn(), isAnsweringMachine(), join_queue(), last_message_index(), launch_netscript(), leave_queue(), leave_voicemail(), load_config(), load_module(), local_attended_transfer(), local_devicestate(), local_write(), make_email_file(), make_trunk(), metermaidstate(), mgcp_answer(), mgcp_hangup(), mgcp_ss(), moh_class_destructor(), monmp3thread(), my_dahdi_write(), nbs_call(), nbs_hangup(), network_thread(), notify_metermaids(), parse_cookies(), parse_moved_contact(), parse_naptr(), parse_request(), parse_sip_options(), pbx_builtin_gotoif(), pbx_extension_helper(), pbx_substitute_variables_helper_full(), peer_set_srcaddr(), peercnt_add(), peercnt_modify(), peercnt_remove(), pgsql_log(), phone_answer(), phone_call(), phone_check_exception(), phone_exception(), phone_hangup(), pickup_do(), play_greeting(), play_message_callerid(), play_message_duration(), prep_email_sub_vars(), pri_dchannel(), process_cisco_dtmf(), process_clearcache(), process_message(), process_my_load_module(), process_request_queue(), process_rfc2833(), process_sdp(), process_sdp_a_audio(), process_sdp_a_image(), queue_exec(), radius_log(), raw_hangup(), realtime_peer(), rebuild_matrix(), reg_source_db(), regex(), register_request(), reload_agents(), reload_config(), reload_followme(), reload_queue_members(), remove_from_interfaces(), restore_conference(), retrans_pkt(), ring_entry(), ring_one(), run_externnotify(), save_conference(), save_to_folder(), sched_delay_remove(), sched_thread(), schedule_delivery(), scheduled_destroy(), send_packet(), send_trunk(), sendmail(), sendpage(), set_actual_txgain(), set_format(), set_peercnt_limit(), set_peercnt_limit_all_cb(), setup_inheritable_audiohook(), sip_alloc(), sip_alreadygone(), sip_answer(), sip_call(), sip_destroy(), sip_destroy_peer(), sip_destroy_user(), sip_devicestate(), sip_do_reload(), sip_dump_history(), sip_fixup(), sip_handle_t38_reinvite(), sip_hangup(), sip_new(), sip_notify(), sip_park(), sip_park_thread(), sip_read(), sip_registry_destroy(), sip_request_call(), sip_rtp_read(), sip_set_rtp_peer(), sip_set_udptl_peer(), sipsock_read(), socket_process(), socket_read(), ss_thread(), store_next(), stun_handle_packet(), t38_get_rate(), testclient_exec(), testserver_exec(), timing_read(), transmit_invite(), transmit_refer(), transmit_register(), transmit_response_with_sdp(), transmit_trunk(), try_calling(), try_load_key(), udptl_build_packet(), unload_module(), unwrap_timestamp(), update_call_counter(), update_conf(), update_max_nontrunk(), update_max_trunk(), update_realtime_members(), vm_authenticate(), vm_change_password(), vm_execmain(), vm_newuser(), vm_options(), wait_for_answer(), and wait_for_winner().

Max number of active calls

Definition at line 167 of file asterisk.c.

Referenced by action_coresettings(), handle_chanlist(), handle_chanlist_deprecated(), and increase_call_count().

int option_maxfiles = 0

Max number of open file handles (files, sockets)

Definition at line 168 of file asterisk.c.

Referenced by action_coresettings().

Max load avg on system

Definition at line 166 of file asterisk.c.

Referenced by action_coresettings(), and increase_call_count().

Verbosity level

Definition at line 163 of file asterisk.c.

Referenced by __ast_context_create(), __ast_format_register(), __ast_pbx_run(), __ast_play_and_record(), __ast_register_translator(), __dahdi_exception(), __login_exec(), _macro_exec(), _while_exec(), accept_thread(), acf_odbc_read(), action_agent_callback_login(), add_realm_authentication(), adsi_exec(), adsi_prog(), advanced_options(), agent_call(), agent_read(), agentmonitoroutgoing_exec(), aji_handle_presence(), aji_handle_subscribe(), aji_recv_loop(), alarmreceiver_exec(), append_mapping(), ast_add_extension2(), ast_aji_disconnect(), ast_app_has_voicemail(), ast_app_inboxcount(), ast_app_messagecount(), ast_bridge_call(), ast_cdr_free(), ast_cdr_unregister(), ast_channel_bridge(), ast_channel_register(), ast_channel_unregister(), ast_context_add_include2(), ast_context_add_switch2(), ast_custom_function_register(), ast_custom_function_unregister(), ast_dnsmgr_lookup(), ast_dnsmgr_release(), ast_format_unregister(), ast_get_srv(), ast_image_register(), ast_image_unregister(), ast_jb_destroy(), ast_log(), ast_manager_register_struct(), ast_manager_unregister(), ast_module_reload(), ast_moh_destroy(), ast_moh_start(), ast_netsock_bindaddr(), ast_pbx_outgoing_app(), ast_pbx_outgoing_exten(), ast_pbx_run_app(), ast_register_application(), ast_register_feature(), ast_register_indication_country(), ast_rtp_bridge(), ast_rtp_reload(), ast_set_indication_country(), ast_speech_register(), ast_speech_unregister(), ast_streamfile(), ast_udptl_reload(), ast_unregister_application(), ast_unregister_indication_country(), ast_unregister_translator(), async_wait(), attempt_reconnect(), attempt_thread(), attempt_transfer(), begin_dial(), build_channels(), build_conf(), build_device(), build_query(), builtin_automonitor(), builtin_blindtransfer(), builtin_disconnect(), calc_energy(), channel_spy(), check_for_conference(), config_odbc_prepare(), config_text_file_load(), config_text_file_save(), cpeid_exec(), create_jb(), dahdi_bridge(), dahdi_call(), dahdi_handle_dtmf(), dahdi_handle_event(), dahdi_hangup(), dahdi_read(), dahdi_restart(), dahdi_write_frame(), database_increment(), del_exec(), deltree_exec(), destroy_all_channels(), dialout(), dnsmgr_refresh(), do_idle_thread(), do_monitor(), do_parking_thread(), do_waiting(), dumpchan_exec(), exec(), exit_now(), feature_request_and_dial(), find_subchannel_and_lock(), find_transcoders(), findmeexec(), flash_exec(), generic_http_callback(), handle_command_response(), handle_exec(), handle_frame(), handle_frame_ownerless(), handle_getoption(), handle_register_message(), handle_request(), handle_response(), handle_set_verbose_deprecated(), handle_soft_key_event_message(), handle_stimulus_message(), handle_streamfile(), handle_verbose(), iax2_ack_registry(), iax2_bridge(), iax2_exec(), iax2_hangup(), iax2_prov_app(), iax_provision_reload(), init_files_class(), init_logger(), init_manager(), isAnsweringMachine(), launch_script(), leave_voicemail(), load_config(), load_module(), load_modules(), load_pbx(), load_resource(), load_rpt_vars(), lookupblacklist_exec(), lookupcidname_exec(), mgcp_answer(), mgcp_hangup(), mgcp_new(), mgcp_request(), mgcp_ss(), misdn_bridge(), mixmonitor_ds_close_fs(), mixmonitor_thread(), moh_alloc(), moh_files_alloc(), moh_files_release(), moh_release(), notify_extenstate_update(), odbc_do_query(), odbc_init(), odbc_load_module(), odbc_log(), odbc_unload_module(), oh323_call(), park_call_full(), park_exec(), parkandannounce_exec(), parse_config(), parse_register_contact(), pbx_builtin_goto(), pbx_builtin_pushvar_helper(), pbx_builtin_setvar_helper(), pbx_builtin_waitexten(), pbx_extension_helper(), phone_hangup(), play_message_callerid(), play_record_review(), post_cdr(), pri_dchannel(), pri_fixup_principle(), privacy_exec(), process_ast_dsp(), process_dahdi(), process_message(), queue_exec(), random_exec(), read_exec(), realtime_exec(), receive_ademco_contact_id(), receive_dtmf_digits(), refresh_list(), reg_source_db(), reload_config(), reload_firmware(), reload_logger(), ring_entry(), rna(), rpt(), rpt_exec(), run_agi(), run_ras(), say_periodic_announcement(), say_position(), send_cwcidspill(), send_tone_burst(), session_do(), set_config(), setformat(), settransfercapability_exec(), setup_dahdi(), skinny_request(), skinny_reset_device(), skinny_session(), skinny_ss(), smdi_load(), sms_debug(), socket_process(), ss_thread(), start_network_thread(), store_config(), timeout_write(), try_load_key(), unload_module(), update_registry(), verbose_exec(), vm_authenticate(), vm_execmain(), wait_for_answer(), wait_for_winner(), waitforring_exec(), and waitforsilence_exec().


Generated on 7 Jun 2012 for Asterisk - the Open Source PBX by  doxygen 1.6.1