| java.lang.Object
 java.util.EventObject
javax.sip.TimeoutEvent
| TimeoutEvent | | public class TimeoutEvent extends EventObject (Code) | | 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:
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.
See Also: Timeout
author:
BEA Systems, NIST
version:
1.2 |
| TimeoutEvent | | public TimeoutEvent(Object source, ServerTransaction serverTransaction, Timeout timeout)(Code) | | Constructs a TimeoutEvent to indicate a server retransmission or transaction
timeout.
Parameters:
source - - the source of TimeoutEvent.
Parameters:
serverTransaction - - the server transaction that timed out.
Parameters:
timeout - - indicates if this is a retranmission or transaction timeout event. |
| TimeoutEvent | | public TimeoutEvent(Object source, ClientTransaction clientTransaction, Timeout timeout)(Code) | | Constructs a TimeoutEvent to indicate a client retransmission or transaction
timeout.
Parameters:
source - - source of TimeoutEvent.
Parameters:
clientTransaction - - the client transaction that timed out.
Parameters:
timeout - - indicates if this is a retranmission or transaction timeout event. |
| getClientTransaction | | public ClientTransaction getClientTransaction()(Code) | | Gets the client transaction associated with this TimeoutEvent.
client transaction associated with this TimeoutEvent, or null if this event is specific to a server transaction. |
| getServerTransaction | | public ServerTransaction getServerTransaction()(Code) | | Gets the server transaction associated with this TimeoutEvent.
server transaction associated with this TimeoutEvent, or null if this event is specific to a client transaction. |
| getTimeout | | public Timeout getTimeout()(Code) | | 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:
the event type of this TimeoutEvent |
| isServerTransaction | | public boolean isServerTransaction()(Code) | | Indicates if the transaction associated with this TimeoutEvent is a server
transaction.
returns true if a server transaction or false if a client transaction. |
|
|