diff options
Diffstat (limited to 'ACE/apps/JAWS/clients/Caching/URL_Locator.h')
| -rw-r--r-- | ACE/apps/JAWS/clients/Caching/URL_Locator.h | 75 |
1 files changed, 38 insertions, 37 deletions
diff --git a/ACE/apps/JAWS/clients/Caching/URL_Locator.h b/ACE/apps/JAWS/clients/Caching/URL_Locator.h index 751de52cfe5..a78155f9dae 100644 --- a/ACE/apps/JAWS/clients/Caching/URL_Locator.h +++ b/ACE/apps/JAWS/clients/Caching/URL_Locator.h @@ -1,36 +1,35 @@ /* -*- C++ -*- */ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// none -// -// = FILENAME -// URL_Locator.h -// -// = AUTHOR -// Nanbor Wang -// -// ============================================================================ + +//============================================================================= +/** + * @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 - // = TITLE - // Abstract Base class designates what interfaces a URL_Locator - // should provide. - // - // = DESCRIPTION - // 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. { public: // Request type @@ -44,8 +43,8 @@ public: INVALID_OPERATION // LAST }; + /// Human Readable operation name. static const char * const opname[]; - // Human Readable operation name. // = Specify how to select offers. enum ACE_Selection_Criteria @@ -58,8 +57,8 @@ public: static const char * const selection_name[]; + /// errno will set to one of these value. enum ACE_URL_Locator_Error - // errno will set to one of these value. { OK, // Everything is fine. OFFER_EXIST, // trying to register an offer. @@ -72,41 +71,43 @@ public: }; // Possible error code of URL_Locator. + /// Human readable error status. static const char * const err_name[]; - // Human readable error status. + /// Default destructor. virtual ~ACE_URL_Locator (void) = 0; - // Default destructor. + /** + * 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; - // 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. + /// Export an offer to the locator. virtual int export_offer (ACE_URL_Offer *offer, ACE_WString &offer_id) = 0; - // Export an offer to the locator. + /// Withdraw an offer. return 0 if succeed, -1 otherwise. virtual int withdraw_offer (const ACE_WString &offer_id) = 0; - // Withdraw an offer. return 0 if succeed, -1 otherwise. + /// Query a specific offer. virtual int describe_offer (const ACE_WString &offer_id, ACE_URL_Offer *offer) = 0; - // Query a specific offer. + /// 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; - // Modify a previously registered offer. + /// Provide a human readable error status. virtual const char *error_status (void); - // Provide a human readable error status. }; #endif /* ACE_WEB_LOCATOR_H */ |