com.pcbsys.nirvana.client.nTransactionAttributes Class Reference

This class is a container for the attributes necessary to create a Nirvana transaction More...

Public Member Functions

nAbstractChannel getChannel ()
 Gets the nirvana channel that will be associated with transactions created from this object More...
 
long getTimeout ()
 Retrieves the timeout value. More...
 
long getTTL ()
 Gets the TTL value that transactions created from this object will have More...
 
 nTransactionAttributes ()
 Default Constructor
 
 nTransactionAttributes (nAbstractChannel aChannel)
 Constructs an nTransactionAttributes object associated with the channel specified. More...
 
 nTransactionAttributes (nAbstractChannel aChannel, long aTimeToLive)
 Constructs an nTransactionAttributes object associated with the channel specified. More...
 
 nTransactionAttributes (nAbstractChannel aChannel, long aTimeToLive, long aTimeout)
 Constructs an nTransactionAttributes object associated with the channel specified. More...
 
void setChannel (nChannel aChannel)
 Sets the nirvana channel that will be associated with transactions created from this object More...
 
void setTimeout (long timeout)
 Sets the timeout value, as milliseconds, to use. More...
 
void setTTL (long aTimeToLive)
 Sets the TTL value that transactions created from this object will have More...
 

Detailed Description

This class is a container for the attributes necessary to create a Nirvana transaction

Constructor & Destructor Documentation

com.pcbsys.nirvana.client.nTransactionAttributes.nTransactionAttributes ( nAbstractChannel  aChannel)

Constructs an nTransactionAttributes object associated with the channel specified.

Parameters
aChannelThe nirvana channel associated with this transaction
Exceptions
nTransactionExceptionIf there is an error during the construction, check the message for more information
com.pcbsys.nirvana.client.nTransactionAttributes.nTransactionAttributes ( nAbstractChannel  aChannel,
long  aTimeToLive 
)

Constructs an nTransactionAttributes object associated with the channel specified.

Parameters
aChannelThe nirvana channel associated with this transaction
Exceptions
nTransactionExceptionIf there is an error during the construction, check the message for more information

Constructs an nTransactionAttributes object associated with the channel specified. Transactions created with this object will have the Time To Live (TTL) specified.

Parameters
aChannelThe nirvana channel associated with the transaction
aTimeToLiveThe Time To Live (TTL) value that the transaction will have
Exceptions
nTransactionExceptionIf there is an error during the construction, check the message for more information
com.pcbsys.nirvana.client.nTransactionAttributes.nTransactionAttributes ( nAbstractChannel  aChannel,
long  aTimeToLive,
long  aTimeout 
)

Constructs an nTransactionAttributes object associated with the channel specified.

Parameters
aChannelThe nirvana channel associated with this transaction
Exceptions
nTransactionExceptionIf there is an error during the construction, check the message for more information

Constructs an nTransactionAttributes object associated with the channel specified. Transactions created with this object will have the Time To Live (TTL) specified.

Parameters
aChannelThe nirvana channel associated with the transaction
aTimeToLiveThe Time To Live (TTL) value that the transaction will have
timeoutin milliseconds to retry the commit / abort if there are recoverable exceptions, <0 represents infinite, 0 represents no retry and >0 represents actual retry timeframe
Exceptions
nTransactionExceptionIf there is an error during the construction, check the message for more information

Member Function Documentation

nAbstractChannel com.pcbsys.nirvana.client.nTransactionAttributes.getChannel ( )

Gets the nirvana channel that will be associated with transactions created from this object

Returns
the nChannel object that will be associated with the transactions created from this object
long com.pcbsys.nirvana.client.nTransactionAttributes.getTimeout ( )

Retrieves the timeout value.

Returns
a long millisecond value
long com.pcbsys.nirvana.client.nTransactionAttributes.getTTL ( )

Gets the TTL value that transactions created from this object will have

Returns
a long value specifying the TTL value that transactions created from this object will have
void com.pcbsys.nirvana.client.nTransactionAttributes.setChannel ( nChannel  aChannel)

Sets the nirvana channel that will be associated with transactions created from this object

Parameters
aChannelthe nChannel object that will be associated with the transactions created from this object
void com.pcbsys.nirvana.client.nTransactionAttributes.setTimeout ( long  timeout)

Sets the timeout value, as milliseconds, to use.

This value controls if the code will retry the commit or abort on recoverable exceptions and only return once the operation has been completed.

Parameters
timeoutin milliseconds to retry the commit / abort if there are recoverable exceptions, <0 represents infinite, 0 represents no retry and >0 represents actual retry timeframe
void com.pcbsys.nirvana.client.nTransactionAttributes.setTTL ( long  aTimeToLive)

Sets the TTL value that transactions created from this object will have

Parameters
aTimeToLivea long value specifying the TTL value that transactions created from this object will have