Transaction

java.lang.Object
- org.mjsip.sip.transaction.Transaction

All Implemented Interfaces:

SipProviderListener, TimerListener

Direct Known Subclasses:

AckTransactionClient, AckTransactionServer, TransactionClient, TransactionServer
```
public abstract class Transaction
extends java.lang.Object
implements SipProviderListener, TimerListener
```
A generic SIP transaction (Invite, Non-Invite, Ack). It is hinerited by the following classes: ClientTransaction, ServerTransaction, InviteClientTransaction, InviteServerTransaction, AckTransactionClient, and AckTransactionServer.
The changes of the internal status and the received messages are fired to the corrsponding transaction listener.

Field Summary

Fields
Modifier and Type	Field and Description
`protected static int`	`STATE_COMPLETED` State Completed - When sent/received a final response.
`protected static int`	`STATE_CONFIRMED` State Confirmed (used only by invite server transactions) - When received an ACK request.
`protected static int`	`STATE_IDLE` State Waiting (used only by server transactions) - When transaction is just created.
`protected static int`	`STATE_PROCEEDING` State Proceeding - When sent/received a provisional response.
`protected static int`	`STATE_TERMINATED` State Terminated - When the transaction is terminated.
`protected static int`	`STATE_TRYING` State Trying - When sent/received the request.
`protected static int`	`STATE_WAITING` State Waiting (used only by server transactions) - When the server transaction starts listening.
`protected static int`	`transaction_counter` Transactions counter

Constructor Summary

Constructors
Modifier Constructor and Description

protected Transaction(SipProvider sip_provider)
Costructs a new Transaction

Constructors
Modifier	Constructor and Description
`protected`	`Transaction(SipProvider sip_provider)` Costructs a new Transaction

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`changeStatus(int newstatus)` Changes the internal status
`SipMessage`	`getRequestMessage()` Gets the Transaction request message
`SipProvider`	`getSipProvider()` Gets the SipProvider of this Transaction.
`protected java.lang.String`	`getStatus()` Gets the current transaction state.
`protected static java.lang.String`	`getStatus(int st)` Gets the transaction state.
`TransactionId`	`getTransactionId()` Gets the transaction identifier
`java.lang.String`	`getTransactionMethod()` Gets the Transaction method
`ConnectionId`	`getTransportConnId()` Gets the transaction connection id
`boolean`	`isCompleted()` Whether the transaction is in COMPLETED state, i.e. it has sent/received a final response.
`boolean`	`isProceeding()` Whether the transaction is in PROCEEDING state, i.e. it has sent/received a provisional response.
`boolean`	`isTerminated()` Whether the transaction is in TERMINATED state, i.e. it is terminated.
`boolean`	`isTrying()` Whether the transaction is in TRYING state, i.e. it has sent/received the request.
`protected void`	`log(LogLevel level, java.lang.Exception e)` Adds the Exception to the log file.
`protected void`	`log(LogLevel level, java.lang.String str)` Adds a new string to the default log.
`void`	`onReceivedMessage(SipProvider provider, SipMessage msg)` Method derived from interface SipListener.
`void`	`onTimeout(Timer to)` Method derived from interface TimerListener.
`protected boolean`	`statusIs(int st)` Whether the internal status is equal to st
`abstract void`	`terminate()` Terminates the transaction.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - transaction_counter
```
protected static int transaction_counter
```
    Transactions counter
  - STATE_IDLE
```
protected static final int STATE_IDLE
```
    State Waiting (used only by server transactions) - When transaction is just created.
    
    See Also:
    
    Constant Field Values
  - STATE_WAITING
```
protected static final int STATE_WAITING
```
    State Waiting (used only by server transactions) - When the server transaction starts listening.
    
    See Also:
    
    Constant Field Values
  - STATE_TRYING
```
protected static final int STATE_TRYING
```
    State Trying - When sent/received the request.
    
    See Also:
    
    Constant Field Values
  - STATE_PROCEEDING
```
protected static final int STATE_PROCEEDING
```
    State Proceeding - When sent/received a provisional response.
    
    See Also:
    
    Constant Field Values
  - STATE_COMPLETED
```
protected static final int STATE_COMPLETED
```
    State Completed - When sent/received a final response.
    
    See Also:
    
    Constant Field Values
  - STATE_CONFIRMED
```
protected static final int STATE_CONFIRMED
```
    State Confirmed (used only by invite server transactions) - When received an ACK request.
    
    See Also:
    
    Constant Field Values
  - STATE_TERMINATED
```
protected static final int STATE_TERMINATED
```
    State Terminated - When the transaction is terminated.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Transaction
```
protected Transaction(SipProvider sip_provider)
```
    Costructs a new Transaction
- Method Detail
  - getStatus
```
protected static java.lang.String getStatus(int st)
```
    Gets the transaction state.
  - changeStatus
```
protected void changeStatus(int newstatus)
```
    Changes the internal status
  - statusIs
```
protected boolean statusIs(int st)
```
    Whether the internal status is equal to st
  - getStatus
```
protected java.lang.String getStatus()
```
    Gets the current transaction state.
  - isTrying
```
public boolean isTrying()
```
    Whether the transaction is in TRYING state, i.e. it has sent/received the request.
  - isProceeding
```
public boolean isProceeding()
```
    Whether the transaction is in PROCEEDING state, i.e. it has sent/received a provisional response.
  - isCompleted
```
public boolean isCompleted()
```
    Whether the transaction is in COMPLETED state, i.e. it has sent/received a final response.
  - isTerminated
```
public boolean isTerminated()
```
    Whether the transaction is in TERMINATED state, i.e. it is terminated.
  - getSipProvider
```
public SipProvider getSipProvider()
```
    Gets the SipProvider of this Transaction.
  - getRequestMessage
```
public SipMessage getRequestMessage()
```
    Gets the Transaction request message
  - getTransactionMethod
```
public java.lang.String getTransactionMethod()
```
    Gets the Transaction method
  - getTransactionId
```
public TransactionId getTransactionId()
```
    Gets the transaction identifier
  - getTransportConnId
```
public ConnectionId getTransportConnId()
```
    Gets the transaction connection id
  - onReceivedMessage
```
public void onReceivedMessage(SipProvider provider,
                              SipMessage msg)
```
    Method derived from interface SipListener. It's fired from the SipProvider when a new message is catch for to the present ServerTransaction.
    
    Specified by:
    
    onReceivedMessage in interface SipProviderListener
  - onTimeout
```
public void onTimeout(Timer to)
```
    Method derived from interface TimerListener. It's fired from an active Timer.
    
    Specified by:
    
    onTimeout in interface TimerListener
    
    Parameters:
    
    to - the timer
  - terminate
```
public abstract void terminate()
```
    Terminates the transaction.
  - log
```
protected void log(LogLevel level,
                   java.lang.String str)
```
    Adds a new string to the default log.
  - log
```
protected void log(LogLevel level,
                   java.lang.Exception e)
```
    Adds the Exception to the log file.

Class Transaction

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

transaction_counter

STATE_IDLE

STATE_WAITING

STATE_TRYING

STATE_PROCEEDING

STATE_COMPLETED

STATE_CONFIRMED

STATE_TERMINATED

Constructor Detail

Transaction

Method Detail

getStatus

changeStatus

statusIs

getStatus

isTrying

isProceeding

isCompleted

isTerminated

getSipProvider

getRequestMessage

getTransactionMethod

getTransactionId

getTransportConnId

onReceivedMessage

onTimeout

terminate

log

log