android.gov.nist.javax.sip.stack

Class SIPClientTransactionImpl

java.lang.Object

android.gov.nist.javax.sip.stack.SIPTransactionImpl

android.gov.nist.javax.sip.stack.SIPClientTransactionImpl

All Implemented Interfaces:

ClientTransactionExt, ServerResponseInterface, SIPClientTransaction, SIPTransaction, TransactionExt, ClientTransaction, Transaction, Serializable

public class SIPClientTransactionImpl
extends SIPTransactionImpl
implements SIPClientTransaction

Represents a client transaction. Implements the following state machines. (From RFC 3261)

 
 
 
 
 
 
                                                     |INVITE from TU
                                   Timer A fires     |INVITE sent
                                   Reset A,          V                      Timer B fires
                                   INVITE sent +-----------+                or Transport Err.
                                     +---------|           |---------------+inform TU
                                     |         |  Calling  |               |
                                     +-------->|           |-------------->|
                                               +-----------+ 2xx           |
                                                  |  |       2xx to TU     |
                                                  |  |1xx                  |
                          300-699 +---------------+  |1xx to TU            |
                         ACK sent |                  |                     |
                      resp. to TU |  1xx             V                     |
                                  |  1xx to TU  -----------+               |
                                  |  +---------|           |               |
                                  |  |         |Proceeding |-------------->|
                                  |  +-------->|           | 2xx           |
                                  |            +-----------+ 2xx to TU     |
                                  |       300-699    |                     |
                                  |       ACK sent,  |                     |
                                  |       resp. to TU|                     |
                                  |                  |                     |      NOTE:
                                  |  300-699         V                     |
                                  |  ACK sent  +-----------+Transport Err. |  transitions
                                  |  +---------|           |Inform TU      |  labeled with
                                  |  |         | Completed |-------------->|  the event
                                  |  +-------->|           |               |  over the action
                                  |            +-----------+               |  to take
                                  |              ˆ   |                     |
                                  |              |   | Timer D fires       |
                                  +--------------+   | -                   |
                                                     |                     |
                                                     V                     |
                                               +-----------+               |
                                               |           |               |
                                               | Terminated|<--------------+
                                               |           |
                                               +-----------+
                      
                                       Figure 5: INVITE client transaction
                      
                      
                                                         |Request from TU
                                                         |send request
                                     Timer E             V
                                     send request  +-----------+
                                         +---------|           |-------------------+
                                         |         |  Trying   |  Timer F          |
                                         +-------->|           |  or Transport Err.|
                                                   +-----------+  inform TU        |
                                      200-699         |  |                         |
                                      resp. to TU     |  |1xx                      |
                                      +---------------+  |resp. to TU              |
                                      |                  |                         |
                                      |   Timer E        V       Timer F           |
                                      |   send req +-----------+ or Transport Err. |
                                      |  +---------|           | inform TU         |
                                      |  |         |Proceeding |------------------>|
                                      |  +-------->|           |-----+             |
                                      |            +-----------+     |1xx          |
                                      |              |      ˆ        |resp to TU   |
                                      | 200-699      |      +--------+             |
                                      | resp. to TU  |                             |
                                      |              |                             |
                                      |              V                             |
                                      |            +-----------+                   |
                                      |            |           |                   |
                                      |            | Completed |                   |
                                      |            |           |                   |
                                      |            +-----------+                   |
                                      |              ˆ   |                         |
                                      |              |   | Timer K                 |
                                      +--------------+   | -                       |
                                                         |                         |
                                                         V                         |
                                   NOTE:           +-----------+                   |
                                                   |           |                   |
                               transitions         | Terminated|<------------------+
                               labeled with        |           |
                               the event           +-----------+
                               over the action
                               to take
                      
                                       Figure 6: non-INVITE client transaction
 
 
 
 
 
 
 

Version:

1.2 $Revision: 1.144 $ $Date: 2010-12-02 22:04:16 $

Author:

M. Ranganathan

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	SIPClientTransactionImpl.TransactionTimer

Field Summary

Fields inherited from class android.gov.nist.javax.sip.stack.SIPTransactionImpl

applicationData, auditTag, baseTimerInterval, collectionTime, encapsulatedChannel, expiresTimerTask, isMapped, lastResponse, mergeId, originalRequest, originalRequestBranch, originalRequestBytes, originalRequestCSeqNumber, originalRequestHasPort, sipStack, T2, T4, timeoutTimerTicksLeft, timerD, timerI, timerK, toListener, transactionId, transactionTimerStarted

Fields inherited from interface android.gov.nist.javax.sip.stack.SIPTransaction

CALLING_STATE, COMPLETED_STATE, CONFIRMED_STATE, INITIAL_STATE, PROCEEDING_STATE, T1, TERMINATED_STATE, TIMER_A, TIMER_B, TIMER_F, TIMER_H, TIMER_J, TRYING_STATE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SIPClientTransactionImpl(SIPTransactionStack newSIPStack, MessageChannel newChannelToUse) Creates a new client transaction.

Method Summary

Methods

Modifier and Type	Method and Description
void	alertIfStillInCallingStateBy(int count) Send a transaction timeout event to the application if Tx is still in Calling state in the given time period ( in base timer interval count ) after sending request.
boolean	checkFromTag(SIPResponse sipResponse) Check if the From tag of the response matches the from tag of the original message.
void	cleanUp()
protected void	cleanUpOnTerminated()
protected void	cleanUpOnTimer()
void	clearState() This is called by the stack after a non-invite client transaction goes to completed state.
Request	createAck() Creates a new Ack message from the Request associated with this client transaction.
Request	createCancel() Creates a new Cancel message from the Request associated with this client transaction.
void	fireRetransmissionTimer() Called by the transaction stack when a retransmission timer fires.
void	fireTimeoutTimer() Called by the transaction stack when a timeout timer fires.
SIPDialog	getDefaultDialog() Get the default dialog that was originally assigned to the client transaction.
Dialog	getDialog() Gets the dialog object of this Transaction object.
SIPDialog	getDialog(String dialogId)
Hop	getNextHop() Reeturn the previously computed next hop (avoid computing it twice).
String	getOriginalRequestCallId()
Contact	getOriginalRequestContact()
Event	getOriginalRequestEvent()
String	getOriginalRequestFromTag()
String	getOriginalRequestScheme()
Via	getOutgoingViaHeader() get the via header for an outgoing request.
MessageChannel	getRequestChannel() Returns this transaction.
String	getViaHost() Get the host to assign for an outgoing Request via header.
int	getViaPort() Get the port to assign for the via header of an outgoing message.
boolean	isMessagePartOfTransaction(SIPMessage messageToTest) Tests a message to see if it is part of this transaction.
boolean	isNotifyOnRetransmit()
void	processResponse(SIPResponse sipResponse, MessageChannel incomingChannel) This method is called prior to dialog assignment.
void	processResponse(SIPResponse transactionResponse, MessageChannel sourceChannel, SIPDialog dialog) Process a new response message through this transaction.
void	sendMessage(SIPMessage messageToSend) Process the message through the transaction and sends it to the SIP peer.
void	sendRequest() Sends the Request which created this ClientTransaction.
void	setDialog(SIPDialog sipDialog, String dialogId) set the dialog object.
void	setNextHop(Hop hop) Set the next hop ( if it has already been computed).
void	setNotifyOnRetransmit(boolean notifyOnRetransmit) Set this flag if you want your Listener to get Timeout.RETRANSMIT notifications each time a retransmission occurs.
void	setResponseInterface(ServerResponseInterface newRespondTo) Sets the real ResponseInterface this transaction encapsulates.
void	setState(int newState) Changes the state of this transaction.
void	setViaHost(String host) Set the port of the recipient.
void	setViaPort(int port) Set the port of the recipient.
void	startTransactionTimer() Start the timer task.
void	stopExpiresTimer() Stop the ExPIRES timer if it is running.
void	terminate() Terminate this transaction and immediately release all stack resources associated with it.

Methods inherited from class android.gov.nist.javax.sip.stack.SIPTransactionImpl

acquireSem, addEventListener, cancelMaxTxLifeTimeTimer, close, disableRetransmissionTimer, disableTimeoutTimer, doesCancelMatchTransaction, enableRetransmissionTimer, enableRetransmissionTimer, enableTimeoutTimer, extractCertIdentities, fireTimer, getApplicationData, getAuditTag, getBaseTimerInterval, getBranch, getBranchId, getCipherSuite, getCSeq, getForkId, getHost, getInternalState, getKey, getLastResponse, getLocalCertificates, getMergeId, getMessageChannel, getMessageProcessor, getMethod, getOriginalRequest, getPeerAddress, getPeerCertificates, getPeerInetAddress, getPeerPacketSourceAddress, getPeerPacketSourcePort, getPeerPort, getPeerProtocol, getPort, getRequest, getResponse, getRetransmitTimer, getSipProvider, getSIPStack, getState, getT2, getT4, getTimerD, getTimerI, getTimerK, getTimerT2, getTimerT4, getTransactionId, getTransport, getViaHeader, hashCode, isByeTransaction, isCancelTransaction, isDialogCreatingTransaction, isInviteTransaction, isReleaseReferences, isReliable, isSecure, isServerTransaction, isTerminated, isTransactionMapped, passToListener, raiseErrorEvent, raiseIOExceptionEvent, releaseSem, removeEventListener, scheduleMaxTxLifeTimeTimer, semRelease, sendMessage, setApplicationData, setAuditTag, setBranch, setCollectionTime, setEncapsulatedChannel, setForkId, setOriginalRequest, setPassToListener, setReleaseReferences, setRetransmitTimer, setTimerD, setTimerT2, setTimerT4, setTransactionMapped, testAndSetTransactionTerminatedEvent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface android.gov.nist.javax.sip.ClientTransactionExt

isSecure

Methods inherited from interface android.gov.nist.javax.sip.stack.SIPTransaction

acquireSem, addEventListener, cancelMaxTxLifeTimeTimer, close, disableRetransmissionTimer, disableTimeoutTimer, doesCancelMatchTransaction, extractCertIdentities, fireTimer, getApplicationData, getAuditTag, getBaseTimerInterval, getBranch, getBranchId, getCipherSuite, getCSeq, getForkId, getHost, getInternalState, getKey, getLastResponse, getLocalCertificates, getMergeId, getMessageChannel, getMessageProcessor, getMethod, getOriginalRequest, getPeerAddress, getPeerCertificates, getPeerPacketSourceAddress, getPeerPacketSourcePort, getPeerPort, getPeerProtocol, getPort, getRequest, getResponse, getRetransmitTimer, getSipProvider, getSIPStack, getState, getT2, getT4, getTimerD, getTimerI, getTimerK, getTimerT2, getTimerT4, getTransactionId, getTransport, getViaHeader, hashCode, isByeTransaction, isCancelTransaction, isDialogCreatingTransaction, isInviteTransaction, isReleaseReferences, isReliable, isSecure, isServerTransaction, isTerminated, isTransactionMapped, passToListener, raiseErrorEvent, raiseIOExceptionEvent, releaseSem, removeEventListener, scheduleMaxTxLifeTimeTimer, semRelease, setApplicationData, setAuditTag, setBranch, setCollectionTime, setEncapsulatedChannel, setForkId, setOriginalRequest, setPassToListener, setReleaseReferences, setRetransmitTimer, setTimerD, setTimerT2, setTimerT4, setTransactionMapped, testAndSetTransactionTerminatedEvent

Constructor Detail

SIPClientTransactionImpl

protected SIPClientTransactionImpl(SIPTransactionStack newSIPStack,
                        MessageChannel newChannelToUse)

Creates a new client transaction.

Parameters:

newSIPStack - Transaction stack this transaction belongs to.

newChannelToUse - Channel to encapsulate.

Method Detail

setResponseInterface

public void setResponseInterface(ServerResponseInterface newRespondTo)

Description copied from interface: SIPClientTransaction

Sets the real ResponseInterface this transaction encapsulates.

Specified by:

setResponseInterface in interface SIPClientTransaction

Parameters:

newRespondTo - ResponseInterface to send messages to.

See Also:

SIPClientTransaction.setResponseInterface(android.gov.nist.javax.sip.stack.ServerResponseInterface)

getRequestChannel

public MessageChannel getRequestChannel()

Description copied from interface: SIPClientTransaction

Returns this transaction.

Specified by:

getRequestChannel in interface SIPClientTransaction

See Also:

SIPClientTransaction.getRequestChannel()

isMessagePartOfTransaction

public boolean isMessagePartOfTransaction(SIPMessage messageToTest)

Description copied from interface: SIPTransaction

Tests a message to see if it is part of this transaction.

Specified by:

isMessagePartOfTransaction in interface SIPClientTransaction

Specified by:

isMessagePartOfTransaction in interface SIPTransaction

Specified by:

isMessagePartOfTransaction in class SIPTransactionImpl

Parameters:

messageToTest - Message to check if it is part of this transaction.

Returns:

True if the message is part of this transaction, false if not.

See Also:

SIPClientTransaction.isMessagePartOfTransaction(android.gov.nist.javax.sip.message.SIPMessage)

sendMessage

public void sendMessage(SIPMessage messageToSend)
                 throws IOException

Description copied from interface: SIPTransaction

Process the message through the transaction and sends it to the SIP peer.

Specified by:

sendMessage in interface SIPClientTransaction

Specified by:

sendMessage in interface SIPTransaction

Overrides:

sendMessage in class SIPTransactionImpl

Parameters:

messageToSend - Message to send to the SIP peer.

Throws:

IOException

See Also:

SIPClientTransaction.sendMessage(android.gov.nist.javax.sip.message.SIPMessage)

processResponse

public void processResponse(SIPResponse transactionResponse,
                   MessageChannel sourceChannel,
                   SIPDialog dialog)

Description copied from interface: SIPClientTransaction

Process a new response message through this transaction. If necessary, this message will also be passed onto the TU.

Specified by:

processResponse in interface ServerResponseInterface

Specified by:

processResponse in interface SIPClientTransaction

Parameters:

transactionResponse - Response to process.

sourceChannel - Channel that received this message.

dialog - -- dialog for this response

See Also:

SIPClientTransaction.processResponse(android.gov.nist.javax.sip.message.SIPResponse, android.gov.nist.javax.sip.stack.MessageChannel, android.gov.nist.javax.sip.stack.SIPDialog)

sendRequest

public void sendRequest()
                 throws SipException

Description copied from interface: ClientTransaction

Sends the Request which created this ClientTransaction. When an application wishes to send a Request message, it creates a Request from the MessageFactory and then creates a new ClientTransaction from SipProvider.getNewClientTransaction(Request). Calling this method on the ClientTransaction sends the Request onto the network. The Request message gets sent via the ListeningPoint information of the SipProvider that is associated to this ClientTransaction.

This method assumes that the Request is sent out of Dialog. It uses the Router to determine the next hop. If the Router returns a empty iterator, and a Dialog is associated with the outgoing request of the Transaction then the Dialog route set is used to send the outgoing request.

This method implies that the application is functioning as either a UAC or a stateful proxy, hence the underlying implementation acts statefully.

Specified by:

sendRequest in interface SIPClientTransaction

Specified by:

sendRequest in interface ClientTransaction

Throws:

SipException - if the SipProvider cannot send the Request for any reason.

See Also:

SIPClientTransaction.sendRequest()

fireRetransmissionTimer

public void fireRetransmissionTimer()

Called by the transaction stack when a retransmission timer fires.

Specified by:

fireRetransmissionTimer in interface SIPTransaction

fireTimeoutTimer

public void fireTimeoutTimer()

Called by the transaction stack when a timeout timer fires.

Specified by:

fireTimeoutTimer in interface SIPTransaction

createCancel

public Request createCancel()
                     throws SipException

Description copied from interface: ClientTransaction

Creates a new Cancel message from the Request associated with this client transaction. The CANCEL request, is used to cancel the previous request sent by this client transaction. Specifically, it asks the UAS to cease processing the request and to generate an error response to that request. A CANCEL request constitutes its own transaction, but also references the transaction to be cancelled. CANCEL has no effect on a request to which a UAS has already given a final response.

Note that both the transaction corresponding to the original request and the CANCEL transaction will complete independently. However, a UAC canceling a request cannot rely on receiving a 487 (Request Terminated) response for the original request, as an RFC 2543 compliant UAS will not generate such a response. Therefore if there is no final response for the original request the application will receieve a TimeoutEvent with Timeout.TRANSACTION and the client should then consider the original transaction cancelled.

• UAC - A UAC should not send a CANCEL request to any request explicitly supported by this specification other than INVITE request. The reason being requests other than INVITE are responded to immediately and sending a CANCEL for a non-INVITE request would always create a race condition. CANCELs are useful as a UAC can not send a BYE request on a dialog until receipt of 2xx final response to the INVITE request. The CANCEL attempts to force a non-2xx response to the INVITE, therefore if a UAC wishes to give up on its call attempt entirely it can send a CANCEL.
• Stateful proxies - A stateful proxy may generate CANCEL requests for:
  • INVITE Requests - A CANCEL can be sent on pending INVITE client transactions based on the period specified in the INVITE's Expires header field elapsing. However, this is generally unnecessary since the endpoints involved will take care of signaling the end of the transaction.
  • Other Requests - An implementation of this specification does not need to support CANCELing non-INVITE transactions.

Specified by:

createCancel in interface SIPClientTransaction

Specified by:

createCancel in interface ClientTransaction

Returns:

the new cancel Request specific to the Request of this client transaction.

Throws:

SipException - if this method is called to cancel a request that can't be cancelled i.e. ACK.

See Also:

SIPClientTransaction.createCancel()

createAck

public Request createAck()
                  throws SipException

Description copied from interface: ClientTransaction

Creates a new Ack message from the Request associated with this client transaction. This ACK can be used to acknowledge the 2xx response to the request sent by this transaction.

Specified by:

createAck in interface SIPClientTransaction

Specified by:

createAck in interface ClientTransaction

Returns:

the new ACK Request specific to the Request of this client transaction.

Throws:

SipException - if this method is called before a final response is received for the transaction.

See Also:

SIPClientTransaction.createAck()

setViaPort

public void setViaPort(int port)

Description copied from interface: SIPClientTransaction

Set the port of the recipient.

Specified by:

setViaPort in interface SIPClientTransaction

See Also:

SIPClientTransaction.setViaPort(int)

setViaHost

public void setViaHost(String host)

Description copied from interface: SIPClientTransaction

Set the port of the recipient.

Specified by:

setViaHost in interface SIPClientTransaction

See Also:

SIPClientTransaction.setViaHost(java.lang.String)

getViaPort

public int getViaPort()

Description copied from interface: SIPTransaction

Get the port to assign for the via header of an outgoing message.

Specified by:

getViaPort in interface SIPClientTransaction

Specified by:

getViaPort in interface SIPTransaction

Overrides:

getViaPort in class SIPTransactionImpl

See Also:

SIPClientTransaction.getViaPort()

getViaHost

public String getViaHost()

Description copied from interface: SIPTransaction

Get the host to assign for an outgoing Request via header.

Specified by:

getViaHost in interface SIPClientTransaction

Specified by:

getViaHost in interface SIPTransaction

Overrides:

getViaHost in class SIPTransactionImpl

See Also:

SIPClientTransaction.getViaHost()

getOutgoingViaHeader

public Via getOutgoingViaHeader()

Description copied from interface: SIPClientTransaction

get the via header for an outgoing request.

Specified by:

getOutgoingViaHeader in interface SIPClientTransaction

See Also:

SIPClientTransaction.getOutgoingViaHeader()

clearState

public void clearState()

Description copied from interface: SIPClientTransaction

This is called by the stack after a non-invite client transaction goes to completed state.

Specified by:

clearState in interface SIPClientTransaction

See Also:

SIPClientTransaction.clearState()

setState

public void setState(int newState)

Description copied from interface: SIPTransaction

Changes the state of this transaction.

Specified by:

setState in interface SIPClientTransaction

Specified by:

setState in interface SIPTransaction

Overrides:

setState in class SIPTransactionImpl

Parameters:

newState - New state of this transaction.

See Also:

SIPClientTransaction.setState(int)

startTransactionTimer

public void startTransactionTimer()

Start the timer task.

Specified by:

startTransactionTimer in interface SIPTransaction

terminate

public void terminate()

Description copied from interface: Transaction

Terminate this transaction and immediately release all stack resources associated with it. When a transaction is terminated using this method, a transaction terminated event is sent to the listener. If the transaction is already associated with a dialog, it cannot be terminated using this method. Instead, the dialog should be deleted to remove the transaction.

Specified by:

terminate in interface SIPClientTransaction

Specified by:

terminate in interface Transaction

See Also:

SIPClientTransaction.terminate()

stopExpiresTimer

public void stopExpiresTimer()

Description copied from interface: SIPClientTransaction

Stop the ExPIRES timer if it is running.

Specified by:

stopExpiresTimer in interface SIPClientTransaction

See Also:

SIPClientTransaction.stopExpiresTimer()

checkFromTag

public boolean checkFromTag(SIPResponse sipResponse)

Description copied from interface: SIPClientTransaction

Check if the From tag of the response matches the from tag of the original message. A Response with a tag mismatch should be dropped if a Dialog has been created for the original request.

Specified by:

checkFromTag in interface SIPClientTransaction

Parameters:

sipResponse - the response to check.

Returns:

true if the check passes.

See Also:

SIPClientTransaction.checkFromTag(android.gov.nist.javax.sip.message.SIPResponse)

processResponse

public void processResponse(SIPResponse sipResponse,
                   MessageChannel incomingChannel)

Description copied from interface: ServerResponseInterface

This method is called prior to dialog assignment.

Specified by:

processResponse in interface ServerResponseInterface

Specified by:

processResponse in interface SIPClientTransaction

See Also:

SIPClientTransaction.processResponse(android.gov.nist.javax.sip.message.SIPResponse, android.gov.nist.javax.sip.stack.MessageChannel)

getDialog

public Dialog getDialog()

Description copied from interface: SIPTransaction

Gets the dialog object of this Transaction object. This object returns null if no dialog exists. A dialog only exists for a transaction when a session is setup between a User Agent Client and a User Agent Server, either by a 1xx Provisional Response for an early dialog or a 200OK Response for a committed dialog.

Specified by:

getDialog in interface SIPClientTransaction

Specified by:

getDialog in interface SIPTransaction

Specified by:

getDialog in interface Transaction

Specified by:

getDialog in class SIPTransactionImpl

Returns:

the Dialog Object of this Transaction object.

See Also:

SIPClientTransaction.getDialog()

getDialog

public SIPDialog getDialog(String dialogId)

Specified by:

getDialog in interface SIPClientTransaction

See Also:

SIPClientTransaction.getDialog(java.lang.String)

setDialog

public void setDialog(SIPDialog sipDialog,
             String dialogId)

Description copied from interface: SIPTransaction

set the dialog object.

Specified by:

setDialog in interface SIPClientTransaction

Specified by:

setDialog in interface SIPTransaction

Specified by:

setDialog in class SIPTransactionImpl

Parameters:

sipDialog - -- the dialog to set.

dialogId - -- the dialog id ot associate with the dialog.s

See Also:

SIPClientTransaction.setDialog(android.gov.nist.javax.sip.stack.SIPDialog, java.lang.String)

getDefaultDialog

public SIPDialog getDefaultDialog()

Description copied from interface: ClientTransactionExt

Get the default dialog that was originally assigned to the client transaction. This will differ from the dialog that is assigned to the transaction when a forked response comes in. This method is useful for UACs that have to deal with forked responses.

Specified by:

getDefaultDialog in interface ClientTransactionExt

Specified by:

getDefaultDialog in interface SIPClientTransaction

See Also:

SIPClientTransaction.getDefaultDialog()

setNextHop

public void setNextHop(Hop hop)

Description copied from interface: SIPClientTransaction

Set the next hop ( if it has already been computed).

Specified by:

setNextHop in interface SIPClientTransaction

Parameters:

hop - -- the hop that has been previously computed.

See Also:

SIPClientTransaction.setNextHop(android.javax.sip.address.Hop)

getNextHop

public Hop getNextHop()

Description copied from interface: SIPClientTransaction

Reeturn the previously computed next hop (avoid computing it twice).

Specified by:

getNextHop in interface ClientTransactionExt

Specified by:

getNextHop in interface SIPClientTransaction

Returns:

-- next hop previously computed.

See Also:

SIPClientTransaction.getNextHop()

setNotifyOnRetransmit

public void setNotifyOnRetransmit(boolean notifyOnRetransmit)

Description copied from interface: SIPClientTransaction

Set this flag if you want your Listener to get Timeout.RETRANSMIT notifications each time a retransmission occurs.

Specified by:

setNotifyOnRetransmit in interface ClientTransactionExt

Specified by:

setNotifyOnRetransmit in interface SIPClientTransaction

Parameters:

notifyOnRetransmit - the notifyOnRetransmit to set

See Also:

SIPClientTransaction.setNotifyOnRetransmit(boolean)

isNotifyOnRetransmit

public boolean isNotifyOnRetransmit()

Specified by:

isNotifyOnRetransmit in interface SIPClientTransaction

Returns:

the notifyOnRetransmit

See Also:

SIPClientTransaction.isNotifyOnRetransmit()

alertIfStillInCallingStateBy

public void alertIfStillInCallingStateBy(int count)

Description copied from interface: ClientTransactionExt

Send a transaction timeout event to the application if Tx is still in Calling state in the given time period ( in base timer interval count ) after sending request. The stack will start a timer and alert the application if the client transaction does not transition out of the Trying state by the given interval. This is a "one shot" alert.

Specified by:

alertIfStillInCallingStateBy in interface ClientTransactionExt

Specified by:

alertIfStillInCallingStateBy in interface SIPClientTransaction

Parameters:

count - -- the number of base timer intervals after which an alert is issued.

See Also:

SIPClientTransaction.alertIfStillInCallingStateBy(int)

cleanUpOnTimer

protected void cleanUpOnTimer()

cleanUp

public void cleanUp()

Specified by:

cleanUp in interface SIPClientTransaction

Specified by:

cleanUp in interface SIPTransaction

Specified by:

cleanUp in class SIPTransactionImpl

See Also:

SIPClientTransaction.cleanUp()

cleanUpOnTerminated

protected void cleanUpOnTerminated()

getOriginalRequestFromTag

public String getOriginalRequestFromTag()

Specified by:

getOriginalRequestFromTag in interface SIPClientTransaction

Returns:

the originalRequestFromTag

See Also:

SIPClientTransaction.getOriginalRequestFromTag()

getOriginalRequestCallId

public String getOriginalRequestCallId()

Specified by:

getOriginalRequestCallId in interface SIPClientTransaction

Returns:

the originalRequestFromTag

See Also:

SIPClientTransaction.getOriginalRequestCallId()

getOriginalRequestEvent

public Event getOriginalRequestEvent()

Specified by:

getOriginalRequestEvent in interface SIPClientTransaction

Returns:

the originalRequestFromTag

See Also:

SIPClientTransaction.getOriginalRequestEvent()

getOriginalRequestContact

public Contact getOriginalRequestContact()

Specified by:

getOriginalRequestContact in interface SIPClientTransaction

Returns:

the originalRequestFromTag

See Also:

SIPClientTransaction.getOriginalRequestContact()

getOriginalRequestScheme

public String getOriginalRequestScheme()

Specified by:

getOriginalRequestScheme in interface SIPClientTransaction

Returns:

the originalRequestFromTag

See Also:

SIPClientTransaction.getOriginalRequestScheme()