blob: 41414f6273d8582ee6860dbf1b0af19a05695dae (
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
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
|
// 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_PROXIMITY_AUTH_CONNECTION_H
#define COMPONENTS_PROXIMITY_AUTH_CONNECTION_H
#include "base/macros.h"
#include "base/memory/ref_counted.h"
#include "base/memory/scoped_ptr.h"
#include "base/observer_list.h"
#include "components/proximity_auth/remote_device.h"
namespace proximity_auth {
class ConnectionObserver;
class WireMessage;
// Base class representing a connection with a remote device, which is a
// persistent bidirectional channel for sending and receiving wire messages.
class Connection {
public:
enum Status {
DISCONNECTED,
IN_PROGRESS,
CONNECTED,
};
// Constructs a connection to the given |remote_device|.
explicit Connection(const RemoteDevice& remote_device);
virtual ~Connection();
// Returns true iff the connection's status is CONNECTED.
bool IsConnected() const;
// Returns true iff the connection is currently sending a message.
bool is_sending_message() const { return is_sending_message_; }
// Sends a message to the remote device.
// |OnSendCompleted()| will be called for all observers upon completion with
// either success or failure.
void SendMessage(scoped_ptr<WireMessage> message);
void AddObserver(ConnectionObserver* observer);
void RemoveObserver(ConnectionObserver* observer);
const RemoteDevice& remote_device() const { return remote_device_; }
// Abstract methods that subclasses should implement:
// Attempts to connect to the remote device if not already connected.
virtual void Connect() = 0;
// Disconnects from the remote device.
virtual void Disconnect() = 0;
protected:
// Sets the connection's status to |status|. If this is different from the
// previous status, notifies observers of the change in status.
// Virtual for testing.
virtual void SetStatus(Status status);
Status status() const { return status_; }
// Called after attempting to send bytes over the connection, whether the
// message was successfully sent or not.
// Virtual for testing.
virtual void OnDidSendMessage(const WireMessage& message, bool success);
// Called when bytes are read from the connection. There should not be a send
// in progress when this function is called.
// Virtual for testing.
virtual void OnBytesReceived(const std::string& bytes);
// Sends bytes over the connection. The implementing class should call
// OnSendCompleted() once the send succeeds or fails. At most one send will be
// in progress.
virtual void SendMessageImpl(scoped_ptr<WireMessage> message) = 0;
// Deserializes the |recieved_bytes_| and returns the resulting WireMessage,
// or NULL if the message is malformed. Sets |is_incomplete_message| to true
// if the |serialized_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|. Exposed for testing.
virtual scoped_ptr<WireMessage> DeserializeWireMessage(
bool* is_incomplete_message);
// Exposed so it is possible to override DeserializeWireMessage in
// BluetoothLowEnergyConnection class, while mantaining the same
// functionality.
// TODO(sacomoto): remove this when FakeWireMessage is not needed anymore.
const std::string& received_bytes() { return received_bytes_; }
private:
// The remote device corresponding to this connection.
const RemoteDevice remote_device_;
// The current status of the connection.
Status status_;
// The registered observers of the connection.
base::ObserverList<ConnectionObserver> observers_;
// A temporary buffer storing bytes received before a received message can be
// fully constructed.
std::string received_bytes_;
// Whether a message is currently in the process of being sent.
bool is_sending_message_;
DISALLOW_COPY_AND_ASSIGN(Connection);
};
} // namespace proximity_auth
#endif // COMPONENTS_PROXIMITY_AUTH_CONNECTION_H
|
