Data Structures

Here are the data structures with brief descriptions:
_bdb_cmdExtension structure of db_cmd adding BDB specific data
_bdb_conA structure representing a connection to a BDB
_cfg_add_varStructure for storing additional values of a variable
_cfg_blockSingle memoy block that contains all the cfg values
_cfg_changed_varLinked list of variables with their new values
_cfg_child_cbLinked list of per-child process callbacks
_cfg_ctxLinked list of registered contexts
_cfg_groupLinked list of registered groups
_cfg_group_instOne instance of the cfg group variables which stores the additional values
_cfg_group_metaMeta-data which is stored before each variable group within the blob
_cfg_mappingStructure used for variable - pointer mapping
_dbg_action$Id$
_dbt_resultDBText module interface
_dlg_ctxDialog context
_dlg_transfer_ctx$Id$
_dstr_buff_tBuffer used by dynamic string
_dstring_tDynamic string structure
_ht_cell$Id$
_mq_item$Id$
_mq_message_tStructure holding message which can be put into message queue
_notifier_tInternal structure storing registered notifiers
_pdt_node$Id$
_pv_exportPV spec format:

  • $class_name
  • $class_name(inner_name)
  • $(class_name[index])
  • $(class_name(inner_name)[index])
  • $(class_name{transformation})
  • $(class_name(inner_name){transformation})
  • $(class_name[index]{transformation})
  • $(class_name(inner_name)[index]{transformation})
_pv_tmx_data$Id$
_pv_xcap_uriXcapuri PV export
_qsa_subscription_tInternal structure holding informations about created client subscriptions
_rl_subscription_tSubscription to the list of resources
_sr_geoip_record$Id$
_sr_lua_env$Id$
_sr_mono_env$Id$
_stm_route$Id$
_strData structure used across SER sources to store counted-length strings
aorToIndexStructUsed to map between an 'aor' (OpenSER index) and a user index
as_entrySER processes will go through the as_table, doing if(valid && memcmp(name,his_name,name_len)==0), when one matches, they will put the as pointer inside the event that should process that event
async_param$Id$
atomic_tAtomic_t defined as a struct to easily catch non atomic operations on it
auth_db_apiAUTH_DB API structure
bdb_uriBDB driver specific payload to attach to db_uri structures
branchStructure for storing branch attributes
cancel_reasonCancel reason structure
carrier_data_tThe struct for a carrier
cfg_group_coreConfiguration default values
cfg_optionToken mapping structure
cfg_parserParser state
cfg_tokenStructure representing a lexical token
cfgutils_apiCFGUTILS API structure
cmd_export_common_Members situated at the same place in memory in both ser & kamailio cmd_export
contact_hooksHooks to well known parameters for contact class of parameters
contactToIndexStructUsed to map between a 'contact' name (OpenSER's index) and a contact index
db1_con_tThis structure represents a database connection, pointer to this structure are used as a connection handle from modules uses the db API
db1_resThis type represents a result returned by db_query function (see below)
db_cmdStructure db_cmd describes command in DB-API
db_funcDatabase module callbacks
db_idStructure representing a database ID
db_rowStructure holding the result of a query table function
db_val_tThis structure represents a value in the database
dbtextdb::dbtextdb::DBText
dlg_cellEntries in the dialog list
dlg_entryEntries in the main dialog table
dlg_iuidInternal unique ide per dialog
dlg_profile_entryDialog profile entry
dlg_profile_hashDialog profile hash list
dlg_profile_linkList with links to dialog profiles
dlg_profile_tableDialog profile table
dlg_tableMain dialog table
dlg_timerDialog timer
dlg_tlDialog timeout list
dlistList of all domains registered with usrloc
dns_rrStripped down dns rr
domain_data_tThe struct for the domain
domain_list_itemList of all domains registered with usrloc
dtrie_node_tTrie node
dbtextdb::dbtextdb::Error
dbtextdb::dbtextdb::ExecuteError
failure_route_ruleSecond stage of processing: Try to map the end of the user part of the URI to a given suffix
fifo_optHolds values and command type when a command was passed to fifo
flat_cmdExtension structure of db_cmd adding flatstore specific data
flat_conA structure representing flatstore virtual connections
flat_uriFlatstore driver specific payload to attach to db_uri structures
fm_blockBlock of memory for F_MALLOC memory manager
fparamFunction parameter
garbageGarbage collection data structure
hashtable_entry_tHashtable for ringing records
hdr_fieldFormat: name':' body
kam_cmd_export_Kamailo/openser version
kam_module_exportsKamailio/openser module exports version
ld_cmdExtension structure of db_cmd adding LDAP specific data
ld_conA structure representing a connection to a LDAP server
ld_uriLDAP driver specific payload to attach to db_uri structures
log_level_infoMaps log levels to their string name and corresponding syslog level
maxfwd_apiMAXFWD API structure
MD5_CTXMD5 context
mem_infoMemory information structure
module_exports_commonModule exports in the same place in memory in both ser & kamailio
msg_bodyThis structure represents a generic SIP message body, regardless of the body type
msg_ctx_idStruct to identify a msg context

  • the pair of pid and message-id
msg_queueMessage queue structure
msrp_str_id$Id$
multiparam_tGeneric parameter that holds a string, an int or an pseudo-variable
name_addrName-addr structure, see RFC3261 for more details
name_map_tUsed to map names to numbers for faster access
dbtextdb::dbtextdb::NotSupportedError
paramStructure representing a parameter
param_hooksUnion of hooks structures for all classes
dbtextdb::dbtextdb::ParseError
pg_cmdExtension structure of db_cmd adding PostgreSQL specific data
pg_conPostgres specific connection data
pg_typeStructure mapping field names to Oids
pg_uriPostgreSQL driver specific payload to attach to db_uri structures
pool_conThis is a stub that contains all attributes that pool members must have, it is not really used, real connection structures are created by database backends
qm_blockBlock of memory for Q_MALLOC memory manager
qos_ctx_stThe QoS context
raw_filterFilter for limiting packets received on raw sockets
re_grpRegular expression for groups
reference_counter_data_tStructure holding reference counter value
reference_counter_group_tStructure holding information about group of reference counters
registrar_apiREGISTRAR API structure
ring_record_tList of calls for ringing functionality
route_data_tAll routing data
route_flagsUse route rules only if message flags match stored mask/flags
route_ruleSecond stage of processing: Try to map the end of the user part of the URI to a given suffix
route_rule_p_listList of routing rules with hash index
rpc_ctxThe context of the xhttp_rpc request being processed
rpc_structThe structure represents a XML-RPC document structure
rrStructure representing a Route & Record-Route HF body
rr_bindsRecord-route API export binding
rr_callbackRr callback
rval_cacheValue cache for a rvalue struct
sbufReallocatable string buffer
sdp_infoHere we hold the head of the parsed sdp structure
ser_cmd_export_Ser version
ser_module_exportsSer module exports version
session_expiresWe will treat the 'void* parsed' field of struct hdr_field as a pointer to a struct session_expires
sip_msgThe SIP message
sip_uriThe SIP uri object
siputils_apiSiputils module API
sl_apiStateless (sl) API structure
sl_cbelemSL callback structure definition
sl_cbpSL callback parameter structure
sockaddr_dtgramUnion because we support 3 types of sockaddr : UNIX, IPv4 and IPv6
sr31_cmd_export_Sip-router version
sr31_module_exportsSr/ser 3.1+ module exports version
sst_info_stThe local state required to figure out if and who supports SST and if and who will be the refresher
sst_msg_info_stA collection of information about SST in the current SIP message being processed
statscellStores statistics about a given APP SERVER, for instance, how much it lasted to respond to a given incoming request transaction, how many requests went in and how many responses went out, etc
statstableTransactions statistics table
str_listSimple str type list
string_bufferReallocatable string buffer
tls_domainSeparate configuration per ip:port
tls_domains_cfgTLS configuration structures
tm_xdataExtra data from SIP message context to transaction storage
tm_xlinksLinks to extra data from SIP message context to transaction storage
treeDefines a locked prefix tree
tree_itemDefines a route item in the prefix tree
type_node_sNode of the type's tree; this tree contains all the known types;
ucontactMain structure for handling of registered Contact data
ucontact_infoInformations related to a contact
udomainUsrloc record
urecordBasic hash table element
uri_hooksHooks to well known parameter for URI class of parameters
usrloc_apiUsrloc API export structure
xhttp_rpc_replyRepresentation of the xhttp_rpc reply being constructed
xmlrpc_replyRepresentation of the XML-RPC reply being constructed