dep/ACE_wrappers/ace/Intrusive_List.h

   1 /* -*- C++ -*- */
   2
   3 //=============================================================================
   4 /**
   5  *  @file Intrusive_List.h
   6  *
   7  *  $Id: Intrusive_List.h 80826 2008-03-04 14:51:23Z wotte $
   8  *
   9  *  @author Carlos O'Ryan <coryan@uci.edu>
  10  */
  11 //=============================================================================
  12
  13 #ifndef ACE_INTRUSIVE_LIST_H
  14 #define ACE_INTRUSIVE_LIST_H
  15 #include /**/ "ace/pre.h"
  16
  17 #include /**/ "ace/config-all.h"
  18
  19 #if !defined (ACE_LACKS_PRAGMA_ONCE)
  20 # pragma once
  21 #endif /* ACE_LACKS_PRAGMA_ONCE */
  22
  23 ACE_BEGIN_VERSIONED_NAMESPACE_DECL
  24
  25 /**
  26  * @class ACE_Intrusive_List
  27  *
  28  * @brief Implement an intrusive double linked list
  29  *
  30  * Intrusive lists assume that the elements they contain the pointers
  31  * required to build the list.  They are useful as light-weight
  32  * containers and free-lists.
  33  *
  34  * The template argument T must implement the following methods:
  35  *
  36  * - T* T::next () const;
  37  * - void T::next (T *);
  38  * - T* T::prev () const;
  39  * - void T::prev (T* );
  40  *
  41  * A simple way to satisfy the Intrusive_List requirements would be to
  42  * implement a helper class:
  43  *
  44  * class My_Object : public ACE_Intrusive_List_Node<My_Object> {<BR>
  45  * ....<BR>
  46  * };<BR>
  47  *
  48  * typedef ACE_Intrusive_List<My_Object> My_Object_List;
  49  *
  50  * However, ACE is supported on platforms that would surely get
  51  * confused using such templates.
  52  *
  53  * @todo The ACE_Message_Queue is an example of an intrusive list (or
  54  * queue) but it is not implemented in terms of this class.
  55  *
  56  */
  57 template <class T>
  58 class ACE_Intrusive_List
  59 {
  60 public:
  61   // = Initialization and termination methods.
  62   /// Constructor.  Use user specified allocation strategy
  63   /// if specified.
  64   ACE_Intrusive_List (void);
  65
  66   /// Destructor.
  67   ~ACE_Intrusive_List (void);
  68
  69   // = Check boundary conditions.
  70
  71   /// Returns 1 if the container is empty, otherwise returns 0.
  72   int is_empty (void) const;
  73
  74   /// Returns 1 if the container is empty, otherwise returns 0.
  75   /// @deprecated Use is_empty() instead.
  76   int empty (void) const;
  77
  78   /// Insert an element at the beginning of the list
  79   void push_front (T *node);
  80
  81   /// Insert an element at the end of the list
  82   void push_back (T *node);
  83
  84   /// Remove the element at the beginning of the list
  85   T *pop_front (void);
  86
  87   /// Remove the element at the end of the list
  88   T *pop_back (void);
  89
  90   /// Get the element at the head of the queue
  91   T *head (void) const;
  92
  93   /// Get the element at the tail of the queue
  94   T *tail (void) const;
  95
  96   /// Remove a element from the list
  97   /**
  98    * Verify that the element is still in the list before removing it.
  99    */
 100   void remove (T *node);
 101
 102   /// Swap two lists
 103   void swap(ACE_Intrusive_List<T> & rhs);
 104
 105   /// Remove a element from the list without checking
 106   /**
 107    * No attempts are performed to check if T* really belongs to the
 108    * list.  The effects of removing an invalid element are unspecified
 109    */
 110   void unsafe_remove (T *node);
 111
 112 private:
 113   /** @name Disallow copying
 114    *
 115    */
 116   //@{
 117   ACE_Intrusive_List (const ACE_Intrusive_List<T> &);
 118   ACE_Intrusive_List<T>& operator= (const ACE_Intrusive_List<T> &);
 119   //@}
 120
 121 private:
 122   /// Head of the list
 123   T *head_;
 124
 125   /// Tail of the list
 126   T *tail_;
 127 };
 128
 129 ACE_END_VERSIONED_NAMESPACE_DECL
 130
 131 #if defined (__ACE_INLINE__)
 132 #include "ace/Intrusive_List.inl"
 133 #endif /* __ACE_INLINE__ */
 134
 135 #if defined (ACE_TEMPLATES_REQUIRE_SOURCE)
 136 #include "ace/Intrusive_List.cpp"
 137 #endif /* ACE_TEMPLATES_REQUIRE_SOURCE */
 138
 139 #if defined (ACE_TEMPLATES_REQUIRE_PRAGMA)
 140 #pragma implementation ("Intrusive_List.cpp")
 141 #endif /* ACE_TEMPLATES_REQUIRE_PRAGMA */
 142
 143 #include /**/ "ace/post.h"
 144 #endif /* ACE_INTRUSIVE_LIST_H */