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#if USE(ZLIB)
34#include "WebSocketDeflater.h"
35#endif
36#include "WebSocketExtensionProcessor.h"
37#include "WebSocketFrame.h"
38
39namespace WebCore {
40
41class WebSocketDeflateFramer;
42
43class DeflateResultHolder {
44 WTF_MAKE_FAST_ALLOCATED;
45public:
46 explicit DeflateResultHolder(WebSocketDeflateFramer*);
47 ~DeflateResultHolder();
48
49 bool succeeded() const { return m_succeeded; }
50 String failureReason() const { return m_failureReason; }
51
52 void fail(const String& failureReason);
53
54private:
55 WebSocketDeflateFramer* m_framer;
56 bool m_succeeded;
57 String m_failureReason;
58};
59
60class InflateResultHolder {
61 WTF_MAKE_FAST_ALLOCATED;
62public:
63 explicit InflateResultHolder(WebSocketDeflateFramer*);
64 ~InflateResultHolder();
65
66 bool succeeded() const { return m_succeeded; }
67 String failureReason() const { return m_failureReason; }
68
69 void fail(const String& failureReason);
70
71private:
72 WebSocketDeflateFramer* m_framer;
73 bool m_succeeded;
74 String m_failureReason;
75};
76
77class WebSocketDeflateFramer {
78public:
79 WebSocketDeflateFramer();
80
81 std::unique_ptr<WebSocketExtensionProcessor> createExtensionProcessor();
82
83 bool canDeflate() const;
84 bool enabled() const { return m_enabled; }
85
86 std::unique_ptr<DeflateResultHolder> deflate(WebSocketFrame&);
87 void resetDeflateContext();
88 std::unique_ptr<InflateResultHolder> inflate(WebSocketFrame&);
89 void resetInflateContext();
90
91 void didFail();
92
93#if USE(ZLIB)
94 void enableDeflate(int windowBits, WebSocketDeflater::ContextTakeOverMode);
95#endif
96
97private:
98 bool m_enabled;
99#if USE(ZLIB)
100 std::unique_ptr<WebSocketDeflater> m_deflater;
101 std::unique_ptr<WebSocketInflater> m_inflater;
102#endif
103};
104
105} // namespace WebCore
106