gov.nist.javax.sip

Interface ClientTransactionExt

All Superinterfaces:

ClientTransaction, Serializable, Transaction, TransactionExt

All Known Subinterfaces:

SIPClientTransaction

All Known Implementing Classes:

SIPClientTransactionImpl

public interface ClientTransactionExt
extends ClientTransaction, TransactionExt

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.
Dialog	getDefaultDialog() Get the default dialog that was originally assigned to the client transaction.
Hop	getNextHop() Get the next hop that was computed by the routing layer.
boolean	isSecure() Return true if this Ctx is a secure transport.
void	setNotifyOnRetransmit(boolean flag) Notify on retransmission from the client transaction side.

Methods inherited from interface javax.sip.ClientTransaction

createAck, createCancel, sendRequest

Methods inherited from interface gov.nist.javax.sip.TransactionExt

extractCertIdentities, getCipherSuite, getHost, getLocalCertificates, getPeerAddress, getPeerCertificates, getPeerPort, getPort, getReleaseReferencesStrategy, getSipProvider, getTimerD, getTimerT2, getTimerT4, getTransport, setReleaseReferencesStrategy, setTimerD, setTimerT2, setTimerT4

Methods inherited from interface javax.sip.Transaction

getApplicationData, getBranchId, getDialog, getRequest, getRetransmitTimer, getState, setApplicationData, setRetransmitTimer, terminate

Method Detail

setNotifyOnRetransmit

void setNotifyOnRetransmit(boolean flag)

Notify on retransmission from the client transaction side. The listener will get a notification on retransmission when this flag is set. When set the client transaction listener will get a Timeout.RETRANSMIT event on each retransmission.

Parameters:

flag - -- the flag that indicates whether or not notification is desired.

Since:

2.0

alertIfStillInCallingStateBy

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. 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.

Parameters:

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

Since:

2.0

getNextHop

Hop getNextHop()

Get the next hop that was computed by the routing layer. when it sent out the request. This allows you to route requests to the SAME destination if required ( for example if you get an authentication challenge ).

Since:

2.0

isSecure

boolean isSecure()

Return true if this Ctx is a secure transport.

Since:

2.0

getDefaultDialog

Dialog getDefaultDialog()

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.

Since:

2.0