Skip to main content

Module variables

Module variables 

Source
Expand description

Channel variable types: format parsers (ARRAY::, SIP multipart) and typed variable name enums.

Structs§

EslArray
Parses FreeSWITCH ARRAY::item1|:item2|:item3 format
EslHeaders
A flat header store that decodes FreeSWITCH ARRAY and bracket encoding when answering typed SIP header queries.
InvalidHeaderName
Error returned when a raw header name is empty or carries a wire terminator.
LoopbackChannelName
Borrowed view of a parsed loopback channel name. No allocation.
LoopbackResignation
A loopback leg that resigned from a call which is still up.
MultipartBody
Parses variable_sip_multipart ARRAY:: format.
MultipartItem
A single part from a SIP multipart body
ParseChannelVariableError
Error for an unrecognized value; displays as unknown channel variable (<n> bytes). The rejected input is the field.
ParseConferenceVariableError
Error for an unrecognized value; displays as unknown conference variable (<n> bytes). The rejected input is the field.
ParseCoreMediaVariableError
Error for an unrecognized value; displays as unknown core media variable (<n> bytes). The rejected input is the field.
ParseLoopbackHangupCauseError
Error returned when parsing an invalid loopback hangup cause string.
ParseLoopbackLegError
Error returned when parsing an invalid loopback leg string.
ParseLoopbackVariableError
Error for an unrecognized value; displays as unknown loopback variable (<n> bytes). The rejected input is the field.
ParseSipPassthroughError
Error returned when parsing an unrecognized passthrough header variable name.
ParseSofiaVariableError
Error for an unrecognized value; displays as unknown sofia variable (<n> bytes). The rejected input is the field.
SipPassthroughHeader
A FreeSWITCH SIP passthrough header variable name.

Enums§

CarriedHeader
Relationship between a SofiaVariable and the SIP header behind it.
ChannelVariable
Core FreeSWITCH channel variable names (the part after the variable_ prefix).
ConferenceVariable
mod_conference channel variable names (the part after the variable_ prefix).
CoreMediaVariable
RTP media statistics channel variable names (the part after the variable_ prefix).
EslArrayError
Errors from EslArray::parse.
LoopbackHangupCause
Which mod_loopback path resigned, from the loopback_hangup_cause value.
LoopbackLeg
Which half of a loopback pair, from the loopback_leg variable.
LoopbackVariable
mod_loopback channel variable names (the part after the variable_ prefix).
MultipartBodyError
Errors from MultipartBody::parse.
RtpStatUnit
Unit of measurement for an RTP statistic channel variable.
SipHeaderPrefix
FreeSWITCH SIP header passthrough variable prefix.
SofiaVariable
mod_sofia / SIP channel variable names (the part after the variable_ prefix).

Constants§

MAX_ARRAY_ITEMS
Maximum items accepted by EslArray::parse.

Traits§

VariableName
Trait for typed channel variable name enums.