third_party/WebKit/Source/platform/network/WebSocketHandshakeRequest.h

   1 /*
   2  * Copyright (C) 2010 Google Inc.  All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are
   6  * met:
   7  *
   8  *     * Redistributions of source code must retain the above copyright
   9  * notice, this list of conditions and the following disclaimer.
  10  *     * Redistributions in binary form must reproduce the above
  11  * copyright notice, this list of conditions and the following disclaimer
  12  * in the documentation and/or other materials provided with the
  13  * distribution.
  14  *     * Neither the name of Google Inc. nor the names of its
  15  * contributors may be used to endorse or promote products derived from
  16  * this software without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29  */
  30
  31 #ifndef WebSocketHandshakeRequest_h
  32 #define WebSocketHandshakeRequest_h
  33
  34 #include "platform/PlatformExport.h"
  35 #include "platform/network/HTTPHeaderMap.h"
  36 #include "platform/weborigin/KURL.h"
  37 #include "wtf/PassRefPtr.h"
  38 #include "wtf/RefCounted.h"
  39 #include "wtf/text/WTFString.h"
  40
  41 namespace blink {
  42
  43 class HTTPHeaderMap;
  44
  45 class PLATFORM_EXPORT WebSocketHandshakeRequest : public RefCounted<WebSocketHandshakeRequest> {
  46 public:
  47     static PassRefPtr<WebSocketHandshakeRequest> create(const KURL& url) { return adoptRef(new WebSocketHandshakeRequest(url)); }
  48     static PassRefPtr<WebSocketHandshakeRequest> create() { return adoptRef(new WebSocketHandshakeRequest); }
  49     static PassRefPtr<WebSocketHandshakeRequest> create(const WebSocketHandshakeRequest& request) { return adoptRef(new WebSocketHandshakeRequest(request)); }
  50     virtual ~WebSocketHandshakeRequest();
  51
  52     void addAndMergeHeader(const AtomicString& name, const AtomicString& value) { addAndMergeHeader(&m_headerFields, name, value); }
  53
  54     // Merges the existing value with |value| in |map| if |map| already has |name|.
  55     // Associates |value| with |name| in |map| otherwise.
  56     // This function builds data for inspector.
  57     static void addAndMergeHeader(HTTPHeaderMap* /* map */, const AtomicString& name, const AtomicString& value);
  58
  59     void addHeaderField(const AtomicString& name, const AtomicString& value) { m_headerFields.add(name, value); }
  60     void addHeaderField(const char* name, const char* value) { m_headerFields.add(name, value); }
  61
  62     KURL url() const { return m_url; }
  63     void setURL(const KURL& url) { m_url = url; }
  64     const HTTPHeaderMap& headerFields() const { return m_headerFields; }
  65     const String& headersText() const { return m_headersText; }
  66     void setHeadersText(const String& text) { m_headersText = text; }
  67
  68 private:
  69     WebSocketHandshakeRequest(const KURL&);
  70     WebSocketHandshakeRequest();
  71     WebSocketHandshakeRequest(const WebSocketHandshakeRequest&);
  72
  73     KURL m_url;
  74     HTTPHeaderMap m_headerFields;
  75     String m_headersText;
  76 };
  77
  78 } // namespace blink
  79
  80 #endif // WebSocketHandshakeRequest_h