siptransactioninviteclientua.cxx

MiniSip Client with DomainKeys Authentication, Sip, Audio communications, Echo Cancel

/*
  Copyright (C) 2005, 2004 Erik Eliasson, Johan Bilien
  
  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation; either
  version 2.1 of the License, or (at your option) any later version.

  This library 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
  Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General Public
  License along with this library; if not, write to the Free Software
  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*/

/*
 * Authors: Erik Eliasson <[e-mail]>
 *          Johan Bilien <[e-mail]>
*/


/* Name
 * 	SipTransactionIntiveInitiator.cxx
 * Author
 * 	Erik Eliasson, [e-mail]
 * Purpose
 * 
*/


/*
                                start
                               o
                               |INVITE from TU
             Timer A fires     |INVITE sent
             Reset A,          V                      Timer B fires
             INVITE sent +-----------+                or Transport Err.
               +---------|           |---------------+inform TU
               |         |  Calling  |---------------)---+
               +-------->|           |X------------->|   N
                         +-----------+ 2xx           |   | a1001
                            |  |       2xx to TU     |   | 2XX
                            |  |1xx                  |   | 2XX to TU
    300-699 +---------------+  |1xx to TU            |   | ACK sent
   ACK sent |                  |                     |   |
resp. to TU |  1xx             V                     |   |
            |  1xx to TU  -----------+               |   |
            |  +---------|           |               |   |
            |  |         |Proceeding |-X------------>|   |
            |  +-------->|           | 2xx           |   |
            |            +-----------+ 2xx to TU     |   |
            |       300-699    | N 2XX  a1002        |   |
            |       ACK sent,  | | 2XX to TU         |   |
            |       resp. to TU| | ACK sent          |   |
            |                  | |  +----------------)---+  NOTE:
            |  300-699         V V  V                |
            |  ACK sent  +-----------+Transport Err. |  transitions
            |  +---------|           |Inform TU      |  labeled with
            |  |         | Completed |-------------->|  the event
            |  +-------->|           |<--+           |  over the action
            |            +-----------+   |2XX        |  to take
            |              ^   |  N      |ACK sent   |
            |              |   |  +------+           |
            |              |   |                     |
            |              |   | Timer D fires       |
            +--------------+   | -                   |
                               |                     |
                               V                     |
                         +-----------+               |
                         |           |               |
                         | Terminated|<--------------+
                         |           |
                         +-----------+


*/

 
#include<config.h>

#include<libmsip/SipTransactionInviteClientUA.h>
#include<libmsip/SipResponse.h>
#include<libmsip/SipTransactionUtils.h>
#include<libmsip/SipCommandDispatcher.h>
#include<libmsip/SipSMCommand.h>
#include<libmsip/SipDialog.h>
#include<libmsip/SipDialogConfig.h>
#include<libmutil/MemObject.h>
#include<libmutil/dbg.h>

using namespace std;

	
bool SipTransactionInviteClientUA::a1001_calling_completed_2xx( const SipSMCommand &command) {
	if (transitionMatch(SipResponse::type, command, SipSMCommand::transport_layer, SipSMCommand::transaction_layer, "2**")){
		MRef<SipResponse *> resp((SipResponse*) *command.getCommandPacket());
		
		cancelTimeout("timerA");
		cancelTimeout("timerB");
		if( isUnreliable() )
			requestTimeout(sipStack->getTimers()->getD(),"timerD");
		else 
			requestTimeout( 0,"timerD");

		//update dialogs route set ... needed to add route headers to the ACK we are going to send
		//setDialogRouteSet( resp );
		//assert(dialog); //An invite transaction must always be within a dialog

		//TODO/XXX/FIXME: Do this in the TU instead!! --EE
//		dialog->dialogState.updateState( (MRef<SipResponse*>((SipResponse *)*command.getCommandPacket()) ) );
			
		SipSMCommand cmd( command.getCommandPacket(), 
				SipSMCommand::transaction_layer, 
				SipSMCommand::dialog_layer);
		dispatcher->enqueueCommand( cmd, HIGH_PRIO_QUEUE/*, PRIO_LAST_IN_QUEUE*/ );
#ifdef DEBUG_OUTPUT
		cerr<<"****************1001************"<<endl;
#endif
		sendAck(resp, getBranch()+"ACK");
		
		return true;
	}else{
		return false;
	}
}
	
bool SipTransactionInviteClientUA::a1002_proceeding_completed_2xx( const SipSMCommand &command) {
	if (transitionMatch(SipResponse::type, command, SipSMCommand::transport_layer, SipSMCommand::transaction_layer, "2**")){
		MRef<SipResponse *> resp((SipResponse*)*command.getCommandPacket());
		cancelTimeout("timerA");
		cancelTimeout("timerB");
		if( isUnreliable() )
			requestTimeout(sipStack->getTimers()->getD(),"timerD");
		else 
			requestTimeout( 0,"timerD");
		
		//update dialogs route set ... needed to add route headers to the ACK we are going to send
		//setDialogRouteSet( resp );
		//assert(dialog);
		//TODO/XXX/FIXME: Do in TU instead
		//dialog->dialogState.updateState( (MRef<SipResponse*>((SipResponse *)*command.getCommandPacket()) ) );
			
		SipSMCommand cmd( command.getCommandPacket(), 
				SipSMCommand::transaction_layer, 
				SipSMCommand::dialog_layer);
		dispatcher->enqueueCommand( cmd, HIGH_PRIO_QUEUE/*, PRIO_LAST_IN_QUEUE*/ );
#ifdef DEBUG_OUTPUT
		cerr<<"****************1002************"<<endl;
#endif
		sendAck(resp, getBranch()+"ACK");

		return true;
	}else{
		return false;
	}
}
	
bool SipTransactionInviteClientUA::a1003_completed_completed_2xx( const SipSMCommand &command) {
	if (transitionMatch(SipResponse::type, command, SipSMCommand::transport_layer, SipSMCommand::transaction_layer, "2**")){
		MRef<SipResponse *> resp((SipResponse*)*command.getCommandPacket());
#ifdef DEBUG_OUTPUT
		cerr<<"****************1003************"<<endl;
#endif
		sendAck(resp, getBranch()+"ACK");

		return true;
	}else{
		return false;
	}
}


void SipTransactionInviteClientUA::changeStateMachine(){
	MRef<State<SipSMCommand, string> *> s_calling = getState("calling");
	bool success = s_calling->removeTransition("transition_calling_terminated_2xx");
	if (!success)
		merr << "ERROR: Could not remove transition from state machine in SipTransactionInviteClientUA (BUGBUG!!)"<< end;

	
	MRef<State<SipSMCommand, string> *>s_proceeding = getState("proceeding");
	success = s_proceeding->removeTransition("transition_proceeding_terminated_2xx");
	if (!success)
		merr << "ERROR: Could not remove transition(2) from state machine in SipTransactionInviteClientUA (BUGBUG!!)"<< end;
	

	MRef<State<SipSMCommand, string> *> s_completed= getState("completed");


	
	new StateTransition<SipSMCommand,string>(this, "transition_calling_completed_2xx",
			(bool (StateMachine<SipSMCommand,string>::*)(const SipSMCommand&)) &SipTransactionInviteClientUA::a1001_calling_completed_2xx,
			s_calling, s_completed);

	new StateTransition<SipSMCommand,string>(this, "transition_proceeding_completed_2xx",
			(bool (StateMachine<SipSMCommand,string>::*)(const SipSMCommand&)) &SipTransactionInviteClientUA::a1002_proceeding_completed_2xx,
			s_proceeding, s_completed);

	new StateTransition<SipSMCommand,string>(this, "transition_completed_completed_2xx",
			(bool (StateMachine<SipSMCommand,string>::*)(const SipSMCommand&)) &SipTransactionInviteClientUA::a1003_completed_completed_2xx,
			s_completed, s_completed);
}


SipTransactionInviteClientUA::SipTransactionInviteClientUA(MRef<SipStack*> stack, 
		//MRef<SipDialog*> call, 
		int seq_no, 
		const string &cSeqMethod, 
		const string &callid): 
			SipTransactionInviteClient(stack, /*call,*/ seq_no, cSeqMethod, callid)
{
	changeStateMachine();
}

SipTransactionInviteClientUA::~SipTransactionInviteClientUA(){
}