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
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
|
// -*- C++ -*-
//=============================================================================
/**
* @file Token_Collection.h
*
* The ACE_Token class offers methods for acquiring, renewing,
* and releasing a synchronization token on a per-token basis. The
* ACE_Token_Collection offers an interface for performing
* operations on groups of tokens as a whole, or on a single token
* within the collection.
*
* The atomic group operations are not yet implemented.
*
* @author Douglas C. Schmidt (d.schmidt@vanderbilt.edu)
* @author Tim Harrison (harrison@cs.wustl.edu)
*/
//=============================================================================
#ifndef ACE_TOKEN_COLLECTION_H
#define ACE_TOKEN_COLLECTION_H
#include /**/ "ace/pre.h"
#include "ace/Map_Manager.h"
#if !defined (ACE_LACKS_PRAGMA_ONCE)
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */
#if defined (ACE_HAS_TOKENS_LIBRARY)
#include "ace/Local_Tokens.h"
#include "ace/Null_Mutex.h"
ACE_BEGIN_VERSIONED_NAMESPACE_DECL
/**
* @class ACE_Token_Collection
*
* @brief Allows atomic token group operations AND
* provides a ACE_Token manager interface.
*
* There are two types of operations offered by
* ACE_Token_Collection. The first is atomic operations on
* collections of Token_Proxies. In this respect, the
* ACE_Token_Collection can be thought of as a single token
* consisting of multiple Token_Proxies. The second role of the
* ACE_Token_Collection is as a ACE_Token manager.
* ACE_Token_Collection allows individual operations on single
* members of a collection of Token_Proxies. This provides a
* single access point for operations on multiple tokens.
*
* @bug Although ACE_Token_Collection inherits from ACE_Token_Proxy, it
* can not be including in a collection. This is because <clone>
* returns zero for now.
*/
class ACE_Export ACE_Token_Collection : public ACE_Token_Proxy
{
public:
/**
* @a debug print out verbose debugging messages. @a name will give a
* name to the collection. Collections don't really need names, but
* are sometimes useful for debugging.
*/
ACE_Token_Collection (bool debug = false,
const ACE_TCHAR *name = 0);
// Collection Management operations
/**
* Insert a Token into the collection. All ACE_Token type
* operations performed on the collection will also be performed on
* the new_proxy until it is removed. Note that no operations
* performed prior to the insertion will be performed. Returns: 0
* on success, -1 on failure with @c errno == problem. If a token
* proxy already exists in the collection with the same name, the
* insertion will fail. Also, <token> is copied. Note that during
* the copy, client_id's are *not* inherited. The client ID of the
* thread using the collection will be used. Client ID's can be
* changed explicity on each proxy using is_member.
*/
int insert (ACE_Token_Proxy &token);
/**
* Removes the ACE_Token matching the given token_name from the
* collection. On success, extract returns 0. On failure
* (token_name was not in the collection,) extract returns -1. On
* success, the state of the token found is copied into proxy.
* The returned ACE_Token_Proxy* must be deleted by the user.
*/
int extract (const ACE_TCHAR *token_name, ACE_Token_Proxy *&proxy);
/// Returns the proxy if true. 0 otherwise.
ACE_Token_Proxy *is_member (const ACE_TCHAR *token_name);
/**
* Is the specified token in the collection?
* 1, yes.
* 0, no.
*/
int is_member (const ACE_Token_Proxy &token);
// = Collective operation semantics.
// For acquire, renew, and release, there are two interfaces. Once
// interface allows an operation on a single token in the
// collection. The collective interfaces perform atomic operations
// on the entire collection. For instance, a collective acquire
// will perform an acquire for each and every token in the
// collection or the operation will fail. Currently, these
// operations are performed with no ordering heuristics. That is,
// the Collection steps through the tokens in the order they were
// inserted. For each one it performs the operation (acquire,
// renew, or release).
/**
* Acquire "atomically" all resources in the collection. This is
* only successfull if all tokens in the collection could be
* acquired. options contains the blocking semantics, timeout
* value, etc. Returns: 0 on success, -1 on failure with @c errno ==
* problem. If and error or deadlock occurs for one of the tokens,
* all the tokens will be released and the method will return -1.
* Note that returning on detection of deadlock prevents livelock
* between competing collections. If a collection returns after
* detecting deadlock, it is the application's responsibility to not
* to blindly loop on the collection::acquire operation. In other
* words, once the collection reports deadlock, it is out of our
* hands.
*/
virtual int acquire (int notify = 0,
void (*sleep_hook)(void *) = 0,
ACE_Synch_Options &options =
ACE_Synch_Options::defaults);
/// Acquire the token corresponding to @a token_name. The other
/// parameters are passed to <token>::acquire.
virtual int acquire (const ACE_TCHAR *token_name,
int notify = 0,
void (*sleep_hook)(void *) = 0,
ACE_Synch_Options &options =
ACE_Synch_Options::defaults);
/// Try to acquire all tokens in collection.
virtual int tryacquire (void (*sleep_hook)(void *) = 0);
/// Try to acquire @a token_name.
virtual int tryacquire (const ACE_TCHAR *token_name,
void (*sleep_hook)(void *) = 0);
/**
* Renews "atomically" all resources in the collection. This is
* only successfull if all tokens in the collection could be
* renewed. options contains the blocking semantics, timeout
* value, etc. Returns: 0 on success, -1 on failure with @c errno ==
* problem.
*/
virtual int renew (int requeue_position = 0,
ACE_Synch_Options &options =
ACE_Synch_Options::defaults);
/// Renew the token corresponding to @a token_name. The other
/// parameters are passed to <token>::renew.
virtual int renew (const ACE_TCHAR *token_name,
int requeue_position = 0,
ACE_Synch_Options &options =
ACE_Synch_Options::defaults);
/**
* Releases "atomically" all resources in the collection. This is
* only successfull if all tokens in the collection could be
* released. options contains the blocking semantics, timeout
* value, etc. Returns: 0 on success, -1 on failure with @c errno ==
* problem.
*/
virtual int release (ACE_Synch_Options &options =
ACE_Synch_Options::defaults);
/// Release the token corresponding to <token_name>. The other
/// parameters are passed to <token>::release.
virtual int release (const ACE_TCHAR *token_name,
ACE_Synch_Options &options =
ACE_Synch_Options::defaults);
~ACE_Token_Collection (void);
/// Dump the state of the class.
void dump () const;
/// Return the name of the collection. Not very functionally
/// important, but sometimes a useful debugging tool.
virtual const ACE_TCHAR *name () const;
protected:
typedef ACE_Token_Name TOKEN_NAME;
/// COLLECTION maintains a mapping from token names to ACE_Tokens*
typedef ACE_Map_Manager<TOKEN_NAME, ACE_Token_Proxy *, ACE_Null_Mutex>
COLLECTION;
/// COLLECTION maintains a mapping from token names to ACE_Tokens*.
COLLECTION collection_;
/// Whether to print out debug messages or not.
bool debug_;
/// Name of the collection.
ACE_TCHAR name_[ACE_MAXTOKENNAMELEN];
// = I'm not sure what these mean, but they have to be defined since they're
// pure virtual in ACE_Token_Proxy.
virtual ACE_Token_Proxy *clone () const;
virtual ACE_Tokens *create_token (const ACE_TCHAR *name);
};
ACE_END_VERSIONED_NAMESPACE_DECL
#if defined (__ACE_INLINE__)
#include "ace/Token_Collection.inl"
#endif /* __ACE_INLINE__ */
#endif /* ACE_HAS_TOKENS_LIBRARY */
#include /**/ "ace/post.h"
#endif /* ACE_TOKEN_COLLECTION_H */
|
