TransactionHandler (Mobicents MGCP Impl 6.0.0.13 API)

Field Summary

Fields
Modifier and Type	Field and Description
`protected jain.protocol.ip.mgcp.JainMgcpCommandEvent`	`commandEvent` Used to hold parsed command event
`protected jain.protocol.ip.mgcp.message.parms.EndpointIdentifier`	`endpoint`
`static int`	`LONGTRAN_TIMER_TIMEOUT`
`static byte[]`	`MGCP_VERSION`
`static String`	`NEW_LINE`
`protected int`	`remoteTID` Transaction handle sent from application to the MGCP provider.
`protected jain.protocol.ip.mgcp.JainMgcpResponseEvent`	`responseEvent` Used to hold parsed response event *
`protected boolean`	`retransmision`
`static String`	`SDP_NEW_LINE`
`protected boolean`	`sent` Is this a transaction on a command sent or received?
`static String`	`SINGLE_CHAR_SPACE`
`protected Object`	`source`
`protected JainMgcpStackImpl`	`stack`
`static int`	`THIST_TIMER_TIMEOUT`
`protected static Timer`	`transactionHandlerTimer` Expiration timer

Constructor Summary

Constructors
Constructor and Description
`TransactionHandler(JainMgcpStackImpl stack)` Creates a new instance of TransactionHandle Used by provider to prepare origination transaction for sending command message from an application to the stack.
`TransactionHandler(JainMgcpStackImpl stack, InetAddress remoteAddress, int port)` Creates a new instance of TransactionHandle.

Method Summary

Methods
Modifier and Type	Method and Description
`abstract jain.protocol.ip.mgcp.JainMgcpCommandEvent`	`decodeCommand(byte[] data, SplitDetails[] message)` Decodes MGCP command message into jain mgcp command event object.
`abstract jain.protocol.ip.mgcp.JainMgcpResponseEvent`	`decodeResponse(byte[] data, SplitDetails[] msg, Integer txID, jain.protocol.ip.mgcp.message.parms.ReturnCode returnCode)` Decodes MGCP response message into jain mgcp response event object.
`abstract int`	`encode(jain.protocol.ip.mgcp.JainMgcpCommandEvent event, byte[] array)` Encodes command event object into MGCP command message.
`abstract int`	`encode(jain.protocol.ip.mgcp.JainMgcpResponseEvent event, byte[] array)` Encodes response event object into MGCP response message.
`String`	`getEndpointId()`
`int`	`getLocalTID()` Returns the transaction handle sent from MGCP provider to listener.
`protected Object`	`getObjectSource(int tid)` constructs the object source for a command
`abstract jain.protocol.ip.mgcp.JainMgcpResponseEvent`	`getProvisionalResponse()`
`int`	`getRemoteTID()` Returns the transaction handle sent from application to the MGCP provider.
`boolean`	`isCommand()`
`void`	`markRetransmision()`
`void`	`receiveRequest(jain.protocol.ip.mgcp.message.parms.EndpointIdentifier endpoint, byte[] data, SplitDetails[] msg, Integer remoteTID)`
`void`	`receiveResponse(byte[] data, SplitDetails[] msg, Integer txID, jain.protocol.ip.mgcp.message.parms.ReturnCode returnCode)` Used by stack for relaying received MGCP response messages to the application.
`protected void`	`release()` Release this transaction and frees all allocated resources.
`void`	`send()`
`protected void`	`sendProvisionalResponse()`
`void`	`setCommand(boolean isCommand)`
`void`	`setCommandEvent(jain.protocol.ip.mgcp.JainMgcpCommandEvent commandEvent)`
`void`	`setResponseEvent(jain.protocol.ip.mgcp.JainMgcpResponseEvent responseEvent)`

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

Field Detail

NEW_LINE
```
public static final String NEW_LINE
```
See Also:
Constant Field Values

SDP_NEW_LINE

public static final String SDP_NEW_LINE

See Also:: Constant Field Values

SINGLE_CHAR_SPACE

public static final String SINGLE_CHAR_SPACE

See Also:: Constant Field Values

MGCP_VERSION

public static final byte[] MGCP_VERSION

LONGTRAN_TIMER_TIMEOUT
```
public static final int LONGTRAN_TIMER_TIMEOUT
```
See Also:
Constant Field Values

THIST_TIMER_TIMEOUT
```
public static final int THIST_TIMER_TIMEOUT
```
See Also:
Constant Field Values

sent
```
protected boolean sent
```
Is this a transaction on a command sent or received?

remoteTID
```
protected int remoteTID
```
Transaction handle sent from application to the MGCP provider.

stack
```
protected JainMgcpStackImpl stack
```

commandEvent

protected jain.protocol.ip.mgcp.JainMgcpCommandEvent commandEvent

Used to hold parsed command event

responseEvent

protected jain.protocol.ip.mgcp.JainMgcpResponseEvent responseEvent

Used to hold parsed response event *

transactionHandlerTimer

protected static Timer transactionHandlerTimer

Expiration timer

retransmision
```
protected boolean retransmision
```

source
```
protected Object source
```

endpoint

protected jain.protocol.ip.mgcp.message.parms.EndpointIdentifier endpoint

Constructor Detail
- TransactionHandler
```
public TransactionHandler(JainMgcpStackImpl stack)
```
  Creates a new instance of TransactionHandle Used by provider to prepare origination transaction for sending command message from an application to the stack.
  
  Parameters:
  stack - the reference to the MGCP stack.
- TransactionHandler
```
public TransactionHandler(JainMgcpStackImpl stack,
                  InetAddress remoteAddress,
                  int port)
```
  Creates a new instance of TransactionHandle. Used by stack to prepare transaction for transmitting message from provider to the application.
  
  Parameters:
  stack - the reference to the MGCP stack.

Method Detail

release
```
protected void release()
```
Release this transaction and frees all allocated resources.

getRemoteTID
```
public int getRemoteTID()
```
Returns the transaction handle sent from application to the MGCP provider.

Returns:
the int value wich identifiers the transaction handle.

getLocalTID
```
public int getLocalTID()
```
Returns the transaction handle sent from MGCP provider to listener.

Returns:
the int value wich identifiers the transaction handle.

encode
```
public abstract int encode(jain.protocol.ip.mgcp.JainMgcpCommandEvent event,
         byte[] array)
```
Encodes command event object into MGCP command message. All descendant classes should implement this method with accordance of the command type.

Parameters:
event - the command event object.

Returns:
the encoded MGCP message.

encode
```
public abstract int encode(jain.protocol.ip.mgcp.JainMgcpResponseEvent event,
         byte[] array)
```
Encodes response event object into MGCP response message. All descendant classes should implement this method with accordance of the response type.

Parameters:
event - the response event object.

Returns:
the encoded MGCP message.

decodeCommand

public abstract jain.protocol.ip.mgcp.JainMgcpCommandEvent decodeCommand(byte[] data,
                                                       SplitDetails[] message)
                                                                  throws ParseException

Decodes MGCP command message into jain mgcp command event object. All descendant classes should implement this method with accordance of the command type.

Parameters:: MGCP - message
Returns:: jain mgcp command event object.
Throws:: ParseException

decodeResponse

public abstract jain.protocol.ip.mgcp.JainMgcpResponseEvent decodeResponse(byte[] data,
                                                         SplitDetails[] msg,
                                                         Integer txID,
                                                         jain.protocol.ip.mgcp.message.parms.ReturnCode returnCode)
                                                                    throws ParseException

Decodes MGCP response message into jain mgcp response event object. All descendant classes should implement this method with accordance of the command type.

Parameters:: MGCP - message
Returns:: jain mgcp response event object.
Throws:: ParseException

getProvisionalResponse

public abstract jain.protocol.ip.mgcp.JainMgcpResponseEvent getProvisionalResponse()

send
```
public void send()
```

sendProvisionalResponse

protected void sendProvisionalResponse()

getObjectSource
```
protected Object getObjectSource(int tid)
```
constructs the object source for a command

Parameters:
tid -

Returns:

isCommand
```
public boolean isCommand()
```

setCommand

public void setCommand(boolean isCommand)

setCommandEvent

public void setCommandEvent(jain.protocol.ip.mgcp.JainMgcpCommandEvent commandEvent)

setResponseEvent

public void setResponseEvent(jain.protocol.ip.mgcp.JainMgcpResponseEvent responseEvent)

markRetransmision
```
public void markRetransmision()
```

receiveRequest

public void receiveRequest(jain.protocol.ip.mgcp.message.parms.EndpointIdentifier endpoint,
                  byte[] data,
                  SplitDetails[] msg,
                  Integer remoteTID)

receiveResponse

public void receiveResponse(byte[] data,
                   SplitDetails[] msg,
                   Integer txID,
                   jain.protocol.ip.mgcp.message.parms.ReturnCode returnCode)

Used by stack for relaying received MGCP response messages to the application.

Parameters:: message - receive MGCP response message.

getEndpointId
```
public String getEndpointId()
```

Class TransactionHandler

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NEW_LINE

SDP_NEW_LINE

SINGLE_CHAR_SPACE

MGCP_VERSION

LONGTRAN_TIMER_TIMEOUT

THIST_TIMER_TIMEOUT

sent

remoteTID

stack

commandEvent

responseEvent

transactionHandlerTimer

retransmision

source

endpoint

Constructor Detail

TransactionHandler

TransactionHandler

Method Detail

release

getRemoteTID

getLocalTID

encode

encode

decodeCommand

decodeResponse

getProvisionalResponse

send

sendProvisionalResponse

getObjectSource

isCommand

setCommand

setCommandEvent

setResponseEvent

markRetransmision

receiveRequest

receiveResponse

getEndpointId