OLD | NEW |
| (Empty) |
1 // Copyright (c) 2012 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 NET_QUIC_QUIC_DATA_READER_H_ | |
6 #define NET_QUIC_QUIC_DATA_READER_H_ | |
7 | |
8 #include "base/basictypes.h" | |
9 #include "base/string_piece.h" | |
10 #include "net/base/net_export.h" | |
11 #include "net/quic/uint128.h" | |
12 | |
13 namespace net { | |
14 | |
15 // Used for reading QUIC data. Though there isn't really anything terribly | |
16 // QUIC-specific here, it's a helper class that's useful when doing QUIC | |
17 // framing. | |
18 // | |
19 // To use, simply construct a QuicDataReader using the underlying buffer that | |
20 // you'd like to read fields from, then call one of the Read*() methods to | |
21 // actually do some reading. | |
22 // | |
23 // This class keeps an internal iterator to keep track of what's already been | |
24 // read and each successive Read*() call automatically increments said iterator | |
25 // on success. On failure, internal state of the QuicDataReader should not be | |
26 // trusted and it is up to the caller to throw away the failed instance and | |
27 // handle the error as appropriate. None of the Read*() methods should ever be | |
28 // called after failure, as they will also fail immediately. | |
29 class NET_EXPORT_PRIVATE QuicDataReader { | |
30 public: | |
31 // Caller must provide an underlying buffer to work on. | |
32 QuicDataReader(const char* data, const size_t len); | |
33 | |
34 // Empty destructor. | |
35 ~QuicDataReader() {} | |
36 | |
37 // Reads a 16-bit unsigned integer into the given output parameter. | |
38 // Forwards the internal iterator on success. | |
39 // Returns true on success, false otherwise. | |
40 bool ReadUInt16(uint16* result); | |
41 | |
42 // Reads a 32-bit unsigned integer into the given output parameter. | |
43 // Forwards the internal iterator on success. | |
44 // Returns true on success, false otherwise. | |
45 bool ReadUInt32(uint32* result); | |
46 | |
47 // Reads a 48-bit unsigned integer into the given output parameter. | |
48 // Forwards the internal iterator on success. | |
49 // Returns true on success, false otherwise. | |
50 bool ReadUInt48(uint64* result); | |
51 | |
52 // Reads a 64-bit unsigned integer into the given output parameter. | |
53 // Forwards the internal iterator on success. | |
54 // Returns true on success, false otherwise. | |
55 bool ReadUInt64(uint64* result); | |
56 | |
57 // Reads a 128-bit unsigned integer into the given output parameter. | |
58 // Forwards the internal iterator on success. | |
59 // Returns true on success, false otherwise. | |
60 bool ReadUInt128(uint128* result); | |
61 // Reads a string prefixed with 16-bit length into the given output parameter. | |
62 // | |
63 // NOTE: Does not copy but rather references strings in the underlying buffer. | |
64 // This should be kept in mind when handling memory management! | |
65 // | |
66 // Forwards the internal iterator on success. | |
67 // Returns true on success, false otherwise. | |
68 bool ReadStringPiece16(base::StringPiece* result); | |
69 | |
70 // Reads a given number of bytes into the given buffer. The buffer | |
71 // must be of adequate size. | |
72 // Forwards the internal iterator on success. | |
73 // Returns true on success, false otherwise. | |
74 bool ReadStringPiece(base::StringPiece* result, size_t len); | |
75 | |
76 // Returns the remaining payload as a StringPiece. | |
77 // | |
78 // NOTE: Does not copy but rather references strings in the underlying buffer. | |
79 // This should be kept in mind when handling memory management! | |
80 // | |
81 // Forwards the internal iterator. | |
82 base::StringPiece ReadRemainingPayload(); | |
83 | |
84 // Returns the remaining payload as a StringPiece. | |
85 // | |
86 // NOTE: Does not copy but rather references strings in the underlying buffer. | |
87 // This should be kept in mind when handling memory management! | |
88 // | |
89 // DOES NOT forward the internal iterator. | |
90 base::StringPiece PeekRemainingPayload(); | |
91 | |
92 // Reads a given number of bytes into the given buffer. The buffer | |
93 // must be of adequate size. | |
94 // Forwards the internal iterator on success. | |
95 // Returns true on success, false otherwise. | |
96 bool ReadBytes(void* result, size_t size); | |
97 | |
98 // Returns true if the entirety of the underlying buffer has been read via | |
99 // Read*() calls. | |
100 bool IsDoneReading() const; | |
101 | |
102 // Returns the number of bytes remaining to be read. | |
103 size_t BytesRemaining() const; | |
104 | |
105 private: | |
106 // Returns true if the underlying buffer has enough room to read the given | |
107 // amount of bytes. | |
108 bool CanRead(size_t bytes) const; | |
109 | |
110 // To be called when a read fails for any reason. | |
111 void OnFailure(); | |
112 | |
113 // The data buffer that we're reading from. | |
114 const char* data_; | |
115 | |
116 // The length of the data buffer that we're reading from. | |
117 const size_t len_; | |
118 | |
119 // The location of the next read from our data buffer. | |
120 size_t pos_; | |
121 }; | |
122 | |
123 } // namespace net | |
124 | |
125 #endif // NET_QUIC_QUIC_DATA_READER_H_ | |
OLD | NEW |