JSIP API v1.2
November 2006

javax.sip
Class DialogTerminatedEvent

java.lang.Object
  extended by java.util.EventObject
      extended by javax.sip.DialogTerminatedEvent
All Implemented Interfaces:
java.io.Serializable

public class DialogTerminatedEvent
extends java.util.EventObject

DialogTerminatedEvent is delivered to the Listener when the dialog transitions to the terminated state. An implementation is expected to deliver this event to the listener when it discards all internal book keeping records for a given dialog, allowing the Listener to unmap its own data structures.

Since:
v1.2
Author:
BEA Systems, NIST
See Also:
Serialized Form

Field Summary
 
Fields inherited from class java.util.EventObject
source
 
Constructor Summary
DialogTerminatedEvent(java.lang.Object source, Dialog dialog)
          Constructs a DialogTerminatedEvent to indicate a dialog timeout.
 
Method Summary
 Dialog getDialog()
          Gets the Dialog associated with the event.
 
Methods inherited from class java.util.EventObject
getSource, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

DialogTerminatedEvent

public DialogTerminatedEvent(java.lang.Object source,
                             Dialog dialog)
Constructs a DialogTerminatedEvent to indicate a dialog timeout.

Parameters:
source - - the source of TimeoutEvent.
dialog - - the dialog that timed out.
Method Detail

getDialog

public Dialog getDialog()
Gets the Dialog associated with the event. This enables application developers to access the dialog associated to this event.

Returns:
the dialog associated with the response event or null if there is no dialog.
Since:
v1.2

JSIP API v1.2
November 2006

If you have any comments, please mail them to JAIN-SIP-INTEREST@java.sun.com after subscribing at http://archives.java.sun.com
Copyright - 2006 BEA Systems and Sun Microsystems