Stablized HTTP access on all platforms. (issue #54, issue #11)

[bamtools.git] / src / api / internal / io / HttpHeader_p.h

diff --git a/src/api/internal/io/HttpHeader_p.h b/src/api/internal/io/HttpHeader_p.h
index 764ff633e0368508b1e92c75fbcfd479cb4b2d8a..6b838ff6c06d123d19cd2145c22bfc58087d0f3f 100644 (file)
--- a/src/api/internal/io/HttpHeader_p.h
+++ b/src/api/internal/io/HttpHeader_p.h
@@ -1,6 +1,26 @@
+// ***************************************************************************
+// HttpHeader_p.h (c) 2011 Derek Barnett
+// Marth Lab, Department of Biology, Boston College
+// ---------------------------------------------------------------------------
+// Last modified: 13 January 2012 (DB)
+// ---------------------------------------------------------------------------
+// Provides a generic interface for parsing/generating HTTP headers, along
+// with specialized request & response header types
+// ***************************************************************************
+
 #ifndef HTTP_HEADER_P_H
 #define HTTP_HEADER_P_H
 
+//  -------------
+//  W A R N I N G
+//  -------------
+//
+// This file is not part of the BamTools API.  It exists purely as an
+// implementation detail. This header file may change from version to version
+// without notice, or even be removed.
+//
+// We mean it.
+
 #include "api/api_global.h"
 #include <map>
 #include <string>
@@ -21,7 +41,7 @@ class HttpHeader {
 
         // header field=>value access
         bool ContainsKey(const std::string& key) const;
-        std::string GetValue(const std::string& key) const;
+        std::string GetValue(const std::string& key);
         void RemoveField(const std::string& key);
         void SetField(const std::string& key, const std::string& value);
 
@@ -55,7 +75,7 @@ class HttpRequestHeader : public HttpHeader {
 
     // ctor & dtor
     public:
-        HttpRequestHeader(const std::string& method,      // "GET", "PUT", etc
+        HttpRequestHeader(const std::string& method,      // "GET", "HEAD", ...
                           const std::string& resource,    // filename
                           int majorVersion = 1,           // version info
                           int minorVersion = 1);