1 files changed, 201 insertions, 0 deletions
diff --git a/ACE/apps/JAWS/clients/Caching/URL_Properties.h b/ACE/apps/JAWS/clients/Caching/URL_Properties.h
new file mode 100644
index 00000000000..d4094ec2ebd
--- /dev/null
+++ b/ACE/apps/JAWS/clients/Caching/URL_Properties.h
@@ -0,0 +1,201 @@
+// -*- C++ -*-
+
+// $Id$
+
+// ============================================================================
+//
+// = LIBRARY
+//    none
+//
+// = FILENAME
+//    URL_Locator.h
+//
+// = AUTHOR
+//    Nanbor Wang
+//
+// ============================================================================
+
+#ifndef ACE_URL_PROPERTIES_H
+#define ACE_URL_PROPERTIES_H
+
+#include "ace/SString.h"
+
+#if !defined (ACE_LACKS_PRAGMA_ONCE)
+# pragma once
+#endif /* ACE_LACKS_PRAGMA_ONCE */
+
+#include "ace/Containers.h"
+
+class ACE_Svc_Export ACE_WString_Helper
+  // = TITLE
+  //     Some helper functions for manipulate ACE_WString.
+  //
+  // = DESCRIPTION
+  //     These functions simplify encoding/decoding of
+  //     ACE_WString objects for network communication.
+{
+public:
+  static size_t size (const ACE_WString &wstr);
+  // Returns the actual size (in bytes) required to contain the
+  // ACE_WString.
+
+  static size_t encode (void *buf, const ACE_WString &wstr);
+  // Encode <wstr> into <buf> for network communication.
+  // Return total octets consumed.
+
+  static size_t decode (void *buf);
+  // This function doesn't relate to ACE_WString directly.
+  // It converts an ACE_UINT16 string from network
+  // byte order to host byte order.  Returns size of the string.
+};
+
+class ACE_Svc_Export ACE_URL_Property
+  // = TITLE
+  //     Defines a property of a URL.
+  //
+  // = DESCRIPTION
+  //     A property contains a <name> and a <value>.
+  //     A URL may contain some properties and we can "locate"
+  //     the URL's we are looking for by examming URL for certain
+  //     properties that match our need.
+{
+public:
+  ACE_URL_Property (const char *name = 0,
+                    const char *value=0);
+  // Create a new property.
+
+  ACE_URL_Property (const ACE_UINT16 *name,
+                    const ACE_UINT16 *value);
+  // Create a new property using wchar strings.  This is mostly used
+  // to support DBCS or UNICODE.
+
+  ACE_URL_Property (const ACE_URL_Property &p);
+  // Copy constructor.
+
+  ~ACE_URL_Property (void);
+  // Destructor.
+
+  ACE_URL_Property &operator= (const ACE_URL_Property &rhs);
+  // Assignment operator.
+
+  bool operator== (const ACE_URL_Property &rhs) const;
+  // Equals operator.
+
+  bool operator!= (const ACE_URL_Property &rhs) const;
+  // Inequality operator.
+
+  // = Query property name.
+  ACE_WString &name_rep (void);
+  const ACE_WString &name (void) const;
+
+  // = Set property name.
+  void name (const ACE_UINT16 *n);
+  void name (const char *n);
+
+  // = Query property value.
+  ACE_WString &value_rep (void);
+  const ACE_WString &value (void) const;
+
+  // = Set property value.
+  void value (const ACE_UINT16 *v);
+  void value (const char *v);
+
+  // = Helper functions for encoding and decoding.
+  size_t size (void) const;
+  // Returns memory size (in bytes) required to encode this object.
+
+  size_t encode (void *buf) const;
+  // Encodes this object into buf for network transmission.
+
+  size_t decode (void *buf);
+  // Decodes buf and modifies this object, you should
+  // probably create this with default ctor.
+
+  void dump (void) const;
+  // Dump out this object for debug.
+
+protected:
+  ACE_WString name_;
+  // Property name pointer.
+
+  ACE_WString value_;
+  // Property value.
+} ;
+
+typedef ACE_Array<ACE_URL_Property> ACE_URL_Property_Seq;
+// type of URL_Property collections.
+
+class ACE_Svc_Export ACE_URL_Offer
+  // = TITLE
+  //     Defines a URL offer.
+  //
+  // = DESCRIPTION
+  //     A URL offer is defined by a <url> and an
+  //     <ACE_URL_Property_Seq>.  An offer is stored at server end
+  //     thru registering or reported back to querying client from the
+  //     sever.
+{
+public:
+  ACE_URL_Offer (const size_t size = 1, const char *url = 0);
+  // Create an offer.
+
+  ACE_URL_Offer (const ACE_URL_Offer &o);
+  // Copy ctor.
+
+  ~ACE_URL_Offer (void);
+  // Default destructor.
+
+  ACE_URL_Offer &operator= (const ACE_URL_Offer &rhs);
+  // Assignment operator.
+
+  bool operator== (const ACE_URL_Offer &rhs) const;
+  // Equality operator.
+
+  bool operator!= (const ACE_URL_Offer &rhs) const;
+  // Inequality operator.
+
+  // = Get URL string.
+  ACE_WString &url_rep (void);
+  const ACE_WString &url (void) const;
+
+  // = Set URL.
+  void url (const char *url);
+  void url (const ACE_UINT16 *url);
+
+  ACE_URL_Property_Seq &url_properties (void);
+  // Get properties of this offer.
+
+  void url_properties (const ACE_URL_Property_Seq &prop);
+  // Set properties of this offer.  This operation virtually get a
+  // copy of the passed in prop.
+
+  // = Helper functions for encoding and decoding.
+  size_t size (void) const;
+  // Returns memory size (in bytes) required to encode this object.
+
+  size_t encode (void *buf) const;
+  // Encodes this object into buf for network transmission.
+
+  size_t decode (void *buf);
+  // Decodes buf into current object, you better use
+  // the default ctor.
+
+  void dump (void) const;
+  // Dump this object for debug.
+
+protected:
+  ACE_WString url_;
+  // URL of this offer.
+
+  ACE_URL_Property_Seq prop_;
+  // Properties associate with this offer.
+};
+
+typedef ACE_Array<ACE_URL_Offer> ACE_URL_Offer_Seq;
+// type of URL offer collections.
+
+#if defined (__ACE_INLINE__)
+#include "URL_Properties.inl"
+#endif /* __ACE_INLINE__ */
+
+#endif /* ACE_WEB_PROPERTIES_H */