using System;
using System.Collections.Generic;
using System.Text;
using System.Timers;
using System.Net;
using LumiSoft.Net.SIP.Message;
namespace LumiSoft.Net.SIP.Stack
{
#region Delegates
/// <summary>
/// Represents method what will handle <b>ResponseSent</b> event.
/// </summary>
/// <param name="e">Event data.</param>
public delegate void SIP_ResponseSentEventHandler(SIP_ResponseSentEventArgs e);
#endregion
/// <summary>
/// Implements SIP server transaction. Defined in RFC 3261 17.2 Server Transaction.
/// A transaction is a sequence of SIP messages exchanged between SIP network elements.
/// Server transaction is created when remote UA (client transaction) request is received by local UA.
/// Server transaction provides way to send responses back to remote UA client transaction.
/// </summary>
/// <remarks>
/// <img src="../images/SIP_ServerTransaction.gif" />
/// </remarks>
public class SIP_ServerTransaction : SIP_Transaction
{
private SIP_Stack m_pSipStack = null;
private string m_ID = "";
private SIP_Request m_pRequest = null;
private Timer m_pTransactionTimeoutTimer = null;
private Timer m_pTimerG = null;
private Timer m_pTimerH = null;
private Timer m_pTimerI = null;
private Timer m_pTimerJ = null;
private List<SIP_Response> m_pResponses = null;
private SIP_Dialog m_pDialog = null;
private int m_RSeqNumber = 1;
private Timer m_p100relRetransmitTimer = null;
private DateTime m_p100relTimerStartTime;
private SIP_Response m_pPending100rel = null;
private Queue<SIP_Response> m_pQueued100rel = null;
private Timer m_pDisposeTimer = null;
private bool m_IsDisposed = false;
/// <summary>
/// Default constructor.
/// </summary>
/// <param name="sipStack">Reference to SIP stack.</param>
/// <param name="request">SIP request what caused to create server transaction.</param>
internal SIP_ServerTransaction(SIP_Stack sipStack,SIP_Request request)
{
m_pSipStack = sipStack;
m_pRequest = request;
SetRequestMethod(request.Method);
m_ID = request.Via.GetTopMostValue().Branch;
m_pResponses = new List<SIP_Response>();
m_pQueued100rel = new Queue<SIP_Response>();
Begin();
}
#region method Dispose
/// <summary>
/// Disposes transaction and cleans up all resources.
/// </summary>
public override void Dispose()
{
if(m_IsDisposed){
return;
}
m_IsDisposed = true;
try{
SetTransactionState(SIP_TransactionState.Terminated);
base.Dispose();
if(m_pTransactionTimeoutTimer != null){
m_pTransactionTimeoutTimer.Dispose();
m_pTransactionTimeoutTimer = null;
}
if(m_pTimerG != null){
m_pTimerG.Dispose();
m_pTimerG = null;
}
if(m_pTimerH != null){
m_pTimerH.Dispose();
m_pTimerH = null;
}
if(m_pTimerI != null){
m_pTimerI.Dispose();
m_pTimerI = null;
}
if(m_pTimerJ != null){
m_pTimerJ.Dispose();
m_pTimerJ = null;
}
if(m_p100relRetransmitTimer != null){
m_p100relRetransmitTimer.Dispose();
m_p100relRetransmitTimer = null;
}
if(m_pDisposeTimer != null){
m_pDisposeTimer.Dispose();
m_pDisposeTimer = null;
}
// Log
m_pSipStack.Logger.AddDebug("Transaction(id='" + m_ID + "' method=" + m_pRequest.Method + " server=true) disposed.");
}
finally{
// Remove from transactions collection.
m_pSipStack.TransactionLayer.RemoveServerTransaction(this);
OnTerminated();
}
}
#endregion
#region method Begin
/// <summary>
/// Starts processing server transaction.
/// </summary>
private void Begin()
{
// Log
m_pSipStack.Logger.AddDebug("Transaction(id='" + m_ID + "' method=" + m_pRequest.Method + " server=true) created.");
// INVITE server transaction
if(m_pRequest.Method == "INVITE"){
/* When a server transaction is constructed for a request, it enters the
"Proceeding" state. The server transaction MUST generate a 100 (Trying) response.
*/
SetTransactionState(SIP_TransactionState.Proceeding);
SendTrying();
}
// Non-INVITE server transaction
else{
/* When a server transaction is constructed for a request, it enters the "Trying" state.
*/
SetTransactionState(SIP_TransactionState.Trying);
}
// This is just timout timer and ensures that transaction ends or will terminated.
m_pTransactionTimeoutTimer = new Timer(180 * SIP_TimerConstants.T1);
m_pTransactionTimeoutTimer.Elapsed += new ElapsedEventHandler(m_pTransactionTimeoutTimer_Elapsed);
m_pTransactionTimeoutTimer.Enabled = true;
// Log
m_pSipStack.Logger.AddDebug("Transaction(id='" + m_ID + "' method=" + m_pRequest.Method + " server=true) Transaction timeout Timer started, will triger after " + m_pTransactionTimeoutTimer.Interval + ".");
}
#endregion
#region method Cancel
/// <summary>
/// Cancels transaction. NOTE: Only INVITE transaction can be canceled, for other methods cancel is skipped.
/// If If final response is already sent, then cancel has no effect and will be skipped.
/// </summary>
public override void Cancel()
{
/* RFC 3261 9.2.
If we have sent final response, skip cancel, because it has no effect. If the UAS has not
issued a final response for the original request, its behavior depends on the method of the
original request. If the original request was an INVITE, the UAS SHOULD immediately respond to
the INVITE with a 487 (Request Terminated). A CANCEL request has no impact on the processing of
transactions with any other method defined in this specification.
*/
lock(this){
// If final response sent, skip cancel.
if(GetFinalResponse() != null){
return;
}
else{
// Only INVITE can be canceled.
if(m_pRequest.Method == SIP_Methods.INVITE){
SendResponse(m_pRequest.CreateResponse(SIP_ResponseCodes.x487_Request_Terminated));
// We no normally must get ACK now, if not timeout timers will
// take care of disposing this transaction.
OnCanceled();
// Log
m_pSipStack.Logger.AddDebug("Transaction(id='" + m_ID + "' method=" + m_pRequest.Method + " server=true) canceled.");
}
}
}
}
#endregion
#region method SendResponse
/// <summary>
/// Sends a SIP response message to the caller client transaction whose request initiated this server transaction.
/// The response value must be SIP_ServerTransaction.Request.CreateResponse value.
/// </summary>
/// <param name="response">SIP response to send.</param>
/// <exception cref="ObjectDisposedException">Is raised when this class is Disposed and this property is accessed.</exception>
/// <exception cref="ArgumentNullException">Is raised when <b>response</b> is null.</exception>
public void SendResponse(SIP_Response response)
{
SendResponse(response,this.MustSend100relResponse);
}
/// <summary>
/// Sends a SIP response message to the caller client transaction whose request initiated this server transaction.
/// The response value must be SIP_ServerTransaction.Request.CreateResponse value.
/// </summary>
/// <param name="response">SIP response to send.</param>
/// <param name="reliable">Specifies if provisional response is sent reliably. This option has
/// effect only if INVITE 101 > 199 response is sent. This value can be true only if this.CanSend100relResponse = true,
/// otherwise InvalidOperationException is thrown.</param>
/// <exception cref="ObjectDisposedException">Is raised when this class is Disposed and this property is accessed.</exception>
/// <exception cref="ArgumentNullException">Is raised when <b>response</b> is null.</exception>
/// <exception cref="InvalidOperationException">Is raised when provisional response is tried to send reliably,
/// but caller won't support reliable provisional responses.</exception>
public void SendResponse(SIP_Response response,bool reliable)
{
if(m_IsDisposed){
throw new ObjectDisposedException("SIP_ServerTransaction");
}
if(response == null){
throw new ArgumentNullException("response");
}
if(reliable && response.StatusCode >= 101 && response.StatusCode < 200 && !this.CanSend100relResponse){
throw new InvalidOperationException("Caller won't support reliable provisional response sending !");
}
// Add header fields required for reliable provisional response.
if(m_pRequest.Method == SIP_Methods.INVITE && response.StatusCode >= 101 && response.StatusCode < 200 && reliable){
/* RFC 3261 3.
The provisional response to be sent reliably is constructed by the
UAS core according to the procedures of Section 8.2.6 of RFC 3261.
In addition, it MUST contain a Require header field containing the
option tag 100rel, and MUST include an RSeq header field. The value
of the header field for the first reliable provisional response in a
transaction MUST be between 1 and 2**31 - 1. It is RECOMMENDED that
it be chosen uniformly in this range. The RSeq numbering space is
within a single transaction. This means that provisional responses
for different requests MAY use the same values for the RSeq number.
*/
// Set Required: header if needed.
if(!SIP_Utils.ContainsOptionTag(response.Require.GetAllValues(),SIP_OptionTags.x100rel)){
response.Require.Add(SIP_OptionTags.x100rel);
}
response.RSeq = m_RSeqNumber++;
// If we have pending reliable provisional reponse, queue this one up.
// It will be sent when PRACK received for pending one.
if(this.HasPending100rel){
m_pQueued100rel.Enqueue(response);
// Log.
m_pSipStack.Logger.AddDebug("Transaction(id='" + m_ID + "' method=" + m_pRequest.Method + " server=true) reliable provisional response queued, there is pending one.");
return;
}
else{
m_pPending100rel = response;
// Start reliable provisional response retransmit timer.
m_p100relTimerStartTime = DateTime.Now;
m_p100relRetransmitTimer = new Timer(SIP_TimerConstants.T1);
m_p100relRetransmitTimer.AutoReset = true;
m_p100relRetransmitTimer.Elapsed += new ElapsedEventHandler(m_p100relRetransmitTimer_Elapsed);
m_p100relRetransmitTimer.Enabled = true;
// Log.
m_pSipStack.Logger.AddDebug("Transaction(id='" + m_ID + "' method=" + m_pRequest.Method + " server=true) reliable provisional response retransmit timer started.");
}
}
// If final response and there are any queued reliable provisional responses, remove them.
// Also if pending INVITE relaible provisional response, stop retransmiting it.
if(response.StatusCodeType != SIP_StatusCodeType.Provisional){
m_pQueued100rel.Clear();
if(m_p100relRetransmitTimer != null){
m_p100relRetransmitTimer.Dispose();
m_p100relRetransmitTimer = null;
// Log.
m_pSipStack.Logger.AddDebug("Transaction(id='" + m_ID + "' method=" + m_pRequest.Method + " server=true) reliable provisional response retransmit timer stoped, transaction got 2xx response.");
}
}
ProcessResponse(response);
OnResponseSent(response);
}
#endregion
#region method m_pTimerG_Elapsed
/// <summary>
/// Is called when INVITE response retransission must be done.
/// </summary>
/// <param name="sender"></param>
/// <param name="e"></param>
private void m_pTimerG_Elapsed(object sender,ElapsedEventArgs e)
{
/* RFC 3261 17.2.1.
When timer G fires, the server transaction MUST retransmit the response by passing
it to the transport layer, and MUST reset the timer with a value of MIN(2*T1,T2).
For the default values of T1 and T2, this results in intervals of 500 ms, 1 s, 2 s, 4 s, 4 s, etc.
*/
// Log.
m_pSipStack.Logger.AddDebug("Transaction(id='" + m_ID + "' method=" + m_pRequest.Method + " server=true) Timer G(INVITE response retransmission interval) triggered,next transmit after " + m_pTimerG.Interval + " ms.");
// Retransmits response.
m_pSipStack.TransportLayer.SendResponse(m_pRequest.Socket,GetFinalResponse());
// Update interval.
m_pTimerG.Interval = Math.Min(m_pTimerG.Interval * 2,SIP_TimerConstants.T2);
}
#endregion
#region method m_pTimerH_Elapsed
/// <summary>
/// Is called when INVITE completed state ACK wait time reached.
/// </summary>
/// <param name="sender"></param>
/// <param name="e"></param>
private void m_pTimerH_Elapsed(object sender,ElapsedEventArgs e)
{
/* RFC 3261 17.2.1.
If timer H fires while in the "Completed" state, it implies that the
ACK was never received. In this case, the server transaction MUST
transition to the "Terminated" state, and MUST indicate to the TU
that a transaction failure has occurred.
*/
// Log.
m_pSipStack.Logger.AddDebug("Transaction(id='" + m_ID + "' method=" + m_pRequest.Method + " server=true) Timer H(Wait time for ACK receipt) triggered.");
if(this.TransactionState == SIP_TransactionState.Completed){
Dispose();
// Notify TU
OnTransactionError("ACK never received !");
}
}
#endregion
#region merhod m_pTimerI_Elapsed
/// <summary>
/// Is called when INVITE Confirmed linger time completed.
/// </summary>
/// <param name="sender"></param>
/// <param name="e"></param>
private void m_pTimerI_Elapsed(object sender,ElapsedEventArgs e)
{
// Log.
m_pSipStack.Logger.AddDebug("Transaction(id='" + m_ID + "' method=" + m_pRequest.Method + " server=true) Timer I(Wait time for ACK retransmissions) triggered.");
Dispose();
}
#endregion
#region mehtod m_pTimerJ_Elapsed
/// <summary>
/// Is called when non-INVITE Confirmed linger time completed.
/// </summary>
/// <param name="sender"></param>
/// <param name="e"></param>
private void m_pTimerJ_Elapsed(object sender,ElapsedEventArgs e)
{
/* RFC 3261 17.2.2
Timer J fires, at which point it MUST transition to the "Terminated" state.
*/
// Log.
m_pSipStack.Logger.AddDebug("Transaction(id='" + m_ID + "' method=" + m_pRequest.Method + " server=true) Timer J(Wait time for retransmissions of non-INVITE requests) triggered.");
Dispose();
}
#endregion
#region method m_pTransactionTimeoutTimer_Elapsed
/// <summary>
/// Is called when transaction has timed out.
/// </summary>
/// <param name="sender"></param>
/// <param name="e"></param>
private void m_pTransactionTimeoutTimer_Elapsed(object sender,ElapsedEventArgs e)
{
// Log.
m_pSipStack.Logger.AddDebug("Transaction(id='" + m_ID + "' method=" + m_pRequest.Method + " server=true) Transaction timeout timer triggered.");
OnTimedOut();
Dispose();
}
#endregion
#region method m_p100relRetransmitTimer_Elapsed
/// <summary>
/// This method is called when reliable provisional response retransmit or timeout reached.
/// </summary>
/// <param name="sender">Sender.</param>
/// <param name="e">Event data.</param>
private void m_p100relRetransmitTimer_Elapsed(object sender,ElapsedEventArgs e)
{
/* RFC 3262 3.
The reliable provisional response is passed to the transaction layer
periodically with an interval that starts at T1 seconds and doubles
for each retransmission.
If a reliable provisional response is retransmitted for 64*T1 seconds
without reception of a corresponding PRACK, the UAS SHOULD reject the
original request with a 5xx response.
*/
if(DateTime.Now > m_p100relTimerStartTime.AddSeconds(64 * SIP_TimerConstants.T1)){
m_p100relRetransmitTimer.Dispose();
m_p100relRetransmitTimer = null;
// Log.
m_pSipStack.Logger.AddDebug("Transaction(id='" + m_ID + "' method=" + m_pRequest.Method + " server=true) reliable provisional response retransmit timer stopped, no PRACK acknowledge.");
try{
if(this.TransactionState != SIP_TransactionState.Terminated){
SendResponse(this.Request.CreateResponse(SIP_ResponseCodes.x500_Server_Internal_Error + ": PRACK was not received for response."));
}
}
catch{
// We don't care about errors here.
}
}
else{
m_p100relRetransmitTimer.Interval = m_p100relRetransmitTimer.Interval * 2;
try{
m_pSipStack.TransportLayer.SendResponse(m_pRequest.Socket,m_pPending100rel);
// Log.
m_pSipStack.Logger.AddDebug("Transaction(id='" + m_ID + "' method=" + m_pRequest.Method + " server=true) reliable provisional response retransmitted.");
}
catch(Exception x){
// Log.
m_pSipStack.Logger.AddDebug("Transaction(id='" + m_ID + "' method=" + m_pRequest.Method + " server=true) reliable provisional response retransmit failed: " + x.Message);
}
}
}
#endregion
#region method m_pDisposeTimer_Elapsed
/// <summary>
/// This method is called when Dispose linger timer completed.
/// </summary>
/// <param name="sender">Sender.</param>
/// <param name="e">Event data.</param>
private void m_pDisposeTimer_Elapsed(object sender,ElapsedEventArgs e)
{
Dispose();
}
#endregion
#region method ProcessRequest
/// <summary>
/// Processes transaction request.
/// </summary>
/// <param name="request">SIP request.</param>
internal void ProcessRequest(SIP_Request request)
{
// TODO: We MAY accept only ACK,CANCEL and request retransmission.
// Log
m_pSipStack.Logger.AddDebug("Transaction(id='" + m_ID + "' method=" + m_pRequest.Method + " server=true) got request '" + request.Method + "'.");
lock(this){
#region ACK
if(request.Method == SIP_Methods.ACK){
/* RFC 3261 17.2.1.
If an ACK is received while the server transaction is in the
"Completed" state, the server transaction MUST transition to the
"Confirmed" state. As Timer G is ignored in this state, any
retransmissions of the response will cease.
Also kill timer H(ACK wait timeout timer) because we got ACK.
*/
if(this.TransactionState == SIP_TransactionState.Completed){
SetTransactionState(SIP_TransactionState.Confirmed);
// If there is timer G (response retransmit timer), stop it,because we got ACK.
if(m_pTimerG != null){
m_pTimerG.Dispose();
m_pTimerG = null;
// Log
m_pSipStack.Logger.AddDebug("Transaction(id='" + m_ID + "' method=" + m_pRequest.Method + " server=true) Timer G (response retransmit timer) stopped.");
}
// If there is timer H (ACK wait timeout timer), stop it because we got ACK.
if(m_pTimerH != null){
m_pTimerH.Dispose();
m_pTimerH = null;
// Log
m_pSipStack.Logger.AddDebug("Transaction(id='" + m_ID + "' method=" + m_pRequest.Method + " server=true) Timer H (ACK wait timeout timer) stopped.");
}
/* RFC 3261 17.2.1.
The purpose of the "Confirmed" state is to absorb any additional ACK
messages that arrive, triggered from retransmissions of the final response.
When confirmed state is entered, timer I is set to fire in T4
seconds for unreliable transports, and zero seconds for reliable transports.
*/
if(request.Via.GetTopMostValue().ProtocolTransport.ToUpper() == "UDP"){
m_pTimerI = new Timer(SIP_TimerConstants.T4);
m_pTimerI.AutoReset = false;
m_pTimerI.Elapsed += new ElapsedEventHandler(m_pTimerI_Elapsed);
// Log
m_pSipStack.Logger.AddDebug("Transaction(id='" + m_ID + "' method=" + m_pRequest.Method + " server=true) Timer I (additional ACK absorb) started, will triger after " + m_pTimerI.Interval + ".");
}
else{
Dispose();
}
}
}
#endregion
#region CANCEL
else if(request.Method == SIP_Methods.CANCEL){
// Do new server transaction for cancel.
// We bind RFC here, rfc says UAS needs to respond canel, we hide cancel stuff from user.
// If somebody knows why we can't do so, let me know.
m_pSipStack.TransactionLayer.CreateServerTransaction(request).SendResponse(request.CreateResponse(SIP_ResponseCodes.x200_Ok));
Cancel();
}
#endregion
#region INVITE
// INVITE server transaction
else if(request.Method == SIP_Methods.INVITE){
/*
If a retransmission of the request is received while in the "Proceeding" state, the most
recently sent provisional response MUST be passed to the transport layer for retransmission.
In the "Completed" state, the server transaction MUST pass the final response to the transport
layer for retransmission whenever a retransmission of the request is received.
*/
if(this.TransactionState == SIP_TransactionState.Proceeding){
SIP_Response lastProvisionalResponse = GetLastProvisionalResponse();
if(lastProvisionalResponse != null){
m_pSipStack.TransportLayer.SendResponse(request.Socket,lastProvisionalResponse);
}
}
else if(this.TransactionState == SIP_TransactionState.Completed){
m_pSipStack.TransportLayer.SendResponse(request.Socket,GetFinalResponse());
}
}
#endregion
#region Non-INVITE
// Non-INVITE server transaction
else{
/*
In the "Trying" state, any further request retransmissions are discarded.
If a retransmission of the request is received while in the "Proceeding" state, the most
recently sent provisional response MUST be passed to the transport layer for retransmission.
In the "Completed" state, the server transaction MUST pass the final response to the transport
layer for retransmission whenever a retransmission of the request is received.
*/
if(this.TransactionState == SIP_TransactionState.Trying){
// Do nothing
}
else if(this.TransactionState == SIP_TransactionState.Proceeding){
m_pSipStack.TransportLayer.SendResponse(request.Socket,GetLastProvisionalResponse());
}
else if(this.TransactionState == SIP_TransactionState.Completed){
m_pSipStack.TransportLayer.SendResponse(request.Socket,GetFinalResponse());
}
}
#endregion
}
}
#endregion
#region method ProcessResponse
/// <summary>
/// Processes specified SIP response through this transaction.
/// </summary>
/// <param name="response">SIP response to process.</param>
private void ProcessResponse(SIP_Response response)
{
// Log
m_pSipStack.Logger.AddDebug("Transaction(id='" + m_ID + "' method=" + m_pRequest.Method + " server=true) got response response='" + response.StatusCode + "'.");
#region INVITE
// INVITE server transaction
if(m_pRequest.Method == "INVITE"){
#region Proceeding
// Proceeding state
if(this.TransactionState == SIP_TransactionState.Proceeding){
// 1xx response
if(response.StatusCodeType == SIP_StatusCodeType.Provisional){
// We don't forward 100 Trying, skip it
if(response.StatusCode == 100){
return;
}
m_pResponses.Add(response);
EnsureDialog(response);
// Send unreliably (Pass to tranport layer)
m_pSipStack.TransportLayer.SendResponse(m_pRequest.Socket,m_pRequest.RemoteEndPoint,response);
}
// 2xx response
else if(response.StatusCodeType == SIP_StatusCodeType.Success){
EnsureDialog(response);
// Send unreliably (Pass to tranport layer)
m_pSipStack.TransportLayer.SendResponse(m_pRequest.Socket,m_pRequest.RemoteEndPoint,response);
SetTransactionState(SIP_TransactionState.Terminated);
LingerDispose();
}
// 300-699 response
else{
SetTransactionState(SIP_TransactionState.Completed);
m_pResponses.Add(response);
// Send unreliably (Pass to tranport layer)
m_pSipStack.TransportLayer.SendResponse(m_pRequest.Socket,m_pRequest.RemoteEndPoint,response);
/* RFC 3261 17.2.1.
When the "Completed" state is entered, timer H MUST be set to fire in
64*T1 seconds for all transports. Timer H determines when the server
transaction abandons retransmitting the response.
*/
m_pTimerH = new Timer(64 * SIP_TimerConstants.T1);
m_pTimerH.AutoReset = false;
m_pTimerH.Elapsed += new ElapsedEventHandler(m_pTimerH_Elapsed);
// Log
m_pSipStack.Logger.AddDebug("Transaction(id='" + m_ID + "' method=" + m_pRequest.Method + " server=true) Timer H(response retransmit timeout timer) started, will triger after " + m_pTimerH.Interval + ".");
/* RFC 3261 17.2.1.
For unreliable transports, timer G is set to fire in T1 seconds,
and is not set to fire for reliable transports.
(INVITE final response retransmit timer)
*/
if(response.Via.GetTopMostValue().ProtocolTransport.ToUpper() == "UDP"){
m_pTimerG = new Timer(SIP_TimerConstants.T1);
m_pTimerG.Elapsed += new ElapsedEventHandler(m_pTimerG_Elapsed);
m_pTimerG.Enabled = true;
// Log
m_pSipStack.Logger.AddDebug("Transaction(id='" + m_ID + "' method=" + m_pRequest.Method + " server=true) Timer G(INVITE final response retransmit timer) started, will triger after " + m_pTimerG.Interval + ".");
}
}
}
#endregion
#region Completed
// Completed state
else if(this.TransactionState == SIP_TransactionState.Completed){
// We do nothing here, we just wait ACK to arrive.
}
#endregion
#region Confirmed
else if(this.TransactionState == SIP_TransactionState.Confirmed){
// We do nothing, just wait ACK retransmissions while linger time.
}
#endregion
#region Terminated
else if(this.TransactionState == SIP_TransactionState.Terminated){
// We should never rreach here, but if so, skip it.
}
#endregion
}
#endregion
#region Non-INVITE
// Non-INVITE server transaction
else{
#region Trying
// Trying state
if(this.TransactionState == SIP_TransactionState.Trying){
// 1xx response
if(response.StatusCodeType == SIP_StatusCodeType.Provisional){
SetTransactionState(SIP_TransactionState.Proceeding);
m_pResponses.Add(response);
// Send unreliably (Pass to tranport layer)
m_pSipStack.TransportLayer.SendResponse(m_pRequest.Socket,m_pRequest.RemoteEndPoint,response);
}
// 200-699 response
else{
SetTransactionState(SIP_TransactionState.Completed);
m_pResponses.Add(response);
// Send unreliably (Pass to tranport layer)
m_pSipStack.TransportLayer.SendResponse(m_pRequest.Socket,m_pRequest.RemoteEndPoint,response);
/* RFC 3261 17.2.2.
When the server transaction enters the "Completed" state, it MUST set
Timer J to fire in 64*T1 seconds for unreliable transports.
(wait time for retransmissions of non-INVITE requests)
*/
if(response.Via.GetTopMostValue().ProtocolTransport.ToUpper() == "UDP"){
m_pTimerJ = new Timer(64 * SIP_TimerConstants.T1);
m_pTimerJ.AutoReset = false;
m_pTimerJ.Elapsed += new ElapsedEventHandler(m_pTimerJ_Elapsed);
m_pTimerJ.Enabled = true;
// Log
m_pSipStack.Logger.AddDebug("Transaction(id='" + m_ID + "' method=" + m_pRequest.Method + " server=true) Timer J(wait time for retransmissions of non-INVITE requests) started, will triger after " + m_pTimerJ.Interval + ".");
}
else{
LingerDispose();
}
}
}
#endregion
#region Proceeding
// Proceeding state
else if(this.TransactionState == SIP_TransactionState.Proceeding){
// 1xx response
if(response.StatusCodeType == SIP_StatusCodeType.Provisional){
m_pResponses.Add(response);
// Send unreliably (Pass to tranport layer)
m_pSipStack.TransportLayer.SendResponse(m_pRequest.Socket,m_pRequest.RemoteEndPoint,response);
}
// 200-699 response
else{
SetTransactionState(SIP_TransactionState.Completed);
m_pResponses.Add(response);
// Send unreliably (Pass to tranport layer)
m_pSipStack.TransportLayer.SendResponse(m_pRequest.Socket,m_pRequest.RemoteEndPoint,response);
/* RFC 3261 17.2.2.
When the server transaction enters the "Completed" state, it MUST set
Timer J to fire in 64*T1 seconds for unreliable transports.
(wait time for retransmissions of non-INVITE requests)
*/
if(response.Via.GetTopMostValue().ProtocolTransport.ToUpper() == "UDP"){
m_pTimerJ = new Timer(64 * SIP_TimerConstants.T1);
m_pTimerJ.AutoReset = false;
m_pTimerJ.Elapsed += new ElapsedEventHandler(m_pTimerJ_Elapsed);
m_pTimerJ.Enabled = true;
// Log
m_pSipStack.Logger.AddDebug("Transaction(id='" + m_ID + "' method=" + m_pRequest.Method + " server=true) Timer J(wait time for retransmissions of non-INVITE requests) started, will triger after " + m_pTimerJ.Interval + ".");
}
}
}
#endregion
#region Completed
// Completed state
else if(this.TransactionState == SIP_TransactionState.Completed){
// Just resend last response.
m_pSipStack.TransportLayer.SendResponse(m_pRequest.Socket,m_pRequest.RemoteEndPoint,GetFinalResponse());
}
#endregion
#region Terminated
// Terminated state
else if(this.TransactionState == SIP_TransactionState.Terminated){
// We should never rreach here, but if so, skip it.
}
#endregion
}
#endregion
}
#endregion
#region method ProcessPRACK
/// <summary>
/// Tries to process PRACK through this transaction.
/// </summary>
/// <param name="request">PRACK request.</param>
/// <returns>Retruns true if PRACK processes, otherwise false.</returns>
internal bool ProcessPRACK(SIP_Request request)
{
if(m_pPending100rel == null){
return false;
}
/* RFC 3262 3.
A matching PRACK is defined as one within the same dialog as the response,
and whose method, CSeq-num, and response-num in the RAck header field match,
respectively, the method from the CSeq, the sequence number from the CSeq,
and the sequence number from the RSeq of the reliable provisional response.
*/
if(request.RAck.Method == m_pPending100rel.CSeq.RequestMethod &&
request.RAck.CSeqNumber == m_pPending100rel.CSeq.SequenceNumber &&
request.RAck.ResponseNumber == m_pPending100rel.RSeq
){
m_pPending100rel = null;
m_p100relRetransmitTimer.Dispose();
m_p100relRetransmitTimer = null;
// Log.
m_pSipStack.Logger.AddDebug("Transaction(id='" + m_ID + "' method=" + m_pRequest.Method + " server=true) reliable provisional response retransmit timer stopped, response PRACK acknowledged.");
// If queued reliable provisional response, send it.
if(m_pQueued100rel.Count > 0){
m_pPending100rel = m_pQueued100rel.Dequeue();
// Start reliable provisional response retransmit timer.
m_p100relTimerStartTime = DateTime.Now;
m_p100relRetransmitTimer = new Timer(SIP_TimerConstants.T1);
m_p100relRetransmitTimer.AutoReset = true;
m_p100relRetransmitTimer.Elapsed += new ElapsedEventHandler(m_p100relRetransmitTimer_Elapsed);
m_p100relRetransmitTimer.Enabled = true;
// Log.
m_pSipStack.Logger.AddDebug("Transaction(id='" + m_ID + "' method=" + m_pRequest.Method + " server=true) reliable provisional response retransmit timer started.");
ProcessResponse(m_pPending100rel);
OnResponseSent(m_pPending100rel);
}
return true;
}
else{
return false;
}
}
#endregion
#region method LingerDispose
/// <summary>
/// Schedules dispose method. Dispose is called after 32 seconds.
/// This is not defined in rfc, but is needed for request retransmission catches and
/// and delayed PRACK request for INVITE unacknowledged reliable provisional responses.
/// About INVITE server transaction there is discussion at http://bugs.sipit.net/show_bug.cgi?id=769,
/// </summary>
private void LingerDispose()
{
if(m_pDisposeTimer != null){
return;
}
m_pDisposeTimer = new Timer(SIP_TimerConstants.T1 * 64);
m_pDisposeTimer.AutoReset = false;
m_pDisposeTimer.Elapsed += new ElapsedEventHandler(m_pDisposeTimer_Elapsed);
m_pDisposeTimer.Enabled = true;
}
#endregion
#region method SendTrying
/// <summary>
/// Sends trying response to request maker.
/// </summary>
private void SendTrying()
{
/* RFC 3261 8.2.6.1 Sending a Provisional Response.
When a 100 (Trying) response is generated, any Timestamp header field
present in the request MUST be copied into this 100 (Trying)
response. If there is a delay in generating the response, the UAS
SHOULD add a delay value into the Timestamp value in the response.
*/
SIP_Response sipTryingResponse = new SIP_Response();
sipTryingResponse.StatusCode_ReasonPhrase = SIP_ResponseCodes.x100_Trying;
sipTryingResponse.Via.AddToTop(m_pRequest.Via.GetTopMostValue().ToStringValue());
sipTryingResponse.To = m_pRequest.To;
sipTryingResponse.From = m_pRequest.From;
sipTryingResponse.CallID = m_pRequest.CallID;
sipTryingResponse.CSeq = m_pRequest.CSeq;
// Add time stamp, because we send Trying at once, we don't have delay.
if(m_pRequest.Timestamp != null){
sipTryingResponse.Timestamp = new SIP_t_Timestamp(m_pRequest.Timestamp.Time,0);
}
// Send response
m_pSipStack.TransportLayer.SendResponse(m_pRequest.Socket,m_pRequest.RemoteEndPoint,sipTryingResponse);
}
#endregion
#region method EnsureDialog
/// <summary>
/// Ensures that SIP dialog exists. If not, creates SIP dialog.
/// </summary>
/// <param name="response">SIP response what causes dialog creation.</param>
private void EnsureDialog(SIP_Response response)
{
lock(this){
if(this.CanCreateDialog){
SIP_Dialog dialog = null;
if(m_pSipStack.TransactionLayer.EnsureDialog(this,response,out dialog)){
this.Dialogs.Add(dialog);
}
if(response.StatusCodeType == SIP_StatusCodeType.Success){
m_pDialog = dialog;
}
}
}
}
#endregion
#region Properties Implementation
/// <summary>
/// Gets transaction ID (Via: branch parameter value).
/// </summary>
public override string ID
{
get{ return m_ID; }
}
/// <summary>
/// Gets request what created this server transaction.
/// </summary>
/// <exception cref="ObjectDisposedException">Is raised when this class is Disposed and this property is accessed.</exception>
public override SIP_Request Request
{
get{
if(m_IsDisposed){
throw new ObjectDisposedException("SIP_ServerTransaction");
}
return m_pRequest;
}
}
/// <summary>
/// Gets transaction related responses.
/// </summary>
/// <exception cref="ObjectDisposedException">Is raised when this class is Disposed and this property is accessed.</exception>
public override SIP_Response[] Responses
{
get{
if(m_IsDisposed){
throw new ObjectDisposedException("SIP_ServerTransaction");
}
return m_pResponses.ToArray();
}
}
/// <summary>
/// Gets transaction dialog. Returns null if no dialog available.
/// </summary>
public override SIP_Dialog Dialog
{
get{ return m_pDialog; }
}
/// <summary>
/// Gets if UA is allowed to send reliable provisional response.
/// INVITE request which created server transaction has Supported: 100rel or Required: 100rel.
/// </summary>
/// <exception cref="ObjectDisposedException">Is raised when this class is Disposed and this property is accessed.</exception>
public bool CanSend100relResponse
{
get{
if(m_IsDisposed){
throw new ObjectDisposedException("SIP_ServerTransaction");
}
if(!this.CanCreateDialog){
return false;
}
else if(m_pRequest.Method != SIP_Methods.INVITE){
return false;
}
else if(this.MustSend100relResponse){
return true;
}
else{
return SIP_Utils.ContainsOptionTag(m_pRequest.Supported.GetAllValues(),SIP_OptionTags.x100rel);
}
}
}
/// <summary>
/// Gets if SendResponse must send provisional response reliably.
/// INVITE request which created server transaction has Required: 100rel.
/// </summary>
/// <exception cref="ObjectDisposedException">Is raised when this class is Disposed and this property is accessed.</exception>
public bool MustSend100relResponse
{
get{
if(m_IsDisposed){
throw new ObjectDisposedException("SIP_ServerTransaction");
}
if(!this.CanCreateDialog){
return false;
}
else if(m_pRequest.Method != SIP_Methods.INVITE){
return false;
}
else{
return SIP_Utils.ContainsOptionTag(m_pRequest.Require.GetAllValues(),SIP_OptionTags.x100rel);
}
}
}
/// <summary>
/// Gets if transaction has pending reliable provisional response.
/// </summary>
/// <exception cref="ObjectDisposedException">Is raised when this class is Disposed and this property is accessed.</exception>
public bool HasPending100rel
{
get{
if(m_IsDisposed){
throw new ObjectDisposedException("SIP_ServerTransaction");
}
return m_pPending100rel != null;
}
}
/// <summary>
/// Gets if transaction is disposed.
/// </summary>
public override bool IsDisposed
{
get{ return m_IsDisposed; }
}
#endregion
#region Events Implementation
/// <summary>
/// This event is raised when SIP response has sent through this transaction.
/// </summary>
public event SIP_ResponseSentEventHandler ResponseSent = null;
/// <summary>
/// Raises <b>ResponseSent</b> event.
/// </summary>
/// <param name="response">SIP response.</param>
private void OnResponseSent(SIP_Response response)
{
if(this.ResponseSent != null){
this.ResponseSent(new SIP_ResponseSentEventArgs(this,response));
}
}
#endregion
}
}
Submit an article or tip