Thu Oct 11 06:44:30 2012

Asterisk developer's documentation


Data Structures

Here are the data structures with brief descriptions:
__priv_data
_dundi_eidA DUNDi Entity ID is essentially a MAC address, brief and unique
acf_odbc_query
acf_root
activate_call_plane_message
active_list
addr_range
adpcm_decoder_pvtWorkspace for translating ADPCM signals to signed linear
adpcm_encoder_pvtWorkspace for translating signed linear signals to ADPCM
adpcm_state
adsi_display
adsi_event
adsi_flag
adsi_key_cmd
adsi_script
adsi_soft_key
adsi_state
adsi_subscript
ael_extension
ael_priority
aes_decrypt_ctx
aes_encrypt_ctx
agent_pvtStructure representing an agent
agents
agi_command
agi_state
aji_buddy
aji_buddy_container
aji_capabilities
aji_client
aji_client::messages
aji_client_container
aji_message
aji_resource
aji_transport_container
aji_version
alarm_message
allowed_bearers
alltrans
announce_listitem
answer_exec_struct
ao2_container
ao2_iterator
app_tmp
apps
argapp
asent
aslist
ast_alias_list
ast_appAst_app: A registered application
ast_app_optionA structure to hold the description of an application 'option'
ast_atexit
ast_audiohook
ast_audiohook_list
ast_audiohook_options
ast_audiohook_translate
ast_bridge_config
ast_bridge_thread_obj
ast_call_featureMain call feature structure
ast_calleridStructure for all kinds of caller ID identifications
ast_category
ast_category::template_instance_list
ast_category_template_instance
ast_cause
ast_cdr
ast_cdr_batch
ast_cdr_batch_item
ast_cdr_beitem
ast_chan_write_info_tStructure to handle passing func_channel_write info to channels via setoption
ast_channelMain Channel structure associated with a channel. This is the side of it mostly used by the pbx and call management
ast_channel::datastoresData stores on the channel
ast_channel_monitor
ast_channel_techStructure to describe a channel "technology", ie a channel driver See for examples:
ast_cli_entryA command line entry
ast_codec_alias_table
ast_codec_pref
ast_commentStructure to keep comments for rewriting configuration files
ast_conf_user
ast_conferenceThe MeetMe Conference object
ast_config
ast_config_engine
ast_config_map
ast_contextAst_context: An extension context
ast_custom_functionData structure associated with a custom dialplan function
ast_datastoreStructure for a channel data store
ast_datastore_infoStructure for a data store type
ast_db_entry
ast_devstate_aggregateYou shouldn't care about the contents of this struct
ast_dialMain dialing structure. Contains global options, channels being dialed, and more!
ast_dial_channelDialing channel structure. Contains per-channel dialing options, asterisk channel, and more!
ast_dial_features
ast_dialed_interface
ast_dnsmgr_entry
ast_dsp
ast_dynamic_strA dynamic length string
ast_extenAst_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_fdset
ast_filestream
ast_firmware_list
ast_flags
ast_format
ast_format_listDefinition of supported media formats (codecs)
ast_format_lock
ast_frameData structure associated with a single frame of data
ast_frame_cache
ast_framesThis is just so ast_frames, a list head struct for holding a list of ast_frame structures, is defined
ast_generator
ast_group_info
ast_ha
ast_hintStructure for dial plan hints
ast_hostent
ast_http_server_instance
ast_http_uri
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_ignorepatAst_ignorepat: Ignore patterns in dial plan
ast_imagerStructure associated with registering an image format
ast_includeAst_include: include= support in extensions.conf
ast_ivr_menu
ast_ivr_option
ast_jbGeneral jitterbuffer state
ast_jb_confGeneral jitterbuffer configuration
ast_jb_implJitterbuffer implementation private struct
ast_key
ast_manager_user
ast_module
ast_module_info
ast_module_user
ast_netsock
ast_netsock_list
ast_option_header
ast_option_typesOptions structure - maps options to respective handlers (enable/disable). This list MUST be perfectly kept in order, or else madness will happen
ast_pbx
ast_peer_listThe peer list: Peers and Friends
ast_realloca
ast_register_listThe register list: Other SIP proxys we register with and place calls to
ast_rtcpStructure defining an RTCP session
ast_rtpRTP session description
ast_rtp_protocol
ast_rtp_quality
ast_silence_generator
ast_slinfactory
ast_smdi_interface
ast_smdi_interface_containerSMDI interface container
ast_smdi_md_messageAn SMDI message desk message
ast_smdi_md_queueSMDI message desk message queue
ast_smdi_mwi_messageAn SMDI message waiting indicator message
ast_smdi_mwi_queueSMDI message waiting indicator message queue
ast_smoother
ast_speech
ast_speech_engine
ast_speech_result
ast_state_cbAst_state_cb: An extension state notify register item
ast_string_field_mgr
ast_string_field_pool
ast_swAst_sw: Switch statement in extensions.conf
ast_switch
ast_test_infoContains all the initialization information required to store a new test definition
ast_threadstorageData for a thread locally stored variable
ast_timing
ast_trans_pvtDefault structure for translators, with the basic fields and buffers, all allocated as part of the same chunk of memory. The buffer is preceded by AST_FRIENDLY_OFFSET bytes in front of the user portion. 'buf' points right after this space
ast_translatorDescriptor of a translator. Name, callbacks, and various options related to run-time operation (size of buffers, auxiliary descriptors, etc)
ast_udptl
ast_udptl_protocol
ast_user_listThe user list: Users and friends
ast_var_t
ast_variable
ast_vm_user
astobj2
async_stat
atexits
audiohook_inheritance_datastore
backends
baseio
be_list
bucket
bucket_list
button_definition
button_definition_template
button_template_res_message
c_referstatusstring
call_followmeData structure for followme scripts
call_followme::blnumbers
call_followme::numbers
call_followme::wlnumbers
call_info_message
call_queue
call_state_message
callattemptWe 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
callerid_state
callno_entry
capabilities_res_message
cfextension_states
cfsip_methods
cfsip_optionsList 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_iax2_pvt::signaling_queue
chan_listChannel call record structure
chan_oss_pvt
chanlist
channel_usage
channels
chanspy_ds
chanspy_translation_helper
clear_prompt_message
cli_iterator
close_receive_channel_message
codec_dahdi_pvt
config_odbc_obj
confs
console
create_addr_info
custom_prepare_struct
dahdi_chan_confChannel configuration from chan_dahdi.conf . This struct is used for parsing the [channels] section of chan_dahdi.conf. Generally there is a field here for every possible configuration item
dahdi_distRings
dahdi_pvt
dahdi_subchannel
definetimedate_message
devstate_cbA device state watcher (callback)
devstate_cbsA device state watcher list
devstate_provA device state provider (not a channel)
devstate_provsA list of providers
dial_localuser
dial_trunk_args
dialed_number_message
dialplan_counters
display_notify_message
display_prompt_status_message
displaytext_message
distRingData
dn_answer
dns_HEADER
domainDomain data structure
domain_list
dpreq_data
dscp_codepoint
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::permissionlist
dundi_peer_status
dundi_precache_queue
dundi_query_state
dundi_request
dundi_result
dundi_transaction
dundi_transaction::packetlist
dynamic_list
enbloc_call_message
engines
entry_list
enum_context
enum_naptr_rr
enum_search
event_node
eventqent
fast_originate_helper
feature_list
feature_pvt
feature_sub
features
file_version
file_versions
findme_user
findme_user_listptr
fixed_jbPrivate fixed_jb structure
fixed_jb_conf
fixed_jb_frame
fm_args
fm_args::cnumbers
followmes
format_map
formats
frame_list
fsk_data
function_table_tag
g726_coder_pvt
g726_desc
g726_state
gen_state
goertzel_state_t
groups
gsm_translator_pvt
gtalk
gtalk_candidate
gtalk_container
gtalk_pvt
h263_desc
h264_desc
helpers
hold_info
iax2_context
iax2_dpcache
iax2_ie
iax2_peer
iax2_pkt_buf
iax2_registry
iax2_thread
iax2_trunk_peer
iax2_user
iax_dual
iax_firmware
iax_flag
iax_frame
iax_frame_listThis is just so iax_frames, a list head struct for holding a list of iax_frame structures, is defined
iax_frames
iax_ie_data
iax_ies
iax_rr
iax_template
idle_list
ilbc_coder_pvt
imagers
inheritable_audiohook
inprocess
interfaces
io_context
io_rec
isdn_msg
ivr_localuser
ivr_localuser::finishlist
ivr_localuser::playlist
jb_conf
jb_frame
jb_info
jitterbuf
keypad_button_message
leave_vm_options
line_stat_res_message
line_state_req_message
linear_state
load_order
load_order_entry
loadupdate
local_pvt
logchannel
logchannels
lpc10_coder_pvt
lsinfoLeap second information
mailbox_mappingA mapping between an SMDI mailbox ID and an Asterisk mailbox
manager_action
mansession
mansession_session
mappings
MD5Context
media_qualifier
member
member_interface
MemoryStruct
message
mf_detect_state_t
mgcp_endpoint
mgcp_gateway
mgcp_messageMgcp_message: MGCP message for queuing up
mgcp_request
mgcp_response
mgcp_subchannel
misdn_bchannel
misdn_cfg_pt
misdn_cfg_spec
misdn_jb
misdn_lib
misdn_lib_iface
misdn_stack
mixmonitor
mixmonitor_ds
module_list
module_user_list
moh_files_state
mohclass
mohdata
morse_bits
msn_list
my_ifreq
naptr
nbs_pvt
nodelog
numberNumber structure
odbc_class
odbc_list
odbc_obj
odmiana
offered_media
offhook_message
oh323_pvt
onhook_message
open_receive_channel_ack_message
open_receive_channel_message
oprmode
osp_provider
osp_result
outgoing
outgoing_helper
parkeduser
parse_io
parsed_dial_string
pbx_builtinDeclaration of builtin applications
pbx_find_info
pcq
peercnt
peers
permalias
permission
phone_pvt
playlist_entry
playtones_def
playtones_item
playtones_state
plc_ds
plc_state_t
profile_data
profile_entry
progalias
progress
protosList of current sessions
provisional_keepalive_dataProvisional keep alive scheduler item data
pval
queries
queue_ent
queue_transfer_ds
queues
refresh_info
register_ack_message
register_message
register_rej_message
registrations
reload_classes
reload_queue
reload_queue_item
requests
reset_message
ringContextData
robin_list
rpt
rpt_chan_stat
rpt_link
rpt_lstat
rpt_tele
rpt_xlat
rtpPayloadTypeStructure representing a RTP session
rule
run_station_args
say_args_t
sched
sched_context
select_soft_keys_message
send_lock
server_identifier
server_res_message
sessions
set_lamp_message
set_microphone_message
set_ringer_message
set_speaker_message
SHA1Context
signaling_queue_entry
sip_authSip_auth: Credentials for authentication to other SIP services
sip_dualStructure used in transfers
sip_extenstate_update
sip_extenstate_updatesList of extension state updates for the dialog list
sip_historySip_history: Structure for saving transactions within a SIP dialog
sip_history_head
sip_invite_paramParameters to the transmit_invite function
sip_peerStructure for SIP peer data, we place calls to peers if registered or fixed IP address (host)
sip_pktSip packet - raw format for outbound packets that are sent or scheduled for transmission
sip_pvtSip_pvt: PVT structures are used for each SIP dialog, ie. a call, a registration, a subscribe
sip_pvt::request_queue
sip_referStructure to handle SIP transfers. Dynamically allocated when needed
sip_registryRegistrations with other SIP proxies
sip_requestSip_request: The data grabbed from the UDP socket
sip_routeStructure to save routing information for a SIP session
sip_userStructure for SIP user data. User's place calls to us
sip_viaStructure to store Via information
skinny_addon
skinny_data
skinny_device
skinny_line
skinny_paging_device
skinny_req
skinny_speeddial
skinny_subchannel
skinnysession
sla_event
sla_failed_stationA station that failed to be dialed
sla_ringing_stationA station that is ringing
sla_ringing_trunkA trunk that is ringing
sla_station
sla_station_ref
sla_stations
sla_trunk
sla_trunk_ref
sla_trunks
smdi_msg_datastore
sms_s
soft_key_definitions
soft_key_event_message
soft_key_set_definition
soft_key_set_res_message
soft_key_template_definition
soft_key_template_res_message
sortable_keys
sound
speed_dial_stat_req_message
speed_dial_stat_res_message
speex_coder_pvt
srv_context
srv_context::srv_entries
srv_entry
start_media_transmission_message
start_tone_message
state
state_change
state_changesThe state change queue. State changes are queued for processing by a separate thread
state_struct
statechange
station_capabilities
stimulus_message
stop_media_transmission_message
stop_tone_message
store_hint
store_hints
strategy
stun_addr
stun_attr
stun_header
stun_state
stun_trans_id
switches
sysstate
t38propertiesT.38 channel settings (at some point we need to make this alloc'ed
tdd_state
telem_defaults
thr_arg
thread_list
thread_list_t
tone_zone
tone_zone_sound
tonepair_def
tonepair_state
translator
translator_path
translatorsList of translators
ttinfoTime type information
tzhead
udptl_fec_rx_buffer_t
udptl_fec_tx_buffer_t
updaters
users
val
variable_count
varshead
verb
verbosers
version_res_message
vm_state
vm_zone
volume
vorbis_desc
wav_desc
wavg_desc
yy_buffer_state
yy_trans_info
yyalloc
yyguts_t
YYLTYPE
yyltype
YYSTYPE
zombie
zombies
zonelist
zones

Generated on Thu Oct 11 06:44:30 2012 for Asterisk - the Open Source PBX by  doxygen 1.5.6