ACE/apps/JAWS/clients/Caching/URL_Properties.h

   1 // -*- C++ -*-
   2
   3
   4 //=============================================================================
   5 /**
   6  *  @file    URL_Properties.h
   7  *
   8  *  @author Nanbor Wang
   9  */
  10 //=============================================================================
  11
  12
  13 #ifndef ACE_URL_PROPERTIES_H
  14 #define ACE_URL_PROPERTIES_H
  15
  16 #include "ace/SString.h"
  17
  18 #if !defined (ACE_LACKS_PRAGMA_ONCE)
  19 # pragma once
  20 #endif /* ACE_LACKS_PRAGMA_ONCE */
  21
  22 #include "ace/Containers.h"
  23
  24 /**
  25  * @class ACE_WString_Helper
  26  *
  27  * @brief Some helper functions for manipulate ACE_WString.
  28  *
  29  * These functions simplify encoding/decoding of
  30  * ACE_WString objects for network communication.
  31  */
  32 class ACE_Svc_Export ACE_WString_Helper
  33 {
  34 public:
  35   /// Returns the actual size (in bytes) required to contain the
  36   /// ACE_WString.
  37   static size_t size (const ACE_WString &wstr);
  38
  39   /// Encode <wstr> into <buf> for network communication.
  40   /// Return total octets consumed.
  41   static size_t encode (void *buf, const ACE_WString &wstr);
  42
  43   /**
  44    * This function doesn't relate to ACE_WString directly.
  45    * It converts an ACE_UINT16 string from network
  46    * byte order to host byte order.  Returns size of the string.
  47    */
  48   static size_t decode (void *buf);
  49 };
  50
  51 /**
  52  * @class ACE_URL_Property
  53  *
  54  * @brief Defines a property of a URL.
  55  *
  56  * A property contains a <name> and a <value>.
  57  * A URL may contain some properties and we can "locate"
  58  * the URL's we are looking for by examming URL for certain
  59  * properties that match our need.
  60  */
  61 class ACE_Svc_Export ACE_URL_Property
  62 {
  63 public:
  64   /// Create a new property.
  65   ACE_URL_Property (const char *name = 0,
  66                     const char *value=0);
  67
  68   /// Create a new property using wchar strings.  This is mostly used
  69   /// to support DBCS or UNICODE.
  70   ACE_URL_Property (const ACE_UINT16 *name,
  71                     const ACE_UINT16 *value);
  72
  73   /// Copy constructor.
  74   ACE_URL_Property (const ACE_URL_Property &p);
  75
  76   /// Destructor.
  77   ~ACE_URL_Property ();
  78
  79   /// Assignment operator.
  80   ACE_URL_Property &operator= (const ACE_URL_Property &rhs);
  81
  82   /// Equals operator.
  83   bool operator== (const ACE_URL_Property &rhs) const;
  84
  85   /// Inequality operator.
  86   bool operator!= (const ACE_URL_Property &rhs) const;
  87
  88   // = Query property name.
  89   ACE_WString &name_rep ();
  90   const ACE_WString &name () const;
  91
  92   // = Set property name.
  93   void name (const ACE_UINT16 *n);
  94   void name (const char *n);
  95
  96   // = Query property value.
  97   ACE_WString &value_rep ();
  98   const ACE_WString &value () const;
  99
 100   // = Set property value.
 101   void value (const ACE_UINT16 *v);
 102   void value (const char *v);
 103
 104   // = Helper functions for encoding and decoding.
 105   /// Returns memory size (in bytes) required to encode this object.
 106   size_t size () const;
 107
 108   /// Encodes this object into buf for network transmission.
 109   size_t encode (void *buf) const;
 110
 111   /// Decodes buf and modifies this object, you should
 112   /// probably create this with default ctor.
 113   size_t decode (void *buf);
 114
 115   /// Dump out this object for debug.
 116   void dump () const;
 117
 118 protected:
 119   /// Property name pointer.
 120   ACE_WString name_;
 121
 122   /// Property value.
 123   ACE_WString value_;
 124 } ;
 125
 126 typedef ACE_Array<ACE_URL_Property> ACE_URL_Property_Seq;
 127 // type of URL_Property collections.
 128
 129 /**
 130  * @class ACE_URL_Offer
 131  *
 132  * @brief Defines a URL offer.
 133  *
 134  * A URL offer is defined by a <url> and an
 135  * <ACE_URL_Property_Seq>.  An offer is stored at server end
 136  * thru registering or reported back to querying client from the
 137  * sever.
 138  */
 139 class ACE_Svc_Export ACE_URL_Offer
 140 {
 141 public:
 142   /// Create an offer.
 143   ACE_URL_Offer (const size_t size = 1, const char *url = 0);
 144
 145   /// Copy ctor.
 146   ACE_URL_Offer (const ACE_URL_Offer &o);
 147
 148   /// Default destructor.
 149   ~ACE_URL_Offer ();
 150
 151   /// Assignment operator.
 152   ACE_URL_Offer &operator= (const ACE_URL_Offer &rhs);
 153
 154   /// Equality operator.
 155   bool operator== (const ACE_URL_Offer &rhs) const;
 156
 157   /// Inequality operator.
 158   bool operator!= (const ACE_URL_Offer &rhs) const;
 159
 160   // = Get URL string.
 161   ACE_WString &url_rep ();
 162   const ACE_WString &url () const;
 163
 164   // = Set URL.
 165   void url (const char *url);
 166   void url (const ACE_UINT16 *url);
 167
 168   /// Get properties of this offer.
 169   ACE_URL_Property_Seq &url_properties ();
 170
 171   /// Set properties of this offer.  This operation virtually get a
 172   /// copy of the passed in prop.
 173   void url_properties (const ACE_URL_Property_Seq &prop);
 174
 175   // = Helper functions for encoding and decoding.
 176   /// Returns memory size (in bytes) required to encode this object.
 177   size_t size () const;
 178
 179   /// Encodes this object into buf for network transmission.
 180   size_t encode (void *buf) const;
 181
 182   /// Decodes buf into current object, you better use
 183   /// the default ctor.
 184   size_t decode (void *buf);
 185
 186   /// Dump this object for debug.
 187   void dump () const;
 188
 189 protected:
 190   /// URL of this offer.
 191   ACE_WString url_;
 192
 193   /// Properties associate with this offer.
 194   ACE_URL_Property_Seq prop_;
 195 };
 196
 197 typedef ACE_Array<ACE_URL_Offer> ACE_URL_Offer_Seq;
 198 // type of URL offer collections.
 199
 200 #if defined (__ACE_INLINE__)
 201 #include "URL_Properties.inl"
 202 #endif /* __ACE_INLINE__ */
 203
 204 #endif /* ACE_WEB_PROPERTIES_H */