OLD | NEW |
| (Empty) |
1 /* | |
2 * Copyright (C) 2013 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 WebSocketPerMessageDeflate_h | |
32 #define WebSocketPerMessageDeflate_h | |
33 | |
34 #include "modules/websockets/WebSocketDeflater.h" | |
35 #include "modules/websockets/WebSocketExtensionProcessor.h" | |
36 #include "modules/websockets/WebSocketFrame.h" | |
37 #include "wtf/OwnPtr.h" | |
38 #include "wtf/PassOwnPtr.h" | |
39 | |
40 namespace blink { | |
41 | |
42 // WebSocketPerMessageDeflate is a deflater / inflater for a WebSocket message w
ith DEFLATE algorithm. | |
43 // See http://tools.ietf.org/html/draft-ietf-hybi-permessage-compression-08 | |
44 class WebSocketPerMessageDeflate { | |
45 public: | |
46 WebSocketPerMessageDeflate(); | |
47 | |
48 PassOwnPtr<WebSocketExtensionProcessor> createExtensionProcessor(); | |
49 | |
50 void enable(int windowBits, WebSocketDeflater::ContextTakeOverMode); | |
51 bool enabled() const { return m_enabled; } | |
52 | |
53 // Deflate the given frame. | |
54 // Return true if the method succeeds. | |
55 // The method succeeds and does nothing if this object is not enabled. | |
56 // This method may rewrite the parameter. | |
57 // If the compression is done, the payload member of the frame will point th
e internal buffer | |
58 // and the pointer will be valid until resetDeflateBuffer is called. | |
59 bool deflate(WebSocketFrame&); | |
60 | |
61 // Reset the internal buffer used by deflate. | |
62 // You must call this method between consecutive calls of the deflate method
. | |
63 void resetDeflateBuffer(); | |
64 | |
65 // Inflate the given frame. | |
66 // Return true if the method succeeds. | |
67 // The method succeeds and does nothing if this object is not enabled. | |
68 // This method may rewrite the parameter. | |
69 // If the decompression is done, the payload member of the frame will point
the internal buffer | |
70 // and the pointer will be valid until resetInflateBuffer is called. | |
71 bool inflate(WebSocketFrame&); | |
72 | |
73 // Reset the internal buffer used by inflate. | |
74 // You must call this method between consecutive calls of the inflate method
. | |
75 void resetInflateBuffer(); | |
76 | |
77 // Return the reason of the last failure in inflate or deflate. | |
78 String failureReason() { return m_failureReason; } | |
79 | |
80 void didFail(); | |
81 | |
82 private: | |
83 bool m_enabled; | |
84 bool m_deflateOngoing; | |
85 bool m_inflateOngoing; | |
86 String m_failureReason; | |
87 OwnPtr<WebSocketDeflater> m_deflater; | |
88 OwnPtr<WebSocketInflater> m_inflater; | |
89 }; | |
90 | |
91 } | |
92 | |
93 #endif // WebSocketPerMessageDeflate_h | |
OLD | NEW |