Replicating SIP sessions
This topic provides an overview of when replication of session and dialog state can take place during typical SIP call flows.
Overview
In WAS V6.1, SIP replication is done on a “best effort” basis. Generally, the SIP container uses the Data Replication Service (DRS) to replicate all state information. DRS provides no way to confirm when data replication has completed, so the only thing that can be quantified is when a piece of state information is queued for replication. Within this topic, references to replication of data means only that the data has been queued for replication. The SIP container replicates several different types of information. This data falls into two general categories:
- Internal SIP container state information associated with the dialog.
- Application state information associated with the various session objects.
Each category includes a number of different data types, which are described below. In terms of replication, each data object is treated independently. In other words, a change to an application session object, which causes a replication, will not result in the replication of any internal state information.
Replication of internal state information Internal state information can be defined as anything related to the state of a dialog being handled by the container. It includes things like cseq, dialog state (initial, early, confirmed, terminated), session expiration, local, remote party, etc. Internal state information is only replicated due to the existence of a dialog. Therefore, no internal SIP-related data will be replicated until the dialog with which it is associated is established. The types of SIP requests that can cause the creation of a dialog include:
- INVITE
- SUBSCRIBE
- REFER
Replication of internal state happens at well-defined, predictable points in the call flow. For example, a dialog is only established at the container when a 2xx response or a 1xx response with a “To” tag is received or sent due to one of the method types listed above. Events that can trigger an internal state replication include:
- Creation of a new SIP dialog
- Expiration of a session due to a session timeout
- The sending of a final response to a UAC
- Creation of an encoded URI
- Handling of any message that results in a change of the internal dialog state
It is important to note that transaction state is NOT replicated in the WAS 6.1 version of the SIP container, only dialog state. Not replicating transaction state reduces the load on all the servers in the replication domain, but can cause problems in failures that happen in the middle of a transaction (for example, loss of some dialog-related SIP messages).
An important difference between a B2BUA and a proxy application is the number of session objects created and replicated. In both cases only a single application session is created, but for the B2BUA, two session objects are created–one for the inbound leg and one for the outbound leg. For a proxy application, only a single session object is created.
Replication of application state information Application state information is treated differently from internal dialog state information because it does not rely on the existence of a dialog to be replicated. Application state refers to any data that is being maintained by the application through the use of JSR 116 data constructs. This includes:
- javax.servlet.sip.SipApplicationSession
- javax.servlet.sip.SipSession
- javax.servlet.sip.ServletTimer
- Any attribute set on the SipSession or the SipApplicationSession
Replication of internal state happens at well-defined, predictable points in the call flow, while replication of application state is less predictable because it is generally dependent on when an application creates, invalidates or modifies the session data and timers through JSR 116 APIs. This could be due to the processing of an inbound message, or to the expiration of a SIP timer. All of the following can cause the replication of application-related session data:
- Creation of an application session object
- Creation of a SIP session object
- Creation of a SIP session timer
- Modification of a session object through setAttribute or removeAttribute
- Invalidation of a SIP session object
- Expiration of a session timer
- Application code sending out a request *
* Causes replication of the SipSession and SipApplicationSession in order to synchronize the "last access timestamp" with the peer container(s) in the cluster. This is for integrity of future calls to SipSession.getLastAccessedTime() and SipApplicationSession.getLastAccessedTime().
Replication can occur for requests that do not establish a dialog if an application calls request.getApplicationSession(true) and if addTimer() and/or addAttribute() are called on the resulting application session object. This is needed so that a listener can be called when the timer expires.
SIP failover and replication setup considerations
A SIP cluster that requires replication and failover can consist of many replication domains, each of which contain a set of SIP containers. There is no limit set on the number of containers in a cluster. A SIP cluster that requires replication and failover can consist of many replication domains, each of which contain a set of SIP containers. For performance reasons, each replication domain should contain 2 containers only.
The replication domain should be set to the Entire Domain, which means state is replicated to all containers in the replication domain. The replication mode should be Both client and server.
The distributed session for a container needs to be set to Memory-to-memory replication. Any applications that require session replication must include the <distributable /> tag in the web.xml and sip.xml files. Both SIP and HTTP will utilize the same replication topology
Setting up a replication domain
- On the Replication domains panel, select New.
- On the following panel, under Number of replicas , select Entire domain.
- On the following panel, under Container settings , select Session management .
- On the following panel, under Additional properties , select Distributed environment settings .
- On the following panel, select Memory-to-memory replication.
- On the following panel, set Replication mode to Both client and server .
- Memory-to-memory replication is enabled after you save.
SIP session replication topology
- Each member replicates all state data to every peer in its replication domain.
- Each replication domain should ideally be 2 servers.
- When a failure occurs, the core group coordinator tells the members which to activate and which become part of their active sessions.
SIP high availability
Related tasks
Browse all SIP topics