Document return values
[ACE_TAO.git] / ACE / ace / Monitor_Size.h
blob0ecf46533e635499f7296c348b99157e09ff3d1c
1 // -*- C++ -*-
3 //=============================================================================
4 /**
5 * @file Monitor_Size.h
7 * @author Jeff Parsons <j.parsons@vanderbilt.edu>
8 */
9 //=============================================================================
11 #ifndef SIZE_MONITOR_H
12 #define SIZE_MONITOR_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 #include "ace/Monitor_Base.h"
24 #if defined (ACE_HAS_MONITOR_FRAMEWORK) && (ACE_HAS_MONITOR_FRAMEWORK == 1)
26 ACE_BEGIN_VERSIONED_NAMESPACE_DECL
28 namespace ACE
30 namespace Monitor_Control
32 /**
33 * @class Size_Monitor
35 * @brief Base class from which ACE monitors of size are
36 * derived.
39 class ACE_Export Size_Monitor : public Monitor_Base
41 public:
42 Size_Monitor ();
43 Size_Monitor (const char* name);
44 ~Size_Monitor () override = default;
46 /// Implemented by the most-derived class. Does the actual
47 /// work of fetching the monitored value.
48 void update () override;
50 /// Reset function.
51 void clear () override;
56 ACE_END_VERSIONED_NAMESPACE_DECL
58 #endif /* ACE_HAS_MONITOR_FRAMEWORK==1 */
60 #include /**/ "ace/post.h"
62 #endif // SIZE_MONITOR_H