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
|
/* -*- C++ -*- */
//=============================================================================
/**
* @file Locator_Request_Reply.h
*
* @author Nanbor Wang
*/
//=============================================================================
#ifndef ACE_LOCATOR_REQUEST_REPLY_H
#define ACE_LOCATOR_REQUEST_REPLY_H
#include "URL_Properties.h"
/**
* @class ACE_URL_Locator_Request
*
* @brief A URL request message formater/wrapper.
*
* This class defines a URL request data. It is used
* to transform requests to an object so that we can
* ship them across network.
*/
class ACE_Svc_Export ACE_URL_Locator_Request
{
public:
/// Default ctor.
ACE_URL_Locator_Request (void);
/// Default dtor.
~ACE_URL_Locator_Request (void);
/**
* Query the locator for HTTP with designate properties (none, some,
* or all). The locator being queried will return a sequence of
* offers with <how_many> offers in it. This interface allocates
* <offer> so users must deallocate it after use.
*/
int url_query (const int how,
const ACE_URL_Property_Seq &pseq,
const int how_many);
/// Export an offer to the locator.
int export_offer (const ACE_URL_Offer &offer);
/// Withdraw an offer. return 0 if succeed, -1 otherwise.
int withdraw_offer (const ACE_WString &offer_id);
/// Query a specific offer.
int describe_offer (const ACE_WString &offer_id);
/// Modify a previously registered offer.
int modify_offer (const ACE_WString &offer_id,
const char *url = 0,
const ACE_URL_Property_Seq &del = 0,
const ACE_URL_Property_Seq &modify = 0);
/// Modify a previously registered offer.
int modify_offer (const ACE_WString &offer_id,
const ACE_WString *url = 0,
const ACE_URL_Property_Seq &del = 0,
const ACE_URL_Property_Seq &modify = 0);
/// Encode request for network communication. If succeed,
/// returns the size of the buffer, otherwise, return 0.
size_t encode (void);
/**
* Restore from network data. Returns size of the buffer
* if succeed, 0 otherwise. When passing in a buffer,
* caller must take the responsibility to delete the buffer
* afterward, if so needed.
*/
size_t decode (void *buffer);
/// A bunch of methods to access internal data.
const int how (void) const;
const int how_many (void) const;
const u_int opcode (void) const;
const ACE_URL_Property_Seq *seq (void) const;
const ACE_URL_Property_Seq *del (void) const;
const ACE_URL_Property_Seq *modify (void) const;
const ACE_URL_Offer *offer (void) const;
const ACE_WString &id (void) const;
const ACE_WString &url (void) const;
const char *buffer (void) const;
/// Print out this object.
void dump (void) const;
protected:
/// Return the size of the buffer required to encode
/// this request.
size_t size (void);
enum {
VALID_SEQ1 = 0x1,
VALID_SEQ2 = 0X2,
VALID_OFFER = 0X4
};
// These constants used to indicate which pointers are valid.
/// Request type code.
u_int code_;
/// Query method (if code_ == QUERY.)
int how_;
/// How many offers are we interested in in this query.
int how_many_;
/// Bit flag to mark valid pointers within this object.
int valid_ptr_;
/// For query or del in modify_offer.
ACE_URL_Property_Seq *seq1_;
/// For modify seq. in modify_offer.
ACE_URL_Property_Seq *seq2_;
/// Offer to export.
ACE_URL_Offer *offer_;
/// Offer ID.
ACE_WString id_;
/// URL of this offer.
ACE_WString url_;
/// Buffer to store encoded data.
char *buffer_;
};
/**
* @class ACE_URL_Locator_Reply
*
* @brief A URL reply message formater/wrapper.
*
* This class defines a URL reply data. It is used
* to transform reply messages to an object so that we can
* ship them across network.
*/
class ACE_Svc_Export ACE_URL_Locator_Reply
{
public:
/// Default ctor.
ACE_URL_Locator_Reply (void);
/// Default dtor.
~ACE_URL_Locator_Reply (void);
/// Setup a reply message for EXPORT, WITHDRAW, or MODIFY operations.
int status_reply (u_int op, int result);
/// Setup a reply for QUERY operation.
int query_reply (int result, size_t num,
const ACE_URL_Offer_Seq &offers);
/// Construct a reply for DESCRIBE operation.
int describe_reply (int result,
const ACE_URL_Offer &offer);
/// Encode request for network communication. If succeed,
/// returns the size of the buffer, otherwise, return 0.
size_t encode (void);
/**
* Restore from network data. Returns size of the buffer
* if succeed, 0 otherwise. When passing in a buffer,
* caller must take the responsibility to delete the buffer
* afterward, if so needed.
*/
size_t decode (void *buffer);
// Accessor function.
const size_t num_offers (void) const;
const ACE_URL_Offer *offer (void) const;
const ACE_URL_Offer_Seq *offers (void) const;
const u_int opcode (void) const;
const u_int status (void) const;
const char *buffer (void) const ;
/// Print out this object.
void dump (void) const ;
protected:
/// Return the size of the buffer required to encode
/// this request.
size_t size (void);
enum {
VALID_OFFER = 0x1,
VALID_OFFERS = 0x2
};
// Valid pointer masks.
/// Holds the original op code.
u_int code_;
/// Holds the result of an operation from the Location Server.
int status_;
/// Holds the number of valid offers in the offers_ sequence.
size_t num_offers_;
/// Flag that marks valid internal pointers.
int valid_ptr_;
/// Holds a single offer. Used in query offer property.
ACE_URL_Offer *offer_;
/// Holds the replying offer sequence from a Locator.
ACE_URL_Offer_Seq *offers_;
/// Buffer to store encoded data.
char *buffer_;
};
#if defined (__ACE_INLINE__)
#include "Locator_Request_Reply.inl"
#endif /* __ACE_INLINE__ */
#endif /* ACE_LOCATOR_REQUEST_REPLY_H */
|
