com::pcbsys::nirvana::client::nTransactionException Class Reference

This class defines the errors that can be thrown by using the nirvana transactional publish API. More...

#include <nTransactionException.h>

Inheritance diagram for com::pcbsys::nirvana::client::nTransactionException:
com::pcbsys::nirvana::client::nBaseClientException com::pcbsys::nirvana::client::nTransactionAlreadyAbortedException com::pcbsys::nirvana::client::nTransactionAlreadyCommittedException com::pcbsys::nirvana::client::nTransactionIncompleteException com::pcbsys::nirvana::client::nTransactionNoEventsException com::pcbsys::nirvana::client::nTransactionNoSuchTXIDException com::pcbsys::nirvana::client::nTransactionNotCommittedException com::pcbsys::nirvana::client::nTransactionNotStartedException com::pcbsys::nirvana::client::nUnknownTransactionIdException

Public Member Functions

longlong getServerTTL ()
 Gets the transaction TTL value as defined by the server. More...
 
 nTransactionException (const std::string &msg)
 Constructs a new nTransactionException with the specified message. More...
 
 nTransactionException (const std::string &msg, longlong ttl)
 Constructs a new nTransactionException with the specified message and transaction TTL value. More...
 
- Public Member Functions inherited from com::pcbsys::nirvana::client::nBaseClientException
 nBaseClientException (std::string msg)
 Creates the exception with the specified message. More...
 

Detailed Description

This class defines the errors that can be thrown by using the nirvana transactional publish API.

Constructor & Destructor Documentation

com::pcbsys::nirvana::client::nTransactionException::nTransactionException ( const std::string &  msg)

Constructs a new nTransactionException with the specified message.

Parameters
msga string message to specify the nature of the transaction error
com::pcbsys::nirvana::client::nTransactionException::nTransactionException ( const std::string &  msg,
longlong  ttl 
)

Constructs a new nTransactionException with the specified message and transaction TTL value.

Parameters
msga string message to specify the nature of the transaction error
ttla long specifying the transaction Time To Live (TTL) value as defined by the server

Member Function Documentation

longlong com::pcbsys::nirvana::client::nTransactionException::getServerTTL ( )

Gets the transaction TTL value as defined by the server.

Returns
a longlong value specifying the transaction TTL value as defined by the server