Class List

Here are the classes, structs, unions and interfaces with brief descriptions:
AsynchMediaRelayMsgMessage object used to communicate to AsynchMediaRelayRequestSender via its message queue
AsynchMediaRelayRequestSenderClass used to communicate with the Media Relay (a.k.a Symmitron) in an asynchronous fashion
AuthPluginSIP Registrar Plugin Hook Action
BranchTimePair
BridgeThis class encapsulates all the information relative to a Bridge obtained from the Symmitron
CallDestinationThe purpose of this auth plugin is to remove the call destination information from an INVITE request header and copy/append it to the Record-Route
CallDestinationTest
CallerAliasModify the From header of a request based on lookup in the caller-alias database
CallerAliasTest
CallStateEventBuilderThe base class for any means of building a record of a call state event
CallStateEventBuilder_DBThis CallStateEventBuilder constructs events as database rows according to the specification doc/cdr/call-state-events.html
CallStateEventBuilder_XMLThis CallStateEventBuilder constructs events as XML elements according to the specification doc/cdr/call-state-events.html
CallStateEventWriterThis CallStateEventWriter writes CSE events out to either a file or a database to the specification doc/cdr/call-state-events.html
CallStateEventWriter_DBThis CallStateEventWriter writes CSE events out to either a file or a database to the specification doc/cdr/call-state-events.html
CallStateEventWriter_XMLThis CallStateEventWriter writes CSE events out to either a file or a database to the specification doc/cdr/call-state-events.html
CallTrackerClass used to track all the forks associated with a given call
CallTrackerInterfaceForSessionContext
DialogTrackerImplements the state machine that knows how to track a dialog's answer/offer and intervene when necessary to facilitatre NAT traversal
DialogTracker::RequestRetransmissionDescriptor
DialogTracker::ResponseRetransmissionDescriptor
DialogTracker::RetransmissionDescriptor
DialogTrackerState
DialogTrackerStateStruct
DialogTrackerTest
EmergencyNotifyThis is an AuthRules plugin called by SipRouter
EmergencyRulesTest
EndpointDescriptorUsed to analyze a URI to look for proprietary location markers ("x-sipX-nonat" and "x-sipX-privcontact") and derive the native and public IP Address:port;transport information relative to a given SIP endpoint. Furthermore, it is responsible for computing the location of that endpoint relative to the sipXecs based on its public and native transport information and the content of the NatTraversalRules. The EndpointDescriptor can classify the location of an enpoint into one of 4 categories: PUBLIC: The endpoint is not located behind any NAT. LOCAL_NATED: The endpoint is located in the same local private entwork as the sipXecs and both are behind the same NAT. REMOTE_NATED: The endpoint is behind a remote NAT UNKNOWN: The location of the endpoint cannot be determined
EnforceAuthRulesEnforces the rules specified by authrules.xml
EnforceAuthRulesTest
ForwardRules
MediaBridgePairA Symmitron Bridge effectively relays a UDP data stream between two endpoints
MediaDescriptorUsed to store the information related a given media negotiation for both the caller (original UAC) and the callee (original UAS) as well as some information common to both the caller and the callee (session directionality and type for example). The information stored in this class is mainly extracted the offer's and answer's Media Description section of an SDP Offer/Answer. Each instance of a MediaDescriptor is responsible for storing the information of a single Media Description section inside an SDP that is why all the APIs that accept an SDP body as a parameter also accept an index parameter which represents the 0-based index of the Media Description section that pay attention to
MediaEndpointThis class is an abstraction of a SIP endpoint involved in a media session. It is used to store that endpoint's media address, RTP and RTCP ports
MediaRelayThe class is used to abstract the Symmitron which is the external process that actually performs the media relaying
MediaRelaySessionThis class is an abstration of a single session capable of relaying one RTP + one RTCP streams between two endpoints
Moribund
MSFT_ExchangeTransferHackModifies an incorrectly constructed REFER from MSFT Exchange so that it works
MSFT_ExchangeTransferHackTest
NativeTransportData
NatMaintainerWhen a User Agent behind a NAT/FW sends a message to sipXecs, it creates a pinhole that allows sipXecs to communicate back to it
NatMaintainer::KeepAliveEndpointDescriptorInformation that NatMaintainer keeps about an endpoint
NatTraversalAgentAuth Plugin responsible for implementing the nANT traversal feature
NatTraversalAgentTest
NatTraversalDataTypesTest
NatTraversalRulesClass that knows how to parse the NatTraversalRules.xml file and extract its information
NatTraversalRules::StunClientClass that gets used by NatTraversalRules class to resolve the public IP address through STUN whenever the nattraversalrules.xml config file calls for it
NatTraversalRulesTest
Negotiating
PacketProcessingStatisticsStructure used to save packet processing information
ProcessingPrack
ProcessingPrackWaitingForAckforInvite
PublicTransportData
RequestLinterThe purpose of this auth plugin is to remove from a request all the elements (headers, parameters,
RequestLinterTest
RouteParameterName
RouteStateManipulate sipXauthproxy state information in Record-Route and Route headers
SessionContextThe sessionContext class implements the state machine that knows jow to track a call fork answer/offer and intervene when necessary to facilitatre NAT traversal
SessionContext::CseqData
SessionContextInterfaceForDialogTracker
SessionContextTest
SignalTask
SipRouterSipRouter implements the main message handling responsible for the forking authorization and forwarding of SIP messages
SipXProxyCseObserverObserve and record Call State Events in the Forking Proxy
SubscriptionAuthPlug-in responsible for forcing the authentication of SUBSCRIBE requests for event packages that require authentication, which are listed in the PACKAGES_REQUIRING_AUTHENTICATION configuration value found in the sipXproxy-config configuration file. The creation of this plug-in was prompted by XECS-1606
SubscriptionAuthTest
SymThis class encapsulates all the information relative to a Sym obtained from the Symmitron
TimeBoundState
TransferControlEnforces the rules specified by authrules.xml
TransferControlTest
TransportData
WaitingFor200OkForPrack
WaitingFor200OkForSlowStartPrack
WaitingFor200OkWithAnswerForPrack
WaitingFor200OkWithMediaOffer
WaitingForAckForInvite
WaitingForAckWithAnswerForInvite
WaitingForInvite
WaitingForMediaAnswer
WaitingForMediaOffer
WaitingForPrack
WaitingForPrackWithMediaAnswer

Online Library Docs

sipXecs home page

Version 4.2.1-018930 2010-07-31T01:50:17 build33 abuild