Main Page | Class Hierarchy | Alphabetical List | Class List | File List | Class Members

PANA_Exception Class Reference

#include <pana_exceptions.h>

List of all members.

Public Types

enum  CODE {
  SUCCESS = 0, FAILED, NO_MEMORY, THREAD_FAILED,
  ENQUEUE_FAILED, TRANSPORT_FAILED, MESSAGE_PARSING_ERROR, AVP_FACTORY_ERROR,
  STATIC_GUARD_TRIGGER, DATABASE_ERROR, PARSING_ERROR, SESSIONID_ERROR,
  ENTRY_NOT_FOUND, CONFIG_ERROR, INVALID_MESSAGE
}

Public Member Functions

 PANA_Exception (CODE code, std::string &description)
 PANA_Exception (CODE code, const char *description)
CODE code ()
void code (CODE code)
std::string & description ()
void description (std::string &description)

Detailed Description

Exception class for errors and return codes. Note that this class is throwable.

Definition at line 47 of file pana_exceptions.h.

Member Enumeration Documentation

enum PANA_Exception::CODE
 

Exception code enumeration. New error codes MUST be appended here

Definition at line 54 of file pana_exceptions.h.

Referenced by code(). 

00054                    {
00055          SUCCESS = 0,
00056          FAILED,
00057          NO_MEMORY,
00058          THREAD_FAILED,
00059          ENQUEUE_FAILED,
00060          TRANSPORT_FAILED,
00061          MESSAGE_PARSING_ERROR,
00062          AVP_FACTORY_ERROR,
00063          STATIC_GUARD_TRIGGER,
00064          DATABASE_ERROR,
00065          PARSING_ERROR,
00066          SESSIONID_ERROR,
00067          ENTRY_NOT_FOUND,
00068          CONFIG_ERROR,
00069          INVALID_MESSAGE,
00070       } CODE;

Constructor & Destructor Documentation

PANA_Exception::PANA_Exception (  CODE  code,
std::string &  description
)  [inline]
 

constructor

Parameters:
code Default code
description Sting description of the error code

Definition at line 79 of file pana_exceptions.h.

References description(). 

00079                                                          : 
00080                       code_(code),
00081                       description_(description) { }

PANA_Exception::PANA_Exception (  CODE  code,
const char *  description
)  [inline]
 

constructor

Parameters:
code Default code
description Sting description of the error code

Definition at line 89 of file pana_exceptions.h.

References description(). 

00089                                                           : 
00090                       code_(code),
00091                       description_(description) { }

Member Function Documentation

void PANA_Exception::code (  CODE  code  )  [inline]
 

Access method for modifying current code exception value

Parameters:
code New exception code

Definition at line 105 of file pana_exceptions.h. 

00105 { code_ = code; }

CODE PANA_Exception::code (   )  [inline]
 

Access method for getting current code exception value

Definition at line 97 of file pana_exceptions.h.

References CODE. 

00097 {  return code_; }

void PANA_Exception::description (  std::string &  description  )  [inline]
 

Access methods to setting string description

Parameters:
description New descripton for this error code

Definition at line 117 of file pana_exceptions.h. 

00117 { description_ = description; }

std::string& PANA_Exception::description (   )  [inline]
 

Access methods to string description

Definition at line 110 of file pana_exceptions.h.

Referenced by PANA_Exception(). 

00110 { return description_; }

The documentation for this class was generated from the following file:
Generated on Fri Jun 25 19:18:30 2004 for PANA by doxygen 1.3.5