Document return values
[ACE_TAO.git] / ACE / ace / Containers.h
blob8ba4c3c84a64698f80ffb223b15b1a2f4ad4c63e
1 // -*- C++ -*-
3 //=============================================================================
4 /**
5 * @file Containers.h
7 * @author Douglas C. Schmidt <d.schmidt@vanderbilt.edu>
8 */
9 //=============================================================================
11 #ifndef ACE_CONTAINERS_H
12 #define ACE_CONTAINERS_H
14 #include /**/ "ace/pre.h"
16 #include /**/ "ace/ACE_export.h"
18 #if !defined (ACE_LACKS_PRAGMA_ONCE)
19 # pragma once
20 #endif /* ACE_LACKS_PRAGMA_ONCE */
22 ACE_BEGIN_VERSIONED_NAMESPACE_DECL
24 template <class T> class ACE_Double_Linked_List;
25 template <class T> class ACE_Double_Linked_List_Iterator_Base;
26 template <class T> class ACE_Double_Linked_List_Iterator;
27 template <class T> class ACE_Double_Linked_List_Reverse_Iterator;
29 /**
30 * @class ACE_DLList_Node
32 * @brief Base implementation of element in a DL list. Needed for
33 * ACE_Double_Linked_List.
35 class ACE_Export ACE_DLList_Node
37 public:
38 friend class ACE_Double_Linked_List<ACE_DLList_Node>;
39 friend class ACE_Double_Linked_List_Iterator_Base<ACE_DLList_Node>;
40 friend class ACE_Double_Linked_List_Iterator<ACE_DLList_Node>;
41 friend class ACE_Double_Linked_List_Reverse_Iterator<ACE_DLList_Node>;
43 ACE_DLList_Node (void *i,
44 ACE_DLList_Node *n = 0,
45 ACE_DLList_Node *p = 0);
47 /// Declare the dynamic allocation hooks.
48 ACE_ALLOC_HOOK_DECLARE;
50 void *item_;
52 ACE_DLList_Node *next_;
53 ACE_DLList_Node *prev_;
55 protected:
56 ACE_DLList_Node ();
59 ACE_END_VERSIONED_NAMESPACE_DECL
61 #if defined (__ACE_INLINE__)
62 #include "ace/Containers.inl"
63 #endif /* __ACE_INLINE__ */
65 #include "ace/Containers_T.h"
67 #include /**/ "ace/post.h"
69 #endif /* ACE_CONTAINERS_H */