/*
* Copyright (C) 2009 Risto Känsäkoski - Sesca ISW Ltd
* Copyright (C) 2005 Luca Veltri - University of Parma - Italy
*
* This file is part of SIP-Applet (www.sesca.com, www.purplescout.com)
* This file is modified from MjSip (http://www.mjsip.org)
*
* MjSip is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* MjSip is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with MjSip; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
*/
package org.zoolu.sip.transaction;
import org.zoolu.sip.address.SipURL;
import org.zoolu.sip.provider.*;
import org.zoolu.sip.message.*;
import org.zoolu.tools.Timer;
import org.zoolu.tools.TimerListener;
import org.zoolu.tools.LogLevel;
import com.sesca.misc.Logger;
/** INVITE client transaction as defined in RFC 3261 (Section 17.2.1).
* <BR> An InviteTransactionClient is responsable to create a new SIP invite
* transaction, starting with a invite message sent through the SipProvider
* and ending with a final response.
* <BR> The changes of the internal status and the received messages are fired
* to the TransactionListener passed to the InviteTransactionClient object.
*/
public class InviteTransactionClient extends TransactionClient
{
/** the TransactionClientListener that captures the events fired by the InviteTransactionClient */
TransactionClientListener transaction_listener;
/** ack message */
Message ack;
/** retransmission timeout ("Timer A" in RFC 3261) */
//Timer retransmission_to;
/** transaction timeout ("Timer B" in RFC 3261) */
//Timer transaction_to;
/** end timeout for invite transactions ("Timer D" in RFC 3261)*/
Timer end_to;
/** Creates a new ClientTransaction */
public InviteTransactionClient(SipProvider sip_provider, Message req, TransactionClientListener listener)
{ super(sip_provider);
request=new Message(req);
init(listener,request.getTransactionId());
}
/** Initializes timeouts and listener. */
void init(TransactionClientListener listener, TransactionIdentifier transaction_id)
{ this.transaction_listener=listener;
this.transaction_id=transaction_id;
this.ack=null;
retransmission_to=new Timer(SipStack.retransmission_timeout,"Retransmission",this);
transaction_to=new Timer(SipStack.transaction_timeout,"Transaction",this);
end_to=new Timer(SipStack.transaction_timeout,"End",this);
printLog("id: "+String.valueOf(transaction_id),LogLevel.HIGH);
printLog("created",LogLevel.HIGH);
}
/** Starts the InviteTransactionClient and sends the invite request. */
public void request()
{ printLog("start",LogLevel.LOW);
changeStatus(STATE_TRYING);
retransmission_to.start();
transaction_to.start();
sip_provider.addSipProviderListener(transaction_id,this);
connection_id=sip_provider.sendMessage(request);
}
/** Method derived from interface SipListener.
* It's fired from the SipProvider when a new message is catch for to the present ServerTransaction.
*/
public void onReceivedMessage(SipProvider provider, Message msg)
{
if (msg.isResponse())
{ int code=msg.getStatusLine().getCode();
if (code>=100 && code<200 && (statusIs(STATE_TRYING) || statusIs(STATE_PROCEEDING)))
{ if (statusIs(STATE_TRYING))
{ retransmission_to.halt();
transaction_to.halt();
changeStatus(STATE_PROCEEDING);
}
if (transaction_listener!=null) transaction_listener.onTransProvisionalResponse(this,msg);
return;
}
if (code>=300 && code<700 && (statusIs(STATE_TRYING) || statusIs(STATE_PROCEEDING) || statusIs(STATE_COMPLETED)))
{ if (statusIs(STATE_TRYING) || statusIs(STATE_PROCEEDING))
{
Logger.paranoia("InviteTransactionClient.onReceivedMessage, status="+status);
retransmission_to.halt();
transaction_to.halt();
MessageFactory msgf = new MessageFactory();
ack=msgf.createNon2xxAckRequest(sip_provider,request,msg);
changeStatus(STATE_COMPLETED);
if (transaction_listener!=null) transaction_listener.onTransFailureResponse(this,msg);
Logger.paranoia("InviteTransactionClient.onReceivedMessage: transaction_listener="+ ((transaction_listener!=null) ? transaction_listener.getClass():"null"));
transaction_listener=null;
connection_id=sip_provider.sendMessage(ack);
if (connection_id==null) end_to.start();
else
{ printLog("end_to=0 for reliable transport",LogLevel.LOW);
onTimeout(end_to);
}
}
else
{ // retransmit ACK only in case of unreliable transport
Logger.paranoia("InviteTransactionClient.onReceivedMessage, status="+status+", sending ACK.");
if (connection_id==null) sip_provider.sendMessage(ack);
}
return;
}
if (code>=200 && code<300 && (statusIs(STATE_TRYING) || statusIs(STATE_PROCEEDING)))
{ retransmission_to.halt();
transaction_to.halt();
end_to.halt();
changeStatus(STATE_TERMINATED);
sip_provider.removeSipProviderListener(transaction_id);
if (transaction_listener!=null) transaction_listener.onTransSuccessResponse(this,msg);
transaction_listener=null;
return;
}
}
}
/** Method derived from interface TimerListener.
* It's fired from an active Timer. */
public void onTimeout(Timer to)
{ try
{ if (to.equals(retransmission_to) && statusIs(STATE_TRYING))
{ printLog("Retransmission timeout expired",LogLevel.HIGH);
// retransmission only in case of unreliable transport
if (connection_id==null)
{ sip_provider.sendMessage(request);
long timeout=2*retransmission_to.getTime();
retransmission_to=new Timer(timeout,retransmission_to.getLabel(),this);
retransmission_to.start();
}
else printLog("No retransmissions for reliable transport ("+connection_id+")",LogLevel.LOW);
}
if (to.equals(transaction_to))
{ printLog("Transaction timeout expired",LogLevel.HIGH);
retransmission_to.halt();
end_to.halt();
sip_provider.removeSipProviderListener(transaction_id);
changeStatus(STATE_TERMINATED);
if (transaction_listener!=null) transaction_listener.onTransTimeout(this);
transaction_listener=null;
}
if (to.equals(end_to))
{ printLog("End timeout expired",LogLevel.HIGH);
retransmission_to.halt();
transaction_to.halt();
sip_provider.removeSipProviderListener(transaction_id);
changeStatus(STATE_TERMINATED);
transaction_listener=null; // already null..
}
}
catch (Exception e)
{ printException(e,LogLevel.HIGH);
}
}
/** Terminates the transaction. */
public void terminate()
{ if (!statusIs(STATE_TERMINATED))
{ retransmission_to.halt();
transaction_to.halt();
end_to.halt();
sip_provider.removeSipProviderListener(transaction_id);
changeStatus(STATE_TERMINATED);
transaction_listener=null;
}
}
}