NIST-SIP: The Reference Implementation for JAIN-SIP 1.2

gov.nist.javax.sip
Class DialogTimeoutEvent

java.lang.Object
  extended by java.util.EventObject
      extended by gov.nist.javax.sip.DialogTimeoutEvent
All Implemented Interfaces:
Serializable

public class DialogTimeoutEvent
extends EventObject

DialogAckTimeoutEvent is delivered to the Listener when the dialog does not receive or send an ACK.

Since:
v2.0
Author:
jean deruelle
See Also:
Serialized Form

Nested Class Summary
static class DialogTimeoutEvent.Reason
           
 
Constructor Summary
DialogTimeoutEvent(Object source, Dialog dialog, DialogTimeoutEvent.Reason reason)
          Constructs a DialogTerminatedEvent to indicate a dialog timeout.
 
Method Summary
 ClientTransaction getClientTransaction()
          Get the re-INVITE client transaction that could not be sent.
 Dialog getDialog()
          Gets the Dialog associated with the event.
 DialogTimeoutEvent.Reason getReason()
          The reason for the Dialog Timeout Event being delivered to the application.
 void setClientTransaction(ClientTransaction clientTransaction)
          Set the re-INVITE client transaction.
 
Methods inherited from class java.util.EventObject
getSource, toString
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

DialogTimeoutEvent

public DialogTimeoutEvent(Object source,
                          Dialog dialog,
                          DialogTimeoutEvent.Reason reason)
Constructs a DialogTerminatedEvent to indicate a dialog timeout.

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

setClientTransaction

public void setClientTransaction(ClientTransaction clientTransaction)
Set the re-INVITE client transaction. This method will be used by Implementations (not applications).

Since:
v1.2

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

getReason

public DialogTimeoutEvent.Reason getReason()
The reason for the Dialog Timeout Event being delivered to the application.

Returns:
the reason for the timeout event.

getClientTransaction

public ClientTransaction getClientTransaction()
Get the re-INVITE client transaction that could not be sent.

Returns:
the re-INVITE client transaction that could not be sent.

NIST-SIP: The Reference Implementation for JAIN-SIP 1.2

A product of the NIST/ITL Advanced Networking Technologies Division.
See conditions of use.
Submit a bug report or feature request.