gov.nist.javax.sip

Interface DialogExt

All Superinterfaces:

Dialog, Serializable

All Known Implementing Classes:

SIPDialog

public interface DialogExt
extends Dialog

Extensions for Next specification revision. These interfaces will remain unchanged and be merged with the next revision of the spec.

Author:

mranga

Method Summary

Methods

Modifier and Type	Method and Description
void	disableSequenceNumberValidation() Turn off sequence number validation for this dialog.
Dialog	getOriginalDialog()
SipProvider	getSipProvider() Returns the SipProvider that was used for the first transaction in this Dialog
boolean	isForked() True if this dialog has been created following the forking of a previous dialog.
boolean	isReleaseReferences() retrieve the value of release references to know if the stack performs optimizations on cleanup to save on memory
void	setBackToBackUserAgent() Sets a flag that indicates that this Dialog is part of a BackToBackUserAgent.
void	setEarlyDialogTimeoutSeconds(int timeoutValue) Sets the early dialog timeout period.
void	setReleaseReferences(boolean releaseReferences) If set to true it will release all references that it no longer needs.

Methods inherited from interface javax.sip.Dialog

createAck, createPrack, createReliableProvisionalResponse, createRequest, delete, getApplicationData, getCallId, getDialogId, getFirstTransaction, getLocalParty, getLocalSeqNumber, getLocalSequenceNumber, getLocalTag, getRemoteParty, getRemoteSeqNumber, getRemoteSequenceNumber, getRemoteTag, getRemoteTarget, getRouteSet, getState, incrementLocalSequenceNumber, isSecure, isServer, sendAck, sendReliableProvisionalResponse, sendRequest, setApplicationData, terminateOnBye

Method Detail

getSipProvider

SipProvider getSipProvider()

Returns the SipProvider that was used for the first transaction in this Dialog

Returns:

SipProvider

Since:

2.0

setBackToBackUserAgent

void setBackToBackUserAgent()

Sets a flag that indicates that this Dialog is part of a BackToBackUserAgent. If this flag is set, INVITEs are not allowed to interleave and timed out ACK transmission results in a BYE being sent to the other side. Setting this flag instructs the stack to automatically handle dialog errors. Once this flag is set for a dialog, it cannot be changed. This flag can be set on a stack-wide basis, on a per-provider basis or on a per Dialog basis. This flag must only be set at the time of Dialog creation. If the flag is set after the first request or response is seen by the Dialog, the behavior of this flag is undefined.

Since:

2.0

disableSequenceNumberValidation

void disableSequenceNumberValidation()

Turn off sequence number validation for this dialog. This passes all requests to the application layer including those that arrive out of order. This is good for testing purposes. Validation is delegated to the application and the stack will not attempt to block requests arriving out of sequence from reaching the application. In particular, the validation of CSeq and the ACK retransmission recognition are delegated to the application. Your application will be responsible for error handling of these cases.

Since:

2.0

isReleaseReferences

boolean isReleaseReferences()

retrieve the value of release references to know if the stack performs optimizations on cleanup to save on memory

Returns:

release references value

Since:

2.0

setReleaseReferences

void setReleaseReferences(boolean releaseReferences)

If set to true it will release all references that it no longer needs. This will include the reference to the Request, Transactions, Any unused timers etc. This will significantly reduce memory consumption under high load

Parameters:

releaseReferences -

Since:

2.0

setEarlyDialogTimeoutSeconds

void setEarlyDialogTimeoutSeconds(int timeoutValue)

Sets the early dialog timeout period. Overrides the value set by the stack configuration property EARLY_DIALOG_TIMEOUT_SECONDS. A dialog may remain in early state indefinitely. UACs may kill a dialog in early state of periodic provisional responses are not seen for 3 minutes. This allows you to override the RFC specified value of 3 minutes hence allowing for fast fail over from unresponsive servers.

isForked

boolean isForked()

True if this dialog has been created following the forking of a previous dialog. This could happen by example if Alice would Invite a forking proxy whom would 180Ring Bob but finally 200Ok on Carol. The original Dialog known by Alice after Bob's ringing would be overriden by a new dialog bound to Carol. The original dialog can be retrieved using getOriginalDialog()

getOriginalDialog

Dialog getOriginalDialog()

Returns:

The original dialog.

See Also:

#isForked()}