com::pcbsys::nirvana::client::nTransactionAttributes Class Reference

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

#include <nTransactionAttributes.h>

Public Member Functions

nAbstractChannelgetChannel ()
 Gets the nirvana channel that will be associated with transactions created from this object. More...
 
longlong getTTL ()
 Gets the TTL value that transactions created from this object will have. More...
 
 nTransactionAttributes (nAbstractChannel *pChannel, longlong timeToLive=-2)
 Constructs an nTransactionAttributes object associated with the channel specified. More...
 
 nTransactionAttributes ()
 Default Constructor.
 
void setChannel (nChannel *pChannel)
 Sets the nirvana channel that will be associated with transactions created from this object. More...
 
void setTTL (longlong timeToLive)
 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 pChannel,
longlong  timeToLive = -2 
)

Constructs an nTransactionAttributes object associated with the channel specified.

Transactions created with this object will have the Time To Live (TTL) specified.

Parameters
*pChannelThe nirvana channel associated with the transaction
timeToLiveThe 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

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
longlong 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 pChannel)

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

Parameters
*pChannelthe nChannel object that will be associated with the transactions created from this object
void com::pcbsys::nirvana::client::nTransactionAttributes::setTTL ( longlong  timeToLive)

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

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