javax.sip
Class TimeoutEvent

java.lang.Object
  java.util.EventObject
      javax.sip.TimeoutEvent

All Implemented Interfaces:

java.io.Serializable

public class TimeoutEvent
extends java.util.EventObject

This class represents an Timeout event that is passed from a SipProvider to its SipListener. A specific message may need retransmitted on a specific transaction numerous times before it is acknowledged by the receiver. If the message is not acknowledged after a specified period in the underlying implementation the transaction will expire, this occurs usually after seven retransmissions. The mechanism to alert an application that a message for a an underlying transaction needs retransmitted (i.e. 200OK) or an underlying transaction has expired is a Timeout Event.

A Timeout Event can be of two different types, namely:

• Timeout.RETRANSMIT
• Timeout.TRANSACTION

A TimeoutEvent contains the following information:

• source - the SipProvider that sent the TimeoutEvent.
• transaction - the transaction that this Timeout applies to.
• isServerTransaction - boolean indicating whether the transaction refers to a client or server transaction.
• timeout - indicates what type of Timeout occurred.

Author:

BEA Systems, NIST

See Also:

Timeout, Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

TimeoutEvent(java.lang.Object source, ClientTransaction clientTransaction, Timeout timeout)
Constructs a TimeoutEvent to indicate a client retransmission or transaction timeout.

TimeoutEvent(java.lang.Object source, ServerTransaction serverTransaction, Timeout timeout)
Constructs a TimeoutEvent to indicate a server retransmission or transaction timeout.

Method Summary

ClientTransaction	getClientTransaction() Gets the client transaction associated with this TimeoutEvent.
ServerTransaction	getServerTransaction() Gets the server transaction associated with this TimeoutEvent.
Timeout	getTimeout() Gets the event type of this TimeoutEvent.
boolean	isServerTransaction() Indicates if the transaction associated with this TimeoutEvent is a server transaction.

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

TimeoutEvent

public TimeoutEvent(java.lang.Object source,
                    ServerTransaction serverTransaction,
                    Timeout timeout)

Constructs a TimeoutEvent to indicate a server retransmission or transaction timeout.

Parameters:

source - - the source of TimeoutEvent.

serverTransaction - - the server transaction that timed out.

timeout - - indicates if this is a retranmission or transaction timeout event.

TimeoutEvent

public TimeoutEvent(java.lang.Object source,
                    ClientTransaction clientTransaction,
                    Timeout timeout)

Constructs a TimeoutEvent to indicate a client retransmission or transaction timeout.

Parameters:

source - - source of TimeoutEvent.

clientTransaction - - the client transaction that timed out.

timeout - - indicates if this is a retranmission or transaction timeout event.

Method Detail

getServerTransaction

public ServerTransaction getServerTransaction()

Gets the server transaction associated with this TimeoutEvent.

Returns:

server transaction associated with this TimeoutEvent, or null if this event is specific to a client transaction.

getClientTransaction

public ClientTransaction getClientTransaction()

Gets the client transaction associated with this TimeoutEvent.

Returns:

client transaction associated with this TimeoutEvent, or null if this event is specific to a server transaction.

isServerTransaction

public boolean isServerTransaction()

Indicates if the transaction associated with this TimeoutEvent is a server transaction.

Returns:

returns true if a server transaction or false if a client transaction.

getTimeout

public Timeout getTimeout()

Gets the event type of this TimeoutEvent. The event type can be used to determine if this Timeout Event is one of the following types:

• Timeout.TRANSACTION
• Timeout.RETRANSMIT

Returns:

the event type of this TimeoutEvent