| Index: extensions/browser/api/cast_channel/cast_framer.h
|
| diff --git a/extensions/browser/api/cast_channel/cast_framer.h b/extensions/browser/api/cast_channel/cast_framer.h
|
| new file mode 100644
|
| index 0000000000000000000000000000000000000000..8a5b6b535ff188d86765f8418c8949f4a32588fe
|
| --- /dev/null
|
| +++ b/extensions/browser/api/cast_channel/cast_framer.h
|
| @@ -0,0 +1,105 @@
|
| +// Copyright 2014 The Chromium Authors. All rights reserved.
|
| +// Use of this source code is governed by a BSD-style license that can be
|
| +// found in the LICENSE file.
|
| +
|
| +#ifndef EXTENSIONS_BROWSER_API_CAST_CHANNEL_CAST_FRAMER_H_
|
| +#define EXTENSIONS_BROWSER_API_CAST_CHANNEL_CAST_FRAMER_H_
|
| +
|
| +#include <stddef.h>
|
| +#include <stdint.h>
|
| +
|
| +#include <memory>
|
| +#include <string>
|
| +
|
| +#include "base/macros.h"
|
| +#include "components/cast_channel/cast_channel_enum.h"
|
| +#include "net/base/io_buffer.h"
|
| +
|
| +namespace extensions {
|
| +namespace api {
|
| +namespace cast_channel {
|
| +class CastMessage;
|
| +
|
| +// Class for constructing and parsing CastMessage packet data.
|
| +class MessageFramer {
|
| + public:
|
| + using ChannelError = ::cast_channel::ChannelError;
|
| +
|
| + // |input_buffer|: The input buffer used by all socket read operations that
|
| + // feed data into the framer.
|
| + explicit MessageFramer(scoped_refptr<net::GrowableIOBuffer> input_buffer);
|
| + ~MessageFramer();
|
| +
|
| + // The number of bytes required from |input_buffer| to complete the
|
| + // CastMessage being read.
|
| + // Returns zero if |error_| is true (framer is in an invalid state.)
|
| + size_t BytesRequested();
|
| +
|
| + // Serializes |message_proto| into |message_data|.
|
| + // Returns true if the message was serialized successfully, false otherwise.
|
| + static bool Serialize(const CastMessage& message_proto,
|
| + std::string* message_data);
|
| +
|
| + // Reads bytes from |input_buffer_| and returns a new CastMessage if one
|
| + // is fully read.
|
| + //
|
| + // |num_bytes| The number of bytes received by a read operation.
|
| + // Value must be <= BytesRequested().
|
| + // |message_length| Size of the deserialized message object, in bytes. For
|
| + // logging purposes. Set to zero if no message was parsed.
|
| + // |error| The result of the ingest operation. Set to CHANNEL_ERROR_NONE
|
| + // if no error occurred.
|
| + // Returns A pointer to a parsed CastMessage if a message was received
|
| + // in its entirety, nullptr otherwise.
|
| + std::unique_ptr<CastMessage> Ingest(size_t num_bytes,
|
| + size_t* message_length,
|
| + ChannelError* error);
|
| +
|
| + // Message header struct. If fields are added, be sure to update
|
| + // header_size(). Public to allow use of *_size() methods in unit tests.
|
| + struct MessageHeader {
|
| + MessageHeader();
|
| + // Sets the message size.
|
| + void SetMessageSize(size_t message_size);
|
| + // Prepends this header to |str|.
|
| + void PrependToString(std::string* str);
|
| + // Reads |header| from the bytes specified by |data|.
|
| + static void Deserialize(char* data, MessageHeader* header);
|
| + // Size (in bytes) of the message header.
|
| + static size_t header_size();
|
| + // Maximum size (in bytes) of a message payload on the wire (does not
|
| + // include header).
|
| + static size_t max_message_size();
|
| + std::string ToString();
|
| + // The size of the following protocol message in bytes, in host byte order.
|
| + size_t message_size;
|
| + };
|
| +
|
| + private:
|
| + enum MessageElement { HEADER, BODY };
|
| +
|
| + // Prepares the framer for ingesting a new message.
|
| + void Reset();
|
| +
|
| + // The element of the message that will be read on the next call to Ingest().
|
| + MessageElement current_element_;
|
| +
|
| + // Total size of the message, in bytes (head + body).
|
| + size_t message_bytes_received_;
|
| +
|
| + // Size of the body alone, in bytes.
|
| + size_t body_size_;
|
| +
|
| + // Input buffer which carries message data read from the socket.
|
| + // Caller is responsible for writing into this buffer.
|
| + scoped_refptr<net::GrowableIOBuffer> input_buffer_;
|
| +
|
| + // Disables Ingest functionality is the parser receives invalid data.
|
| + bool error_;
|
| +
|
| + DISALLOW_COPY_AND_ASSIGN(MessageFramer);
|
| +};
|
| +} // namespace cast_channel
|
| +} // namespace api
|
| +} // namespace extensions
|
| +#endif // EXTENSIONS_BROWSER_API_CAST_CHANNEL_CAST_FRAMER_H_
|
|
|