summaryrefslogtreecommitdiff
path: root/ace/Thread_Hook.h
diff options
context:
space:
mode:
authorcoryan <coryan@ae88bc3d-4319-0410-8dbf-d08b4c9d3795>2000-11-01 22:17:39 +0000
committercoryan <coryan@ae88bc3d-4319-0410-8dbf-d08b4c9d3795>2000-11-01 22:17:39 +0000
commit53284e215e3d3351a7d7e9c4b68f14b427fb4377 (patch)
tree97236ece363cff48fd287c780db4290da39b02cb /ace/Thread_Hook.h
parent7b7c52ad2abd228138ba1a948d5e28bf6dc3b880 (diff)
downloadATCD-53284e215e3d3351a7d7e9c4b68f14b427fb4377.tar.gz
ChangeLogTag:Wed Nov 1 14:11:48 2000 Carlos O'Ryan <coryan@uci.edu>
Diffstat (limited to 'ace/Thread_Hook.h')
-rw-r--r--ace/Thread_Hook.h56
1 files changed, 29 insertions, 27 deletions
diff --git a/ace/Thread_Hook.h b/ace/Thread_Hook.h
index cc9a8ef9623..591e50193d6 100644
--- a/ace/Thread_Hook.h
+++ b/ace/Thread_Hook.h
@@ -1,17 +1,14 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// ace
-//
-// = FILENAME
-// Thread_Hook.h
-//
-// = AUTHOR
-// Carlos O'Ryan <coryan@uci.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Thread_Hook.h
+ *
+ * $Id$
+ *
+ * @author Carlos O'Ryan <coryan@uci.edu>
+ */
+//=============================================================================
+
#ifndef ACE_THREAD_HOOK_H
#define ACE_THREAD_HOOK_H
@@ -25,29 +22,34 @@
#include "ace/OS_Export.h"
+/**
+ * @class ACE_Thread_Hook
+ *
+ * @brief This class makes it possible to provide user-defined "start"
+ * hooks that are called before the thread entry point function
+ * is invoked.
+ */
class ACE_OS_Export ACE_Thread_Hook
{
- // = TITLE
- // This class makes it possible to provide user-defined "start"
- // hooks that are called before the thread entry point function
- // is invoked.
public:
+ /**
+ * This method can be overridden in a subclass to customize this
+ * pre-function call "hook" invocation that can perform
+ * initialization processing before the thread entry point <func>
+ * method is called back. The <func> and <arg> passed into the
+ * start hook are the same as those passed by the application that
+ * spawned the thread.
+ */
virtual void *start (ACE_THR_FUNC func,
void *arg);
- // This method can be overridden in a subclass to customize this
- // pre-function call "hook" invocation that can perform
- // initialization processing before the thread entry point <func>
- // method is called back. The <func> and <arg> passed into the
- // start hook are the same as those passed by the application that
- // spawned the thread.
+ /// sets the system wide thread hook, returns the previous thread
+ /// hook or 0 if none is set.
static ACE_Thread_Hook *thread_hook (ACE_Thread_Hook *hook);
- // sets the system wide thread hook, returns the previous thread
- // hook or 0 if none is set.
+ /// Returns the current system thread hook.
static ACE_Thread_Hook *thread_hook (void);
- // Returns the current system thread hook.
};
#include "ace/post.h"