Asterisk.org: Developer Documentation (28 Oct 2009)

Wed Oct 28 15:49:24 2009

## Asterisk developer's documentation

# Data Structures

Here are the data structures with brief descriptions:

__priv_data |
_dundi_eid | A DUNDi Entity ID is essentially a MAC address, brief and unique
activate_call_plane_message |
addr_range |
adpcm_decoder_pvt |
adpcm_encoder_pvt |
adpcm_state |
adsi_display |
adsi_event |
adsi_flag |
adsi_key_cmd |
adsi_script |
adsi_soft_key |
adsi_state |
adsi_subscript |
aes_decrypt_ctx |
aes_encrypt_ctx |
agent_pvt |
agi_command |
agi_state |
alaw_decoder_pvt | Private workspace for translating alaw signals to signed linear
alaw_encoder_pvt | Private workspace for translating signed linear signals to alaw
allowed_bearers |
ao2_container |
ao2_iterator |
app_tmp |
asent |
ast_alias_list |
ast_app | Ast_app: A registered application
ast_app_option | A structure to hold the description of an application 'option'
ast_atexit |
ast_bridge_config |
ast_bridge_thread_obj |
ast_call_feature | Main call feature structure
ast_callerid |
ast_category |
ast_cause |
ast_cdr |
ast_cdr_batch |
ast_cdr_batch_item |
ast_cdr_beitem |
ast_channel |
ast_channel_monitor |
ast_channel_spy |
ast_channel_spy_list |
ast_channel_spy_queue |
ast_channel_tech |
ast_cli_entry | A command line entry
ast_codec_alias_table |
ast_codec_pref |
ast_comment |
ast_conf_user |
ast_conference |
ast_config |
ast_config_engine |
ast_config_map |
ast_context | Ast_context: An extension context
ast_custom_function |
ast_db_entry |
ast_dnsmgr_entry |
ast_dsp |
ast_exten | Ast_exten: An extension The dialplan is saved as a linked list with each context having it's own linked list of extensions - one item per priority
ast_filestream |
ast_firmware_list |
ast_flags |
ast_format |
ast_format_list |
ast_frame | Data structure associated with a single frame of data
ast_frame_delivery |
ast_generator |
ast_group_info |
ast_ha |
ast_hint | Structure for dial plan hints
ast_hostent |
ast_iax2_firmware_header |
ast_iax2_full_enc_hdr |
ast_iax2_full_hdr |
ast_iax2_meta_hdr |
ast_iax2_meta_trunk_entry |
ast_iax2_meta_trunk_hdr |
ast_iax2_meta_trunk_mini |
ast_iax2_mini_enc_hdr |
ast_iax2_mini_hdr |
ast_iax2_queue |
ast_iax2_video_hdr |
ast_ignorepat | Ast_ignorepat: Ignore patterns in dial plan
ast_imager | Structure associated with registering an image format
ast_include | Ast_include: include= support in extensions.conf
ast_ivr_menu |
ast_ivr_option |
ast_key |
ast_modem_driver |
ast_modem_pvt |
ast_netsock |
ast_netsock_list |
ast_option_header |
ast_osp_result |
ast_pbx |
ast_peer_list | The peer list: Peers and Friends ---
ast_PGSQL_id |
ast_realloca |
ast_register_list | The register list: Other SIP proxys we register with and call ---
ast_rtcp | Structure defining an RTCP session
ast_rtp |
ast_rtp_protocol |
ast_silence_generator |
ast_slinfactory |
ast_smoother |
ast_state_cb | Ast_state_cb: An extension state notify register item
ast_sw | Ast_sw: Switch statement in extensions.conf
ast_switch |
ast_timing |
ast_trans_pvt |
ast_translator |
ast_translator_dir |
ast_translator_pvt |
ast_user_list | The user list: Users and friends ---
ast_var_t |
ast_variable |
ast_vm_user |
astobj2 |
async_stat |
baseio |
bucket_list |
button_defs |
button_template_res_message |
buttondefinition |
call_info_message |
call_queue |
call_state_message |
callerid_state |
callno_entry |
calloutdata |
capabilities_res_message |
cfalias | Structure for conversion between compressed SIP and "normal" SIP
cfextension_states |
cfsip_methods |
cfsip_options | List of well-known SIP options. If we get this in a require, we should check the list and answer accordingly
cfsubscription_types |
chan_alsa_pvt |
chan_iax2_pvt |
chan_list |
chan_oss_pvt |
chanlist |
channel |
channel_spy_trans |
chanspy_translation_helper |
close_recieve_channel_message |
console |
create_addr_info |
definetimedate_message |
devstate_cb |
dialled_number_message |
dialplan_counters |
display_notify_message |
display_prompt_status_message |
displaytext_message |
distRingData |
dl_info |
dlstatus |
dlthread |
dn_answer |
dns_HEADER |
domain |
dpreq_data |
dtmf_detect_state_t |
dundi_answer |
dundi_cause |
dundi_encblock |
dundi_entity_info |
dundi_hdr |
dundi_hint |
dundi_hint_metadata |
dundi_ie |
dundi_ie_data |
dundi_ie_hdr |
dundi_ies |
dundi_mapping |
dundi_packet |
dundi_peer |
dundi_peer_status |
dundi_precache_queue |
dundi_query_state |
dundi_request |
dundi_result |
dundi_transaction |
enum_context |
enum_naptr_rr |
enum_search |
event_node |
eventqent |
fast_originate_helper |
feature_pvt |
feature_sub |
file_version |
fillin |
format_map |
fsk_data |
function_table_tag |
g723_decoder_pvt |
g723_encoder_pvt |
g726_decoder_pvt |
g726_encoder_pvt |
g726_state |
gen_state |
goertzel_state_t |
hold_info |
iax2_context |
iax2_dpcache |
iax2_ie |
iax2_peer |
iax2_registry |
iax2_trunk_peer |
iax2_user |
iax_dual |
iax_firmware |
iax_flag |
iax_frame |
iax_ie_data |
iax_ies |
iax_rr |
iax_template |
io_context |
io_rec |
jb_conf |
jb_frame |
jb_info |
jitterbuf |
KAsteriskConsole |
keypad_button_message |
leave_vm_options |
line_stat_res_message |
line_state_req_message |
linear_state |
loadupdate |
local_pvt |
localuser | We define a custom "local user" structure because we use it not only for keeping track of what is in use but also for keeping track of who we're dialing
logchannel |
lsinfo | Leap second information
manager_action |
mansession |
MD5Context |
media_qualifier |
member |
member_interface |
MemoryStruct |
message |
mf_detect_state_t |
mgcp_endpoint |
mgcp_gateway |
mgcp_message |
mgcp_request |
mgcp_response |
mgcp_subchannel |
misdn_cfg_pt |
misdn_cfg_spec |
misdn_jb |
mixmonitor |
module |
moh_files_state |
mohclass |
mohdata |
morse_bits |
msglist |
msn_list |
my_ifreq |
naptr |
nbs_pvt |
odbc_list |
odbc_obj |
odmiana |
oh323_pvt |
open_recieve_channel_ack_message |
open_recieve_channel_message |
osp_provider |
outgoing |
outgoing_helper |
parkeduser |
parse_io |
parsed_dial_string |
pbx_builtin | Declaration of builtin applications
peercnt |
permalias |
permission |
phone_pvt |
playlist_entry |
playtones_def |
playtones_item |
playtones_state |
plc_state_t |
pollfd |
progalias |
progress |
queue_ent |
refresh_info |
register_ack_message |
register_message |
register_rej_message |
ringContextData |
robin_list |
rpt |
rpt_link |
rpt_tele |
rtpPayloadType |
rule |
sched |
sched_context |
select_soft_keys_message |
server_identifier |
server_res_message |
set_lamp_message |
set_ringer_message |
set_speaker_message |
SHA1Context |
sip_auth | Sip_auth: Creadentials for authentication to other SIP services
sip_dual |
sip_history | Sip_history: Structure for saving transactions within a SIP dialog
sip_invite_param | Parameters to the transmit_invite function
sip_peer |
sip_pkt | Sip packet - read in sipsock_read, transmitted in send_request
sip_pvt | Sip_pvt: PVT structures are used for each SIP conversation, ie. a call
sip_registry | Sip_registry: Registrations with other SIP proxies
sip_request | Sip_request: The data grabbed from the UDP socket
sip_route |
sip_user | Structure for SIP user data. User's place calls to us
skinny_device |
skinny_line |
skinny_paging_device |
skinny_req |
skinny_subchannel |
skinnysession |
sms_s |
soft_key_set_definition |
soft_key_sets |
soft_key_template |
soft_key_template_definition |
sortable_keys |
sound |
speed_dial_stat_req_message |
speed_dial_stat_res_message |
srv |
srv_context |
start_media_transmission_message |
start_tone_message |
state |
state_change |
state_struct |
statechange |
station_capabilities |
stimulus_message |
stop_media_transmission_message |
store_hint |
strategy |
stringlink |
subchannel |
tdd_state |
telem_defaults |
tone_zone |
tone_zone_sound |
tonepair_def |
tonepair_state |
translator |
ttinfo |
tzhead |
ulaw_decoder_pvt |
ulaw_encoder_pvt |
val |
verb |
version_res_message |
vm_state |
vm_zone |
vofr_hdr |
volume |
vpb_bridge_t |
vpb_pvt |
yy_buffer_state |
yy_trans_info |
yyalloc |
yyguts_t |
yyltype |
YYLTYPE |
YYSTYPE |
zt_chan_conf | Channel configuration from zapata.conf . This struct is used for parsing the [channels] section of zapata.conf. Generally there is a field here for every possible configuration item
zt_distRings |
zt_pri_conf | The PRI part of the channel configuration. Separated as it is is applied to the span rather than to the channel
zt_pvt |
zt_subchannel |