ACE/ace/Intrusive_List_Node.h

   1 // -*- C++ -*-
   2
   3 //=============================================================================
   4 /**
   5  *  @file Intrusive_List_Node.h
   6  *
   7  *  @author Carlos O'Ryan <coryan@uci.edu>
   8  */
   9 //=============================================================================
  10
  11 #ifndef ACE_INTRUSIVE_LIST_NODE_H
  12 #define ACE_INTRUSIVE_LIST_NODE_H
  13 #include /**/ "ace/pre.h"
  14
  15 #include /**/ "ace/config-lite.h"
  16
  17 #if !defined (ACE_LACKS_PRAGMA_ONCE)
  18 # pragma once
  19 #endif /* ACE_LACKS_PRAGMA_ONCE */
  20
  21 ACE_BEGIN_VERSIONED_NAMESPACE_DECL
  22
  23 /**
  24  * @class ACE_Intrusive_List_Node
  25  *
  26  * @brief Implement the requirements for ACE_Intrusive_List
  27  *
  28  * The class should be used as follows:
  29  *
  30  * class My_Object : public ACE_Intrusive_List_Node<My_Object> {<BR>
  31  * ....<BR>
  32  * };<BR>
  33  *
  34  * However, ACE is supported on platforms that would surely get
  35  * confused using such templates, the class is provided as a helper
  36  * for our lucky users that only need portability to modern C++
  37  * compilers.
  38  */
  39 template <class T>
  40 class ACE_Intrusive_List_Node
  41 {
  42 public:
  43   /** @name Accesors and modifiers to the next and previous pointers
  44    *
  45    */
  46   //@{
  47   T *prev () const;
  48   void prev (T *);
  49   T *next () const;
  50   void next (T *);
  51   //@}
  52
  53 protected:
  54   /// Constructor
  55   /**
  56    * The constructor is protected, because only derived classes should
  57    * be instantiated.
  58    */
  59   ACE_Intrusive_List_Node () = default;
  60
  61 private:
  62   /// Head and tail of the list
  63   T *prev_ {};
  64   T *next_ {};
  65 };
  66
  67 ACE_END_VERSIONED_NAMESPACE_DECL
  68
  69 #if defined (__ACE_INLINE__)
  70 #include "ace/Intrusive_List_Node.inl"
  71 #endif /* __ACE_INLINE__ */
  72
  73 #include "ace/Intrusive_List_Node.cpp"
  74
  75 #include /**/ "ace/post.h"
  76 #endif /* ACE_INTRUSIVE_LIST_NODE_H */