TAO/tao/PI/Interceptor_List_T.h

   1 // -*- C++ -*-
   2
   3 // ===================================================================
   4 /**
   5  *  @file   Interceptor_List_T.h
   6  *
   7  *  @author Ossama Othman <ossama@uci.edu>
   8  *  @author Johnny Willemsen  <jwillemsen@remedy.nl>
   9  */
  10 // ===================================================================
  11
  12 #ifndef TAO_INTERCEPTOR_LIST_H
  13 #define TAO_INTERCEPTOR_LIST_H
  14
  15 #include /**/ "ace/pre.h"
  16
  17 #include "ace/Array_Base.h"
  18
  19 #if !defined (ACE_LACKS_PRAGMA_ONCE)
  20 # pragma once
  21 #endif /* ACE_LACKS_PRAGMA_ONCE */
  22
  23 #include "tao/orbconf.h"
  24
  25 TAO_BEGIN_VERSIONED_NAMESPACE_DECL
  26
  27 namespace PortableInterceptor
  28 {
  29   class Interceptor;
  30   typedef Interceptor *Interceptor_ptr;
  31 }
  32
  33 namespace CORBA
  34 {
  35   class PolicyList;
  36 }
  37
  38 namespace TAO
  39 {
  40   /**
  41    * @class Interceptor_List
  42    *
  43    * @brief Template for portable interceptor lists.
  44    *
  45    * Template for the various portable interceptor lists used
  46    * internally by TAO.
  47    */
  48   template <typename InterceptorType, typename DetailsType>
  49   class Interceptor_List
  50   {
  51   public:
  52     /// Define the traits for the underlying portable interceptor array.
  53     typedef typename InterceptorType::_var_type InterceptorType_var_type;
  54     typedef typename InterceptorType::_ptr_type InterceptorType_ptr_type;
  55
  56     struct RegisteredInterceptor
  57     {
  58       InterceptorType_var_type interceptor_;
  59       DetailsType              details_;
  60     };
  61
  62     /// Constructor.
  63     Interceptor_List ();
  64
  65     void add_interceptor (InterceptorType_ptr_type i);
  66
  67     /// Register an interceptor with policies.
  68     void add_interceptor (InterceptorType_ptr_type i,
  69                           const CORBA::PolicyList& policies);
  70
  71     void destroy_interceptors ();
  72
  73     /// Return the registered interceptor in sequence element @a index.
  74     RegisteredInterceptor& registered_interceptor (size_t index);
  75
  76     /// Return the interceptor in sequence element @a index.
  77     InterceptorType_ptr_type interceptor (size_t index);
  78
  79     size_t size () const;
  80
  81   private:
  82     typedef ACE_Array_Base<RegisteredInterceptor > RegisteredArray;
  83
  84     /// Dynamic array of registered interceptors.
  85     RegisteredArray interceptors_;
  86   };
  87 }
  88
  89 TAO_END_VERSIONED_NAMESPACE_DECL
  90
  91 #include "tao/PI/Interceptor_List_T.cpp"
  92
  93 #include /**/ "ace/post.h"
  94
  95 #endif /* TAO_INTERCEPTOR_LIST_H */