ACE/ace/Connection_Recycling_Strategy.h

   1 /* -*- C++ -*- */
   2
   3 //=============================================================================
   4 /**
   5  *  @file   Connection_Recycling_Strategy.h
   6  *
   7  *  @author Doug Schmidt
   8  */
   9 //=============================================================================
  10 #ifndef ACE_CONNECTION_RECYCLING_STRATEGY_H
  11 #define ACE_CONNECTION_RECYCLING_STRATEGY_H
  12 #include /**/ "ace/pre.h"
  13
  14 #include "ace/Recyclable.h"
  15
  16 #if !defined (ACE_LACKS_PRAGMA_ONCE)
  17 # pragma once
  18 #endif /* ACE_LACKS_PRAGMA_ONCE */
  19
  20 ACE_BEGIN_VERSIONED_NAMESPACE_DECL
  21
  22 /**
  23  * @class ACE_Connection_Recycling_Strategy
  24  *
  25  * @brief Defines the interface for a connection recycler.
  26  */
  27 class ACE_Export ACE_Connection_Recycling_Strategy
  28 {
  29 public:
  30   ACE_Connection_Recycling_Strategy ();
  31
  32   /// Virtual Destructor
  33   virtual ~ACE_Connection_Recycling_Strategy () = default;
  34
  35   /// Remove from cache.
  36   virtual int purge (const void *recycling_act) = 0;
  37
  38   /// Add to cache.
  39   virtual int cache (const void *recycling_act) = 0;
  40
  41   virtual int recycle_state (const void *recycling_act,
  42                              ACE_Recyclable_State new_state) = 0;
  43
  44   /// Get/Set recycle_state.
  45   virtual ACE_Recyclable_State recycle_state (const void *recycling_act) const = 0;
  46
  47   /// Mark as closed.
  48   virtual int mark_as_closed (const void *recycling_act) = 0;
  49
  50   /// Mark as closed.(non-locking version)
  51   virtual int mark_as_closed_i (const void *recycling_act) = 0;
  52
  53   /// Cleanup hint and reset @a act_holder to zero if @a act_holder != 0.
  54   virtual int cleanup_hint (const void *recycling_act,
  55                             void **act_holder = 0) = 0;
  56 };
  57
  58 ACE_END_VERSIONED_NAMESPACE_DECL
  59
  60 #include /**/ "ace/post.h"
  61
  62 #endif /*ACE_CONNECTION_RECYCLING_STRATEGY*/