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
|
/* -*- C++ -*- */
//=============================================================================
/**
* @file URL_Locator.h
*
* $Id$
*
* @author Nanbor Wang
*/
//=============================================================================
#ifndef ACE_URL_LOCATOR_H
#define ACE_URL_LOCATOR_H
#include "URL_Properties.h"
/**
* @class ACE_URL_Locator
*
* @brief Abstract Base class designates what interfaces a URL_Locator
* should provide.
*
* This class defines the basic URL_Locator APIs.
* An URL locator provides services for URL clients to
* query specific URL location that has certain properties
* and URL providers to export their services and a set of
* APIs to maintain their offers.
*/
class ACE_Svc_Export ACE_URL_Locator
{
public:
// Request type
enum ACE_URL_Locator_Op_Type
{
QUERY = 0,
EXPORT,
WITHDRAW,
DESCRIBE,
MODIFY,
INVALID_OPERATION // LAST
};
/// Human Readable operation name.
static const char * const opname[];
// = Specify how to select offers.
enum ACE_Selection_Criteria
{
NONE = 0, // URL that contains none of the properties.
SOME, // URL that contains some of the properties.
ALL, // URL that contains all of the properties.
INVALID_SELECTION // Invalid.
};
static const char * const selection_name[];
/// errno will set to one of these value.
enum ACE_URL_Locator_Error
{
OK, // Everything is fine.
OFFER_EXIST, // trying to register an offer.
// that is already exist in repository.
NO_SUCH_OFFER, // No such offer in the repository.
INVALID_ARGUMENT, // Invalid argument encountered.
UNIMPLEMENTED, // function not implemented.
UNKNOWN, // Unknown error.
MAX_URL_ERROR
};
// Possible error code of URL_Locator.
/// Human readable error status.
static const char * const err_name[];
/// Default destructor.
virtual ~ACE_URL_Locator (void) = 0;
/**
* 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.
*/
virtual int url_query (const ACE_Selection_Criteria how,
const ACE_URL_Property_Seq *pseq,
const size_t how_many,
size_t &num_query,
ACE_URL_Offer_Seq *offer) = 0;
/// Export an offer to the locator.
virtual int export_offer (ACE_URL_Offer *offer,
ACE_WString &offer_id) = 0;
/// Withdraw an offer. return 0 if succeed, -1 otherwise.
virtual int withdraw_offer (const ACE_WString &offer_id) = 0;
/// Query a specific offer.
virtual int describe_offer (const ACE_WString &offer_id,
ACE_URL_Offer *offer) = 0;
/// Modify a previously registered offer.
virtual 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) = 0;
/// Provide a human readable error status.
virtual const char *error_status (void);
};
#endif /* ACE_WEB_LOCATOR_H */
|
