Use "= default" to denote default constructor or destructor
[WebKit-https.git] / Source / WebCore / Modules / websockets / WebSocketExtensionProcessor.h
1 /*
2  * Copyright (C) 2012 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 #pragma once
32
33 #include <wtf/HashMap.h>
34 #include <wtf/text/WTFString.h>
35
36 namespace WebCore {
37
38 class WebSocketExtensionProcessor {
39 public:
40     virtual ~WebSocketExtensionProcessor() = default;
41
42     String extensionToken() const { return m_extensionToken; }
43
44     // The return value of this method will be a part of the value of
45     // Sec-WebSocket-Extensions.
46     virtual String handshakeString() = 0;
47
48     // This should validate the server's response parameters which are passed
49     // as HashMap<key, value>. This may also do something for the extension.
50     // Note that this method may be called more than once when the server
51     // response contains duplicate extension token that matches extensionToken().
52     virtual bool processResponse(const HashMap<String, String>&) = 0;
53
54     // If procecssResponse() returns false, this should provide the reason.
55     virtual String failureReason() { return "Extension " + m_extensionToken + " failed"; }
56
57 protected:
58     explicit WebSocketExtensionProcessor(const String& extensionToken)
59         : m_extensionToken(extensionToken)
60     {
61     }
62
63 private:
64     String m_extensionToken;
65 };
66
67 } // namespace WebCore