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
|
// -*- C++ -*-
//=============================================================================
/**
* @file Local_Locator.h
*
* $Id: Local_Locator.h 93651 2011-03-28 08:49:11Z johnnyw $
*
* @author Nanbor Wang
*/
//=============================================================================
#ifndef ACE_LOCAL_LOCATOR_H
#define ACE_LOCAL_LOCATOR_H
#include "URL_Locator.h"
#include "ace/Containers.h"
#if !defined (ACE_LACKS_PRAGMA_ONCE)
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */
#include "ID_Generator.h"
/**
* @class ACE_URL_Record
*
* @brief A URL Record.
*
* A record placed in URL repository. Notice that
* both member pointers are own by URL_Record.
* They will get deallocated when the object goes
* out of scope.
*/
class ACE_Svc_Export ACE_URL_Record
{
/**
* We are making ACE_Node as friend class because we don't want
* others to access default constructor and pushing in an invalid
* record. However, container classes need to use default constructor
* for its head record.
*/
friend class ACE_URL_Local_Locator;
friend class ACE_Node<ACE_URL_Record>;
public:
/// ctor.
ACE_URL_Record (ACE_URL_Offer *offer);
/// dtor.
~ACE_URL_Record (void);
/// Two records are equal if they have the same offer id.
bool operator== (const ACE_URL_Record &rhs) const;
/// Unequal, complement of equal.
bool operator!= (const ACE_URL_Record &rhs) const;
private:
/// Default ctor. This is put here to prevent users from
/// pushing in an invalid record.
ACE_URL_Record (void);
/// Offer ID in the repository.
ACE_WString *id_;
/// Offer (and its properties).
ACE_URL_Offer *offer_;
};
/**
* @class ACE_URL_Local_Locator
*
* @brief A simple URL repository to store URL offer locally.
*
* This class manage a collection of URL offers
* for local query and registration. But we should
* really use it within a server.
*/
class ACE_Svc_Export ACE_URL_Local_Locator
{
/// Default destructor.
virtual ~ACE_URL_Local_Locator (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.
*/
virtual int url_query (const ACE_URL_Locator::ACE_Selection_Criteria how,
const ACE_URL_Property_Seq *pseq,
const size_t how_many,
size_t &num_query,
ACE_URL_Offer_Seq *offer);
/// Export an offer to the locator.
virtual int export_offer (ACE_URL_Offer *offer,
ACE_WString &offer_id);
/// Withdraw an offer. return 0 if succeed, -1 otherwise.
virtual int withdraw_offer (const ACE_WString &offer_id);
/// Query a specific offer.
virtual int describe_offer (const ACE_WString &offer_id,
ACE_URL_Offer *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);
protected:
ACE_Unbounded_Set<ACE_URL_Record> repository_;
};
#if defined (__ACE_INLINE__)
#include "Local_Locator.inl"
#endif /* __ACE_INLINE__ */
#endif /* ACE_LOCAL_LOCATOR_H */
|