OLD | NEW |
| (Empty) |
1 // Copyright 2014 The Chromium Authors. All rights reserved. | |
2 // Use of this source code is governed by a BSD-style license that can be | |
3 // found in the LICENSE file. | |
4 | |
5 #ifndef COMPONENTS_CAST_CHANNEL_CAST_FRAMER_H_ | |
6 #define COMPONENTS_CAST_CHANNEL_CAST_FRAMER_H_ | |
7 | |
8 #include <stddef.h> | |
9 #include <stdint.h> | |
10 | |
11 #include <memory> | |
12 #include <string> | |
13 | |
14 #include "base/macros.h" | |
15 #include "components/cast_channel/cast_channel_enum.h" | |
16 #include "net/base/io_buffer.h" | |
17 | |
18 namespace cast_channel { | |
19 class CastMessage; | |
20 | |
21 // Class for constructing and parsing CastMessage packet data. | |
22 class MessageFramer { | |
23 public: | |
24 using ChannelError = ::cast_channel::ChannelError; | |
25 | |
26 // |input_buffer|: The input buffer used by all socket read operations that | |
27 // feed data into the framer. | |
28 explicit MessageFramer(scoped_refptr<net::GrowableIOBuffer> input_buffer); | |
29 ~MessageFramer(); | |
30 | |
31 // The number of bytes required from |input_buffer| to complete the | |
32 // CastMessage being read. | |
33 // Returns zero if |error_| is true (framer is in an invalid state.) | |
34 size_t BytesRequested(); | |
35 | |
36 // Serializes |message_proto| into |message_data|. | |
37 // Returns true if the message was serialized successfully, false otherwise. | |
38 static bool Serialize(const CastMessage& message_proto, | |
39 std::string* message_data); | |
40 | |
41 // Reads bytes from |input_buffer_| and returns a new CastMessage if one | |
42 // is fully read. | |
43 // | |
44 // |num_bytes| The number of bytes received by a read operation. | |
45 // Value must be <= BytesRequested(). | |
46 // |message_length| Size of the deserialized message object, in bytes. For | |
47 // logging purposes. Set to zero if no message was parsed. | |
48 // |error| The result of the ingest operation. Set to CHANNEL_ERROR_NONE | |
49 // if no error occurred. | |
50 // Returns A pointer to a parsed CastMessage if a message was received | |
51 // in its entirety, nullptr otherwise. | |
52 std::unique_ptr<CastMessage> Ingest(size_t num_bytes, | |
53 size_t* message_length, | |
54 ChannelError* error); | |
55 | |
56 // Message header struct. If fields are added, be sure to update | |
57 // header_size(). Public to allow use of *_size() methods in unit tests. | |
58 struct MessageHeader { | |
59 MessageHeader(); | |
60 // Sets the message size. | |
61 void SetMessageSize(size_t message_size); | |
62 // Prepends this header to |str|. | |
63 void PrependToString(std::string* str); | |
64 // Reads |header| from the bytes specified by |data|. | |
65 static void Deserialize(char* data, MessageHeader* header); | |
66 // Size (in bytes) of the message header. | |
67 static size_t header_size(); | |
68 // Maximum size (in bytes) of a message payload on the wire (does not | |
69 // include header). | |
70 static size_t max_message_size(); | |
71 std::string ToString(); | |
72 // The size of the following protocol message in bytes, in host byte order. | |
73 size_t message_size; | |
74 }; | |
75 | |
76 private: | |
77 enum MessageElement { HEADER, BODY }; | |
78 | |
79 // Prepares the framer for ingesting a new message. | |
80 void Reset(); | |
81 | |
82 // The element of the message that will be read on the next call to Ingest(). | |
83 MessageElement current_element_; | |
84 | |
85 // Total size of the message, in bytes (head + body). | |
86 size_t message_bytes_received_; | |
87 | |
88 // Size of the body alone, in bytes. | |
89 size_t body_size_; | |
90 | |
91 // Input buffer which carries message data read from the socket. | |
92 // Caller is responsible for writing into this buffer. | |
93 scoped_refptr<net::GrowableIOBuffer> input_buffer_; | |
94 | |
95 // Disables Ingest functionality is the parser receives invalid data. | |
96 bool error_; | |
97 | |
98 DISALLOW_COPY_AND_ASSIGN(MessageFramer); | |
99 }; | |
100 } // namespace cast_channel | |
101 #endif // COMPONENTS_CAST_CHANNEL_CAST_FRAMER_H_ | |
OLD | NEW |