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 #include <string_view>
  23
  24 TAO_BEGIN_VERSIONED_NAMESPACE_DECL
  25
  26 namespace CORBA
  27 {
  28   class TypeCode;
  29   typedef TypeCode *TypeCode_ptr;
  30
  31   class Exception;
  32 }
  33
  34 namespace TAO
  35 {
  36   // Function pointer returning a pointer to CORBA::Exception. This is used to
  37   // describe the allocator for user-defined exceptions that are used internally
  38   // by the interpreter.
  39   typedef CORBA::Exception* (*TAO_Exception_Alloc) ();
  40
  41   /**
  42    * @struct Exception_Data
  43    *
  44    * @brief Description of a single exception.
  45    *
  46    * The interpreter needs a way to allocate memory to hold the exception
  47    * that was raised by the stub. This data structure provides the typecode
  48    * for the exception as well as a static function pointer that
  49    * does the job of memory allocation.
  50    */
  51   struct Exception_Data
  52   {
  53     /// Repository id of the exception.
  54     std::string_view id;
  55
  56     /// The allocator for this exception.
  57     TAO_Exception_Alloc alloc;
  58
  59 #if TAO_HAS_INTERCEPTORS == 1
  60     /// The typecode pointer for this exception.
  61     CORBA::TypeCode_ptr tc_ptr;
  62 #endif /* TAO_HAS_INTERCEPTORS */
  63   };
  64 }
  65
  66 TAO_END_VERSIONED_NAMESPACE_DECL
  67
  68 #include /**/ "ace/post.h"
  69 #endif /*TAO_EXCEPTION_DATA_H*/