1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
|
// Copyright 2013 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef NET_WEBSOCKETS_WEBSOCKET_DEFLATE_STREAM_H_
#define NET_WEBSOCKETS_WEBSOCKET_DEFLATE_STREAM_H_
#include <stddef.h>
#include <memory>
#include <string>
#include <vector>
#include "base/memory/scoped_refptr.h"
#include "net/base/completion_once_callback.h"
#include "net/base/net_export.h"
#include "net/log/net_log_with_source.h"
#include "net/websockets/websocket_deflater.h"
#include "net/websockets/websocket_frame.h"
#include "net/websockets/websocket_inflater.h"
#include "net/websockets/websocket_stream.h"
namespace net {
class WebSocketDeflateParameters;
class WebSocketDeflatePredictor;
class IOBufferWithSize;
class NetLogWithSource;
// WebSocketDeflateStream is a WebSocketStream subclass.
// WebSocketDeflateStream is for permessage-deflate WebSocket extension[1].
//
// WebSocketDeflateStream::ReadFrames and WriteFrames may change frame
// boundary. In particular, if a control frame is placed in the middle of
// data message frames, the control frame can overtake data frames.
// Say there are frames df1, df2 and cf, df1 and df2 are frames of a
// data message and cf is a control message frame. cf may arrive first and
// data frames may follow cf.
// Note that message boundary will be preserved, i.e. if the last frame of
// a message m1 is read / written before the last frame of a message m2,
// WebSocketDeflateStream will respect the order.
//
// [1]: http://tools.ietf.org/html/draft-ietf-hybi-permessage-compression-12
class NET_EXPORT_PRIVATE WebSocketDeflateStream : public WebSocketStream {
public:
WebSocketDeflateStream(std::unique_ptr<WebSocketStream> stream,
const WebSocketDeflateParameters& params,
std::unique_ptr<WebSocketDeflatePredictor> predictor);
WebSocketDeflateStream(const WebSocketDeflateStream&) = delete;
WebSocketDeflateStream& operator=(const WebSocketDeflateStream&) = delete;
~WebSocketDeflateStream() override;
// WebSocketStream functions.
int ReadFrames(std::vector<std::unique_ptr<WebSocketFrame>>* frames,
CompletionOnceCallback callback) override;
int WriteFrames(std::vector<std::unique_ptr<WebSocketFrame>>* frames,
CompletionOnceCallback callback) override;
void Close() override;
std::string GetSubProtocol() const override;
std::string GetExtensions() const override;
const NetLogWithSource& GetNetLogWithSource() const override;
private:
enum ReadingState {
READING_COMPRESSED_MESSAGE,
READING_UNCOMPRESSED_MESSAGE,
NOT_READING,
};
enum WritingState {
WRITING_COMPRESSED_MESSAGE,
WRITING_UNCOMPRESSED_MESSAGE,
WRITING_POSSIBLY_COMPRESSED_MESSAGE,
NOT_WRITING,
};
// Handles asynchronous completion of ReadFrames() call on |stream_|.
void OnReadComplete(std::vector<std::unique_ptr<WebSocketFrame>>* frames,
int result);
// This function deflates |frames| and stores the result to |frames| itself.
int Deflate(std::vector<std::unique_ptr<WebSocketFrame>>* frames);
void OnMessageStart(
const std::vector<std::unique_ptr<WebSocketFrame>>& frames,
size_t index);
int AppendCompressedFrame(
const WebSocketFrameHeader& header,
std::vector<std::unique_ptr<WebSocketFrame>>* frames_to_write);
int AppendPossiblyCompressedMessage(
std::vector<std::unique_ptr<WebSocketFrame>>* frames,
std::vector<std::unique_ptr<WebSocketFrame>>* frames_to_write);
// This function inflates |frames| and stores the result to |frames| itself.
int Inflate(std::vector<std::unique_ptr<WebSocketFrame>>* frames);
int InflateAndReadIfNecessary(
std::vector<std::unique_ptr<WebSocketFrame>>* frames);
const std::unique_ptr<WebSocketStream> stream_;
WebSocketDeflater deflater_;
WebSocketInflater inflater_;
ReadingState reading_state_ = NOT_READING;
WritingState writing_state_ = NOT_WRITING;
WebSocketFrameHeader::OpCode current_reading_opcode_ =
WebSocketFrameHeader::kOpCodeText;
WebSocketFrameHeader::OpCode current_writing_opcode_ =
WebSocketFrameHeader::kOpCodeText;
std::unique_ptr<WebSocketDeflatePredictor> predictor_;
// User callback saved for asynchronous reads.
CompletionOnceCallback read_callback_;
// References of Deflater outputs kept until next WriteFrames().
std::vector<scoped_refptr<IOBufferWithSize>> deflater_outputs_;
// References of Inflater outputs kept until next ReadFrames().
std::vector<scoped_refptr<IOBufferWithSize>> inflater_outputs_;
};
} // namespace net
#endif // NET_WEBSOCKETS_WEBSOCKET_DEFLATE_STREAM_H_
|
