summaryrefslogtreecommitdiff
path: root/ACE/ace/Sample_History.h
diff options
context:
space:
mode:
Diffstat (limited to 'ACE/ace/Sample_History.h')
-rw-r--r--ACE/ace/Sample_History.h91
1 files changed, 91 insertions, 0 deletions
diff --git a/ACE/ace/Sample_History.h b/ACE/ace/Sample_History.h
new file mode 100644
index 00000000000..2c060737cfb
--- /dev/null
+++ b/ACE/ace/Sample_History.h
@@ -0,0 +1,91 @@
+// -*- C++ -*-
+
+//=============================================================================
+/**
+ * @file Sample_History.h
+ *
+ * $Id$
+ *
+ * @author Carlos O'Ryan <coryan@uci.edu>
+ */
+//=============================================================================
+
+
+#ifndef ACE_SAMPLE_HISTORY_H
+#define ACE_SAMPLE_HISTORY_H
+#include /**/ "ace/pre.h"
+
+#include /**/ "ace/config-all.h"
+#include "ace/Basic_Types.h"
+
+#if !defined (ACE_LACKS_PRAGMA_ONCE)
+# pragma once
+#endif /* ACE_LACKS_PRAGMA_ONCE */
+
+ACE_BEGIN_VERSIONED_NAMESPACE_DECL
+
+class ACE_Basic_Stats;
+
+/// Save multiple samples in an array
+/**
+ * Save multiple samples (usually latency numbers), into an array, and
+ * later print them in several formats.
+ */
+class ACE_Export ACE_Sample_History
+{
+public:
+ /// Constructor
+ /**
+ * The number of samples is pre-allocated, and cannot changes once
+ * the class is initialized.
+ */
+ ACE_Sample_History (size_t max_samples);
+
+ /// Destructor
+ ~ACE_Sample_History (void);
+
+ /// Record one sample.
+ /**
+ * Return 0 on success, -1 if the sample could not be stored
+ */
+ int sample (ACE_UINT64 value);
+
+ /// Returns the maximum number of samples
+ size_t max_samples (void) const;
+
+ /// Returns the current number of samples
+ size_t sample_count (void) const;
+
+ /// Dump all the samples
+ /**
+ * Prints out all the samples, using @a msg as a prefix for each
+ * message.
+ */
+ void dump_samples (const ACE_TCHAR *msg,
+ ACE_UINT32 scale_factor) const;
+
+ /// Collect the summary for all the samples
+ void collect_basic_stats (ACE_Basic_Stats &) const;
+
+ /// Get a sample
+ ACE_UINT64 get_sample (size_t i) const;
+
+private:
+ /// The maximum number of samples
+ size_t max_samples_;
+
+ /// The current number of samples
+ size_t sample_count_;
+
+ /// The samples
+ ACE_UINT64 *samples_;
+};
+
+ACE_END_VERSIONED_NAMESPACE_DECL
+
+#if defined (__ACE_INLINE__)
+#include "ace/Sample_History.inl"
+#endif /* __ACE_INLINE__ */
+
+#include /**/ "ace/post.h"
+#endif /* ACE_SAMPLE_HISTORY_H */