Codename Pineapple

Home page | Mailing list | Docs

Last updated: Sat Feb 3 05:01:58 2007

Asterisk developer's documentation :: Codename Pineapple


Asterisk - the Open Source PBX :: Codename Pineapple Data Structures

Here are the data structures with brief descriptions:
__attribute__
_dundi_eidA DUNDi Entity ID is essentially a MAC address, brief and unique
activate_call_plane_message
ael_extension
ael_priority
aes_decrypt_ctx
aes_encrypt_ctx
agent_pvtStructure representing an agent
agi_command
agi_state
aji_buddy
aji_buddy_container
aji_capabilities
aji_client
aji_client_container
aji_message
aji_resource
aji_transport_container
aji_version
alarm_message
allowed_bearers
answer_exec_struct
app_tmp
argapp
asent
ast_alias_list
ast_appAst_app: A registered application
ast_app_optionA structure to hold the description of an application 'option'
ast_atexit
ast_bridge_configBridge configuration
ast_bridge_thread_obj
ast_call_featureMain call feature structure
ast_calleridStructure for all kinds of caller ID identifications
ast_category
ast_cause
ast_cdr
ast_cdr_batch
ast_cdr_batch_item
ast_cdr_beitem
ast_channelMain Channel structure associated with a channel. This is the side of it mostly used by the pbx and call management
ast_channel_monitor
ast_channel_spy
ast_channel_spy_list
ast_channel_spy_queue
ast_channel_techStructure to describe a channel "technology", ie a channel driver See for examples:
ast_channel_whisper_buffer
ast_cli_args
ast_cli_entryDescriptor for a cli entry See CLI_command_API
ast_codec_alias_table
ast_codec_pref
ast_comment
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_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_dnsmgr_entry
ast_dsp
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_filestream
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_generator
ast_ha
ast_hintStructure for dial plan hints
ast_hostent
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_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_userUser descriptor, as read from the config file
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 proxies we register with and place calls to
ast_rtcpStructure defining an RTCP session
ast_rtpRTP session description
ast_rtp_protocolThis is the structure that binds a channel (SIP/Jingle/H.323) to the RTP subsystem
ast_silence_generator
ast_slinfactory
ast_smdi_interfaceSMDI interface structure
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_strThe descriptor of a dynamic string XXX storage will be optimized later if needed We use the ts field to indicate the type of storage. Three special constants indicate malloc, alloca() or static variables, all other values indicate a struct ast_threadstorage pointer
ast_string_field_mgr
ast_string_field_pool
ast_swAst_sw: Switch statement in extensions.conf
ast_switch
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_udptlStructure for an UDPTL session
ast_udptl_protocol
ast_user_listThe user list: Users and friends
ast_var_t
ast_variable
async_stat
button_definition
button_definition_template
button_template_res_message
c_referstatusstringTable to convert from REFER status variable to string
call_info_message
call_state_message
callerid_state
capabilities_res_message
cfextension_states
cfsip_methodsStructure for parsing of SIP methods
cfsip_optionsList of well-known SIP options. If we get this in a require, we should check the list and answer accordingly
cfsubscription_typesDescription of SUBSCRIBE events
chan_alsa_pvt
chan_iax2_pvt
chan_list
chan_oss_pvtDescriptor for one of our channels
chanlist
channel_countersCounters for various objects
channel_spy_trans
cli_iterator
close_receive_channel_message
config_odbc_obj
console
create_addr_info
definetimedate_message
devstate_cbA device state watcher (callback)
devstate_provA device state provider (not a channel)
dialed_number_message
dialplan_countersCounters for the show dialplan manager command
display_notify_message
display_prompt_status_message
displaytext_message
distRingData
dl_info
dlstatus
dlthread
dn_answer
dns_HEADER
domainDomain data structure
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_status
dundi_precache_queue
dundi_query_state
dundi_request
dundi_result
dundi_transaction
enum_context
enum_naptr_rr
enum_search
eventqent
expiry_timesStructure for expiration times for inbound/outbound REGISTER
fast_originate_helper
feature_pvt
feature_sub
file_version
fixed_jbPrivate fixed_jb structure
fixed_jb_conf
fixed_jb_frame
fsk_data
goertzel_state_t
gtalk
gtalk_candidate
gtalk_container
gtalk_pvt
hold_info
http_uri_redirect
iax2_context
iax2_dpcache
iax2_ie
iax2_peer
iax2_registry
iax2_thread
iax2_trunk_peer
iax2_user
iax_dual
iax_firmware
iax_flag
iax_frame
iax_ie_data
iax_ies
iax_rr
iax_template
ind_tone_zone
ind_tone_zone_soundDescription is a series of tones of the format: [!]freq1[+freq2][/duration] separated by commas. There are no spaces. The sequence is repeated back to the first tone description not preceeded by !. Duration is specified in milliseconds
io_context
io_rec
jb_conf
jb_frame
jb_info
jingle
jingle_candidate
jingle_container
jingle_pvt
jitterbuf
KAsteriskConsole
keypad_button_message
limits
line_stat_res_message
line_state_req_message
linear_state
load_order_entry
loadupdate
local_pvt
logchannel
logmsg
manager_action
manager_custom_hook
mansession
MD5Context
media_qualifier
message
mf_detect_state_t
mgcp_endpoint
mgcp_gateway
mgcp_messageMgcp_message: MGCP message for queuing up
mgcp_request
mgcp_response
mgcp_subchannel
misdn_cfg_pt
misdn_cfg_spec
misdn_jb
moh_files_state
mohclass
mohdata
msn_list
my_ifreq
naptr
nbs_pvt
odbc_class
odbc_obj
odmiana
offhook_message
oh323_pvt
onhook_message
open_receive_channel_ack_message
open_receive_channel_message
oprmode
outgoing
outgoing_helper
parkeduser
parse_io
parsed_dial_string
pbx_builtinDeclaration of builtin applications
pbx_find_info
permalias
permission
phone_pvt
playtones_def
playtones_item
playtones_state
plc_state_t
pollfd
profile_data
profile_entry
progalias
progress
pval
refresh_info
register_ack_message
register_message
register_rej_message
reload_classes
reset_message
ringContextData
robin_list
rtpPayloadTypeStructure representing a RTP session.The value of each payload format mapping:
rtptimers
sched
sched_context
select_soft_keys_message
server_args
server_identifier
server_instance
server_res_message
set_lamp_message
set_microphone_message
set_ringer_message
set_speaker_message
SHA1Context
sip_authSip_auth: Credentials for authentication to other SIP services
sip_config_structSIP configuration definition structure
sip_deviceStructure for SIP peer data, we place calls to peers if registered or fixed IP address (host)
sip_device_extra
sip_device_listSIP devices (phones)
sip_dialogPVT structure are used for each SIP dialog, ie. a call, a registration, a subscribe
sip_dualStructure used in transfers
sip_globals
sip_historySip_history: Structure for saving transactions within a SIP dialog
sip_invite_paramParameters to the transmit_invite function
sip_mwi_mailbox
sip_networkNetwork interface settings
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_queue_item
sip_referStructure to handle SIP transfers. Dynamically allocated when needed
sip_register_listThe register list: Other SIP proxys we register with and place calls to
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_transInvite transaction state
sip_userStructure for SIP user data. User's place calls to us
skinny_addon
skinny_data
skinny_device
skinny_line
skinny_paging_device
skinny_req
skinny_speeddial
skinny_subchannel
skinnysession
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
sound
speed_dial_stat_req_message
speed_dial_stat_res_message
srv
srv_context
SSL
SSL_CTX
start_media_transmission_message
start_tone_message
state_change
state_struct
station_capabilities
stimulus_message
stop_media_transmission_message
store_hint
stun_addr
stun_attr
stun_header
stun_state
t38propertiesT.38 channel settings (at some point we need to make this alloc'ed
tdd_state
thr_arg
thread_list_t
tls_config
tonepair_def
tonepair_state
translator_path
udptl_fec_rx_buffer_t
udptl_fec_tx_buffer_t
val
verb
version_res_message
yy_buffer_state
yy_trans_info
yyalloc
yyguts_t
yyltype
YYLTYPE
YYSTYPE
zt_chan_confChannel 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_pvt
zt_subchannel

Asterisk is a trademark for Digium, inc.. | Edvina.net | Asterisk.org | This documentation was generated with Doxygen