TAO/tao/Exception_Data.h

   1 // -*- C++ -*-
   2
   3 //=============================================================================
   4 /**
   5  *  @file    Exception_Data.h
   6  *
   7  *  @author  balachandran Natarajan <bala@dre.vanderbilt.edu>
   8  */
   9 //=============================================================================
  10
  11 #ifndef TAO_EXCEPTION_DATA_H
  12 #define TAO_EXCEPTION_DATA_H
  13 #include /**/ "ace/pre.h"
  14
  15 #include "ace/config-all.h"
  16
  17 #if !defined (ACE_LACKS_PRAGMA_ONCE)
  18 # pragma once
  19 #endif /* ACE_LACKS_PRAGMA_ONCE */
  20
  21 #include "tao/orbconf.h"
  22
  23 TAO_BEGIN_VERSIONED_NAMESPACE_DECL
  24
  25 namespace CORBA
  26 {
  27   class TypeCode;
  28   typedef TypeCode *TypeCode_ptr;
  29
  30   class Exception;
  31 }
  32
  33 namespace TAO
  34 {
  35   // Function pointer returning a pointer to CORBA::Exception. This is used to
  36   // describe the allocator for user-defined exceptions that are used internally
  37   // by the interpreter.
  38   typedef CORBA::Exception* (*TAO_Exception_Alloc) ();
  39
  40   /**
  41    * @struct Exception_Data
  42    *
  43    * @brief Description of a single exception.
  44    *
  45    * The interpreter needs a way to allocate memory to hold the exception
  46    * that was raised by the stub. This data structure provides the typecode
  47    * for the exception as well as a static function pointer that
  48    * does the job of memory allocation.
  49    */
  50   struct Exception_Data
  51   {
  52     /// Repository id of the exception.
  53     const char *id;
  54
  55     /// The allocator for this exception.
  56     TAO_Exception_Alloc alloc;
  57
  58 #if TAO_HAS_INTERCEPTORS == 1
  59     /// The typecode pointer for this exception.
  60     CORBA::TypeCode_ptr tc_ptr;
  61 #endif /* TAO_HAS_INTERCEPTORS */
  62   };
  63 }
  64
  65 TAO_END_VERSIONED_NAMESPACE_DECL
  66
  67 #include /**/ "ace/post.h"
  68 #endif /*TAO_EXCEPTION_DATA_H*/