summaryrefslogtreecommitdiff
path: root/ACE/ace/Trace.h
diff options
context:
space:
mode:
Diffstat (limited to 'ACE/ace/Trace.h')
-rw-r--r--ACE/ace/Trace.h96
1 files changed, 96 insertions, 0 deletions
diff --git a/ACE/ace/Trace.h b/ACE/ace/Trace.h
new file mode 100644
index 00000000000..c473ee14014
--- /dev/null
+++ b/ACE/ace/Trace.h
@@ -0,0 +1,96 @@
+// -*- C++ -*-
+
+//=============================================================================
+/**
+ * @file Trace.h
+ *
+ * $Id$
+ *
+ * @author Douglas C. Schmidt <schmidt@cs.wustl.edu>
+ */
+//=============================================================================
+
+#ifndef ACE_TRACE_H
+#define ACE_TRACE_H
+
+#include /**/ "ace/pre.h"
+
+#include "ace/ACE_export.h"
+
+#if !defined (ACE_LACKS_PRAGMA_ONCE)
+# pragma once
+#endif /* ACE_LACKS_PRAGMA_ONCE */
+
+ACE_BEGIN_VERSIONED_NAMESPACE_DECL
+
+/**
+ * @class ACE_Trace
+ *
+ * @brief A C++ trace facility that keeps track of which methods are
+ * entered and exited.
+ *
+ * This class uses C++ constructors and destructors to automate
+ * the ACE_Trace nesting. In addition, thread-specific storage
+ * is used to enable multiple threads to work correctly.
+ */
+class ACE_Export ACE_Trace
+{
+public:
+ // = Initialization and termination methods.
+
+ /// Perform the first part of the trace, which prints out the string
+ /// N, the LINE, and the ACE_FILE as the function is entered.
+ ACE_Trace (const ACE_TCHAR *n,
+ int line = 0,
+ const ACE_TCHAR *file = ACE_LIB_TEXT (""));
+
+ /// Perform the second part of the trace, which prints out the NAME
+ /// as the function is exited.
+ ~ACE_Trace (void);
+
+ // = Control the tracing level.
+ /// Determine if tracing is enabled (return == 1) or not (== 0)
+ static int is_tracing(void);
+
+ /// Enable the tracing facility.
+ static void start_tracing (void);
+
+ /// Disable the tracing facility.
+ static void stop_tracing (void);
+
+ /// Change the nesting indentation level.
+ static void set_nesting_indent (int indent);
+
+ /// Get the nesting indentation level.
+ static int get_nesting_indent (void);
+
+ /// Dump the state of an object.
+ void dump (void) const;
+
+private:
+ // Keeps track of how deeply the call stack is nested (this is
+ // maintained in thread-specific storage to ensure correctness in
+ // multiple threads of control.
+
+ /// Name of the method we are in.
+ const ACE_TCHAR *name_;
+
+ /// Keeps track of how far to indent per trace call.
+ static int nesting_indent_;
+
+ /// Is tracing enabled?
+ static int enable_tracing_;
+
+ /// Default values.
+ enum
+ {
+ DEFAULT_INDENT = 3,
+ DEFAULT_TRACING = 1
+ };
+};
+
+ACE_END_VERSIONED_NAMESPACE_DECL
+
+#include /**/ "ace/post.h"
+
+#endif /* ACE_TRACE_H */