ACE/ace/Thread_Hook.h

   1 // -*- C++ -*-
   2
   3 //=============================================================================
   4 /**
   5  *  @file    Thread_Hook.h
   6  *
   7  *  @author Carlos O'Ryan <coryan@uci.edu>
   8  */
   9 //=============================================================================
  10
  11 #ifndef ACE_THREAD_HOOK_H
  12 #define ACE_THREAD_HOOK_H
  13 #include /**/ "ace/pre.h"
  14
  15 #include /**/ "ace/config-all.h"
  16
  17 #if !defined (ACE_LACKS_PRAGMA_ONCE)
  18 # pragma once
  19 #endif /* ACE_LACKS_PRAGMA_ONCE */
  20
  21 #include /**/ "ace/ACE_export.h"
  22
  23 ACE_BEGIN_VERSIONED_NAMESPACE_DECL
  24
  25 /**
  26  * @class ACE_Thread_Hook
  27  *
  28  * @brief This class makes it possible to provide user-defined "start"
  29  * hooks that are called before the thread entry point function
  30  * is invoked.
  31  */
  32 class ACE_Export ACE_Thread_Hook
  33 {
  34 public:
  35   /// Default constructor
  36   ACE_Thread_Hook (void);
  37
  38   /// Destructor.
  39   virtual ~ACE_Thread_Hook (void);
  40
  41   /**
  42    * This method can be overridden in a subclass to customize this
  43    * pre-function call "hook" invocation that can perform
  44    * initialization processing before the thread entry point @a func
  45    * method is called back.  The @a func and @a arg passed into the
  46    * start hook are the same as those passed by the application that
  47    * spawned the thread.
  48    */
  49   virtual ACE_THR_FUNC_RETURN start (ACE_THR_FUNC func,
  50                                      void *arg);
  51
  52   /// Sets the system wide thread hook, returns the previous thread
  53   /// hook or 0 if none is set.
  54   static ACE_Thread_Hook *thread_hook (ACE_Thread_Hook *hook);
  55
  56   /// Returns the current system thread hook.
  57   static ACE_Thread_Hook *thread_hook (void);
  58 };
  59
  60 ACE_END_VERSIONED_NAMESPACE_DECL
  61
  62 #include /**/ "ace/post.h"
  63 #endif /* ACE_THREAD_HOOK_H */