blob: d22a21166ffefc71d42b0e9669340c056ee1c981 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
|
// -*- C++ -*-
//=============================================================================
/**
* @file Thread_Control.h
*
* @author Carlos O'Ryan <coryan@uci.edu>
*/
//=============================================================================
#ifndef ACE_THREAD_CONTROL_H
#define ACE_THREAD_CONTROL_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_Thread_Manager;
/**
* @class ACE_Thread_Control
*
* @brief Used to keep track of a thread's activities within its entry
* point function.
*
* A ACE_Thread_Manager uses this class to ensure that threads
* it spawns automatically register and unregister themselves
* with it.
* This class can be stored in thread-specific storage using the
* ACE_TSS wrapper. When a thread exits the
* <ACE_TSS::cleanup> function deletes this object, thereby
* ensuring that it gets removed from its associated
* ACE_Thread_Manager.
*/
class ACE_Export ACE_Thread_Control
{
public:
/// Initialize the thread control object. If @a insert != 0, then
/// register the thread with the Thread_Manager.
ACE_Thread_Control (ACE_Thread_Manager *tm = 0,
int insert = 0);
/// Remove the thread from its associated Thread_Manager and exit
/// the thread if <do_thr_exit> is enabled.
~ACE_Thread_Control ();
/// Remove this thread from its associated ACE_Thread_Manager and exit
/// the thread if @a do_thr_exit is enabled.
ACE_THR_FUNC_RETURN exit (ACE_THR_FUNC_RETURN status,
int do_thr_exit);
/// Store the Thread_Manager and use it to register ourselves for
/// correct shutdown.
int insert (ACE_Thread_Manager *tm, bool insert = false);
/// Returns the current Thread_Manager.
ACE_Thread_Manager *thr_mgr ();
/// Atomically set a new Thread_Manager and return the old
/// Thread_Manager.
ACE_Thread_Manager *thr_mgr (ACE_Thread_Manager *);
/// Set the exit status (and return existing status).
ACE_THR_FUNC_RETURN status (ACE_THR_FUNC_RETURN status);
/// Get the current exit status.
ACE_THR_FUNC_RETURN status ();
/// Dump the state of an object.
void dump () const;
/// Declare the dynamic allocation hooks.
ACE_ALLOC_HOOK_DECLARE;
private:
/// Pointer to the thread manager for this block of code.
ACE_Thread_Manager *tm_;
/// Keeps track of the exit status for the thread.
ACE_THR_FUNC_RETURN status_;
};
ACE_END_VERSIONED_NAMESPACE_DECL
# if defined (ACE_HAS_INLINED_OSCALLS)
# if defined (ACE_INLINE)
# undef ACE_INLINE
# endif /* ACE_INLINE */
# define ACE_INLINE inline
# include "ace/Thread_Control.inl"
# endif /* ACE_HAS_INLINED_OSCALLS */
#include /**/ "ace/post.h"
#endif /* ACE_THREAD_CONTROL_H */
|
