TAO/tao/PortableServer/POA_Current.h

   1 // -*- C++ -*-
   2
   3 //=============================================================================
   4 /**
   5  *  @file    POA_Current.h
   6  *
   7  *  @author Irfan Pyarali
   8  */
   9 //=============================================================================
  10
  11 #ifndef TAO_POA_CURRENT_H
  12 #define TAO_POA_CURRENT_H
  13
  14 #include /**/ "ace/pre.h"
  15
  16 #include "tao/PortableServer/portableserver_export.h"
  17
  18 #if !defined (ACE_LACKS_PRAGMA_ONCE)
  19 # pragma once
  20 #endif /* ACE_LACKS_PRAGMA_ONCE */
  21
  22 #include "tao/PortableServer/PS_CurrentC.h"
  23 #include "tao/LocalObject.h"
  24
  25 #if defined(_MSC_VER)
  26 #pragma warning(push)
  27 #pragma warning(disable:4250)
  28 #endif /* _MSC_VER */
  29
  30 TAO_BEGIN_VERSIONED_NAMESPACE_DECL
  31
  32 namespace TAO
  33 {
  34   namespace Portable_Server
  35   {
  36     class POA_Current_Impl;
  37
  38     class TAO_PortableServer_Export POA_Current
  39       : public PortableServer::Current
  40       , public ::CORBA::LocalObject
  41     {
  42     public:
  43       /**
  44        * Returns the POA on which the current request is being invoked.
  45        * Can raise the @c NoContext exception if this function is
  46        * not invoked in the context of an upcall.
  47        */
  48       PortableServer::POA_ptr get_POA ();
  49
  50       /**
  51        * Returns the object id of the current request being invoked.  Can
  52        * raise the @c NoContext exception if this function is not
  53        * invoked in the context of an upcall.
  54        */
  55       PortableServer::ObjectId *get_object_id ();
  56
  57       /**
  58        * This operation returns a locally manufactured reference to the object
  59        * in the context of which it is called. If called outside the context
  60        * of a POA dispatched operation, a NoContext exception is raised.
  61        * @note This reference is not guaranteed to be identical to the original
  62        * reference the client used to make the invocation, and calling the
  63        * Object::is_equivalent operation to compare the two references may not
  64        * necessarily return true.
  65        */
  66       CORBA::Object_ptr get_reference ();
  67
  68       /**
  69        * Returns a reference to the servant that hosts the object in whose
  70        * context it is called. If called outside the context of the POA
  71        * dispatched operation, a NoContext exception is raised
  72        */
  73       PortableServer::Servant get_servant ();
  74
  75       /// Returns the class that implements this interface.
  76       POA_Current_Impl *implementation ();
  77
  78       /// Sets the thread-specific pointer to the new POA Current state,
  79       /// returning a pointer to the existing POA Current state.
  80       POA_Current_Impl *implementation (POA_Current_Impl *new_current);
  81     };
  82   }
  83 }
  84
  85 TAO_END_VERSIONED_NAMESPACE_DECL
  86
  87 #if defined(_MSC_VER)
  88 #pragma warning(pop)
  89 #endif /* _MSC_VER */
  90
  91 #include /**/ "ace/post.h"
  92
  93 #endif /* TAO_POA_CURRENT_H */