summaryrefslogtreecommitdiff
path: root/ACE/ace/Log_Msg_Callback.h
diff options
context:
space:
mode:
Diffstat (limited to 'ACE/ace/Log_Msg_Callback.h')
-rw-r--r--ACE/ace/Log_Msg_Callback.h69
1 files changed, 69 insertions, 0 deletions
diff --git a/ACE/ace/Log_Msg_Callback.h b/ACE/ace/Log_Msg_Callback.h
new file mode 100644
index 00000000000..2a372ed76b8
--- /dev/null
+++ b/ACE/ace/Log_Msg_Callback.h
@@ -0,0 +1,69 @@
+// -*- C++ -*-
+
+//=============================================================================
+/**
+ * @file Log_Msg_Callback.h
+ *
+ * $Id$
+ *
+ * @author Douglas C. Schmidt <schmidt@cs.wustl.edu>
+ */
+//=============================================================================
+
+#ifndef ACE_LOG_MSG_CALLBACK_H
+#define ACE_LOG_MSG_CALLBACK_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_Log_Record;
+
+/**
+ * @class ACE_Log_Msg_Callback
+ *
+ * @brief An interface class used to get logging callbacks.
+ *
+ * Users who are interested in getting the logging messages
+ * directly, can subclass this interface and override the log()
+ * method. They must then register their subclass with the
+ * Log_Msg class and make sure that they turn on the
+ * ACE_Log_Msg::MSG_CALLBACK flag.
+ *
+ * Your log() routine is called with an instance of
+ * ACE_Log_Record. From this class, you can get the log
+ * message, the verbose log message, message type, message
+ * priority, and so on.
+ *
+ * Remember that there is one Log_Msg object per thread.
+ * Therefore, you may need to register your callback object with
+ * many ACE_Log_Msg objects (and have the correct
+ * synchronization in the log() method) or have a separate
+ * callback object per Log_Msg object. Moreover,
+ * ACE_Log_Msg_Callbacks are not inherited when a new thread
+ * is spawned because it might have been allocated off of the
+ * stack of the original thread, in which case all hell would
+ * break loose... Therefore, you'll need to reset these in each
+ * new thread.
+ */
+class ACE_Export ACE_Log_Msg_Callback
+{
+public:
+ /// No-op virtual destructor.
+ virtual ~ACE_Log_Msg_Callback (void);
+
+ /// Callback routine. This is called when we want to log a message.
+ /// Since this routine is pure virtual, it must be overwritten by the
+ /// subclass.
+ virtual void log (ACE_Log_Record &log_record) = 0;
+};
+
+ACE_END_VERSIONED_NAMESPACE_DECL
+
+#include /**/ "ace/post.h"
+#endif /* ACE_LOG_MSG_CALLBACK_H */