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
228
229
|
/* -*- C++ -*- */
// $Id$
// ============================================================================
//
// = LIBRARY
// ACE
//
// = FILENAME
// Token_Request_Reply.h
//
// = DESCRIPTION
// Define the format used to exchange messages between the
// ACE_Token Server and its clients.
//
// = AUTHOR
// Douglas C. Schmidt (schmidt@cs.wustl.edu)
// Tim Harrison (harrison@cs.wustl.edu)
//
// ============================================================================
#ifndef ACE_TOKEN_REQUEST_REPLY_H
#define ACE_TOKEN_REQUEST_REPLY_H
#include "ace/Local_Tokens.h"
#if !defined (ACE_LACKS_PRAGMA_ONCE)
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */
#include "ace/Time_Value.h"
class ACE_Export ACE_Token_Request
{
// = TITLE
// Message format for delivering requests to the ACE_Token Server.
//
// = DESCRIPTION
// This class is implemented to minimize data copying.
// In particular, all marshaling is done in situ...
public:
enum OPERATION
{
// Operation types.
ACQUIRE, // Acquire the token.
RELEASE, // Release the token.
RENEW, // Renew the token.
REMOVE, // Remove the token.
TRY_ACQUIRE
};
ACE_Token_Request (void);
// Default constructor.
ACE_Token_Request (int token_type,
int proxy_type,
ACE_UINT32 operation,
const char token_name[],
const char client_id[],
const ACE_Synch_Options &options);
// token_type - MUTEX, RWLOCK
// proxy_type - MUTEX, RLOCK, WLOCK (acquires mean different things)
// operation - method
// token_name
// client_id
// options - we check USE_TIMEOUT and use the arg.
// = Set/get the length of the encoded/decoded message.
ACE_UINT32 length (void) const;
void length (ACE_UINT32);
// = Set/get the type of proxy
int proxy_type (void) const;
void proxy_type (int proxy_type);
// = Set/get the type of token
int token_type (void) const;
void token_type (int token_type);
// = Set/get the type of the operation.
ACE_UINT32 operation_type (void) const;
void operation_type (ACE_UINT32);
// = Set/get the requeue position. These should be used when renew
// is the operation type.
ACE_UINT32 requeue_position (void) const;
void requeue_position (ACE_UINT32);
// = Set/get notify. These should be used when acquire is the operation type.
ACE_UINT32 notify (void) const;
void notify (ACE_UINT32);
// = Set/get the timeout.
ACE_Synch_Options &options (void) const;
void options (const ACE_Synch_Options &options);
// = Set/get the name of the token and the client id. The set
// method is combined to make it easier on us. We're copying the
// names as a contiguous buffer.
char *token_name (void) const;
char *client_id (void) const;
void token_name (const char *token_name, const char* client_id);
int encode (void *&);
// Encode the message before transmission.
int decode (void);
// Decode message after reception. This must be called to set the
// internal options.
void dump (void) const;
// Print out the values of the message for debugging purposes.
private:
// = The 5 fields in the <Transfer> struct are transmitted to the server.
// The remaining 2 fields are not tranferred -- they are used only on
// the server-side to simplify lookups.
struct Transfer
{
ACE_UINT32 length_;
// Length of entire request.
ACE_UINT32 token_type_;
// Type of the request (i.e., MUTEX, RLOCK, WLOCK...
ACE_UINT32 proxy_type_;
// Type of the request (i.e., MUTEX, RLOCK, WLOCK...
ACE_UINT32 operation_type_;
// Type of the request (i.e., <ACQUIRE>, <RELEASE>, <RENEW>, and <REMOVE>).
ACE_UINT32 requeue_position_;
// this only makes sense when operation type is renew
ACE_UINT32 notify_;
// this only makes sense when operation type is renew
// = ACE_Synch_Options stuff
ACE_UINT32 use_timeout_;
// Indicates if we should block forever. If 1, then <secTimeout_>
// and <usecTimeout_> indicates how long we should wait. If 0,
// then we block forever.
ACE_UINT32 sec_;
// Max seconds willing to wait for token if not blocking forever.
ACE_UINT32 usec_;
// Max micro seconds to wait for token if not blocking forever.
ACE_UINT32 arg_;
// value returned in Token_Reply::arg ();
char data_[ACE_MAXTOKENNAMELEN + ACE_MAXCLIENTIDLEN + 1];
// The data portion contains the <tokenName_> followed by a ':'
// followed by the <clientId_>.
} transfer_;
char *token_name_;
// Pointer to the beginning of the token name in this->data_.
char *client_id_;
// Pointer to the beginning of the client id in this->data_;
ACE_Synch_Options options_;
// Holds arg, sec, usec, etc.
};
class ACE_Export ACE_Token_Reply
{
// = TITLE
// Message format for delivering replies from the ACE_Token Server.
//
// = DESCRIPTION
// This class is implemented to minimize data copying.
// In particular, all marshaling is done in situ...
public:
ACE_Token_Reply (void);
// Default constructor.
// = Set/get the length of the encoded/decoded message.
ACE_UINT32 length (void) const;
void length (ACE_UINT32);
// = Set/get the errno of a reply.
ACE_UINT32 errnum (void) const;
void errnum (ACE_UINT32);
// = Set/get the arg of a reply.
ACE_UINT32 arg (void) const;
void arg (ACE_UINT32);
int encode (void *&);
// Encode the message before transfer.
int decode (void);
// Decode a message after reception.
void dump (void) const;
// Print out the values of the message for debugging purposes.
private:
// = The 2 fields in the <Transfer> struct are transmitted to the server.
struct Transfer
{
ACE_UINT32 length_;
// Length of entire reply.
ACE_UINT32 errno_;
// Indicates why error occurred if <this->type_> == <FAILURE>.
// Typical reasons include:
// <EWOULDBLOCK> (if client requested a non-blocking check for the token).
// <ETIME> (if the client timed out after waiting for the token).
// <ENOLCK> (if the token lock was removed out from underneath a waiter).
// <EACCES> (attempt to renew a token that isn't owned by the client).
ACE_UINT32 arg_;
// magic cookie
} transfer_;
};
#if defined (__ACE_INLINE__)
#include "ace/Token_Request_Reply.i"
#endif /* __ACE_INLINE__ */
#endif /* ACE_TOKEN_REQUEST_REPLY_H */
|
