summaryrefslogtreecommitdiff
path: root/chromium/components/cryptauth/wire_message.h
blob: 5aed96d970ce5c653c6a8d58cf01c68520b91fae (plain)
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
// 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 COMPONENTS_CRYPTAUTH_WIRE_MESSAGE_H_
#define COMPONENTS_CRYPTAUTH_WIRE_MESSAGE_H_

#include <memory>
#include <string>

#include "base/macros.h"

namespace cryptauth {

class WireMessage {
 public:
  // Creates a WireMessage containing |payload| for feature |feature|.
  explicit WireMessage(const std::string& payload, const std::string& feature);

  // Creates a WireMessage containing |body| (a serialized JSON) as the message
  // body.
  explicit WireMessage(const std::string& body);

  virtual ~WireMessage();

  // Returns the deserialized message from |serialized_message|, or nullptr if
  // the message is malformed. Sets |is_incomplete_message| to true if the
  // message does not have enough data to parse the header, or if the message
  // length encoded in the message header exceeds the size of the
  // |serialized_message|.
  static std::unique_ptr<WireMessage> Deserialize(
      const std::string& serialized_message,
      bool* is_incomplete_message);

  // Returns a serialized representation of |this| message.
  virtual std::string Serialize() const;

  const std::string& payload() const { return payload_; }
  const std::string& feature() const { return feature_; }
  const std::string& body() const { return body_; }

 private:
  // The message payload.
  const std::string payload_;

  // The feature which sends or intends to receive this message (e.g.,
  // EasyUnlock).
  const std::string feature_;

  // The message body. When this is set |payload_| and |feature_| are empty, and
  // vice-versa.
  const std::string body_;

  DISALLOW_COPY_AND_ASSIGN(WireMessage);
};

}  // namespace cryptauth

#endif  // COMPONENTS_CRYPTAUTH_WIRE_MESSAGE_H_