OLD | NEW |
1 // Copyright 2014 The Chromium Authors. All rights reserved. | 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 | 2 // Use of this source code is governed by a BSD-style license that can be |
3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
4 | 4 |
5 #ifndef DEVICE_SERIAL_DATA_SINK_RECEIVER_H_ | 5 #ifndef DEVICE_SERIAL_DATA_SINK_RECEIVER_H_ |
6 #define DEVICE_SERIAL_DATA_SINK_RECEIVER_H_ | 6 #define DEVICE_SERIAL_DATA_SINK_RECEIVER_H_ |
7 | 7 |
8 #include <queue> | 8 #include <queue> |
9 | 9 |
10 #include "base/callback.h" | 10 #include "base/callback.h" |
11 #include "base/memory/linked_ptr.h" | 11 #include "base/memory/linked_ptr.h" |
12 #include "base/memory/ref_counted.h" | 12 #include "base/memory/ref_counted.h" |
13 #include "base/memory/weak_ptr.h" | 13 #include "base/memory/weak_ptr.h" |
14 #include "device/serial/buffer.h" | 14 #include "device/serial/buffer.h" |
15 #include "device/serial/data_stream.mojom.h" | 15 #include "device/serial/data_stream.mojom.h" |
16 #include "mojo/public/cpp/system/data_pipe.h" | 16 #include "mojo/public/cpp/system/data_pipe.h" |
17 | 17 |
18 namespace device { | 18 namespace device { |
19 | 19 |
20 class AsyncWaiter; | |
21 | |
22 class DataSinkReceiver : public base::RefCounted<DataSinkReceiver>, | 20 class DataSinkReceiver : public base::RefCounted<DataSinkReceiver>, |
23 public mojo::InterfaceImpl<serial::DataSink> { | 21 public mojo::InterfaceImpl<serial::DataSink> { |
24 public: | 22 public: |
25 typedef base::Callback<void(scoped_ptr<ReadOnlyBuffer>)> ReadyCallback; | 23 typedef base::Callback<void(scoped_ptr<ReadOnlyBuffer>)> ReadyCallback; |
26 typedef base::Callback<void(int32_t error)> CancelCallback; | 24 typedef base::Callback<void(int32_t error)> CancelCallback; |
27 typedef base::Callback<void()> ErrorCallback; | 25 typedef base::Callback<void()> ErrorCallback; |
28 | 26 |
29 // Constructs a DataSinkReceiver. Whenever the pipe is ready for reading, the | 27 // Constructs a DataSinkReceiver. Whenever the pipe is ready for reading, the |
30 // |ready_callback| will be called with the ReadOnlyBuffer to read. | 28 // |ready_callback| will be called with the ReadOnlyBuffer to read. |
31 // |ready_callback| will not be called again until the previous ReadOnlyBuffer | 29 // |ready_callback| will not be called again until the previous ReadOnlyBuffer |
32 // is destroyed. If a connection error occurs, |error_callback| will be called | 30 // is destroyed. If a connection error occurs, |error_callback| will be called |
33 // and the DataSinkReceiver will act as if ShutDown() had been called. If | 31 // and the DataSinkReceiver will act as if ShutDown() had been called. If |
34 // |cancel_callback| is valid, it will be called when the DataSinkClient | 32 // |cancel_callback| is valid, it will be called when the DataSinkClient |
35 // requests cancellation of the in-progress read. | 33 // requests cancellation of the in-progress read. |
36 DataSinkReceiver(const ReadyCallback& ready_callback, | 34 DataSinkReceiver(const ReadyCallback& ready_callback, |
37 const CancelCallback& cancel_callback, | 35 const CancelCallback& cancel_callback, |
38 const ErrorCallback& error_callback); | 36 const ErrorCallback& error_callback); |
39 | 37 |
40 // Shuts down this DataSinkReceiver. After shut down, |ready_callback|, | 38 // Shuts down this DataSinkReceiver. After shut down, |ready_callback|, |
41 // |cancel_callback| and |error_callback| will never be called. | 39 // |cancel_callback| and |error_callback| will never be called. |
42 void ShutDown(); | 40 void ShutDown(); |
43 | 41 |
44 private: | 42 private: |
45 class Buffer; | 43 class Buffer; |
46 class PendingFlush; | 44 class DataFrame; |
47 friend class base::RefCounted<DataSinkReceiver>; | 45 friend class base::RefCounted<DataSinkReceiver>; |
48 | 46 |
49 ~DataSinkReceiver() override; | 47 ~DataSinkReceiver() override; |
50 | 48 |
51 // mojo::InterfaceImpl<serial::DataSink> overrides. | 49 // mojo::InterfaceImpl<serial::DataSink> overrides. |
52 void Init(mojo::ScopedDataPipeConsumerHandle handle) override; | 50 void Init(uint32_t buffer_size) override; |
53 void Cancel(int32_t error) override; | 51 void Cancel(int32_t error) override; |
| 52 void OnData(mojo::Array<uint8_t> data) override; |
54 void OnConnectionError() override; | 53 void OnConnectionError() override; |
55 | 54 |
56 // Starts waiting for |handle_| to be ready for reads. | 55 // Dispatches data to |ready_callback_|. |
57 void StartWaiting(); | 56 void RunReadyCallback(); |
58 | |
59 // Invoked when |handle_| is ready for reads. | |
60 void OnDoneWaiting(MojoResult result); | |
61 | 57 |
62 // Reports a successful read of |bytes_read|. | 58 // Reports a successful read of |bytes_read|. |
63 void Done(uint32_t bytes_read); | 59 void Done(uint32_t bytes_read); |
64 | 60 |
65 // Reports a partially successful or unsuccessful read of |bytes_read| | 61 // Reports a partially successful or unsuccessful read of |bytes_read| |
66 // with an error of |error|. | 62 // with an error of |error|. |
67 void DoneWithError(uint32_t bytes_read, int32_t error); | 63 void DoneWithError(uint32_t bytes_read, int32_t error); |
68 | 64 |
69 // Finishes the two-phase data pipe read. | 65 // Marks |bytes_read| bytes as being read. |
70 bool DoneInternal(uint32_t bytes_read); | 66 bool DoneInternal(uint32_t bytes_read); |
71 | 67 |
72 // Sends an ReportBytesSentAndError message to the client. | 68 // Sends an ReportBytesSentAndError message to the client. |
73 void ReportBytesSentAndError(uint32_t bytes_read, int32_t error); | 69 void ReportBytesSentAndError(uint32_t bytes_read, int32_t error); |
74 | 70 |
75 // Invoked in response to an ReportBytesSentAndError call to the client with | 71 // Invoked in response to an ReportBytesSentAndError call to the client at |
76 // the number of bytes to flush. | 72 // the point in the data stream to flush. |
77 void SetNumBytesToFlush(uint32_t bytes_to_flush); | 73 void DoFlush(); |
78 | 74 |
79 // Reports a fatal error to the client and shuts down. | 75 // Reports a fatal error to the client and shuts down. |
80 void DispatchFatalError(); | 76 void DispatchFatalError(); |
81 | 77 |
82 // The data connection to the data sender. | 78 // The callback to call when there is data ready to read. |
83 mojo::ScopedDataPipeConsumerHandle handle_; | |
84 | |
85 // The callback to call when |handle_| has data ready to read. | |
86 const ReadyCallback ready_callback_; | 79 const ReadyCallback ready_callback_; |
87 | 80 |
88 // The callback to call when the client has requested cancellation. | 81 // The callback to call when the client has requested cancellation. |
89 const CancelCallback cancel_callback_; | 82 const CancelCallback cancel_callback_; |
90 | 83 |
91 // The callback to call if a fatal error occurs. | 84 // The callback to call if a fatal error occurs. |
92 const ErrorCallback error_callback_; | 85 const ErrorCallback error_callback_; |
93 | 86 |
94 // The queue of pending flushes. | 87 // Whether we are waiting for a flush. |
95 std::queue<linked_ptr<PendingFlush> > pending_flushes_; | 88 bool flush_pending_; |
96 | |
97 // A waiter used to wait until |handle_| is readable if we are waiting. | |
98 scoped_ptr<AsyncWaiter> waiter_; | |
99 | 89 |
100 // The buffer passed to |ready_callback_| if one exists. This is not owned, | 90 // The buffer passed to |ready_callback_| if one exists. This is not owned, |
101 // but the Buffer will call Done or DoneWithError before being deleted. | 91 // but the Buffer will call Done or DoneWithError before being deleted. |
102 Buffer* buffer_in_use_; | 92 Buffer* buffer_in_use_; |
103 | 93 |
| 94 // Whether this has received an Init() call from the client. |
| 95 bool initialized_; |
| 96 |
| 97 // The remaining number of bytes of data that we can buffer. |
| 98 uint32_t available_buffer_capacity_; |
| 99 |
| 100 // The data we have received from the client that has not been passed to |
| 101 // |ready_callback_|. |
| 102 std::queue<linked_ptr<DataFrame>> pending_data_buffers_; |
| 103 |
104 // Whether we have encountered a fatal error and shut down. | 104 // Whether we have encountered a fatal error and shut down. |
105 bool shut_down_; | 105 bool shut_down_; |
106 | 106 |
107 base::WeakPtrFactory<DataSinkReceiver> weak_factory_; | 107 base::WeakPtrFactory<DataSinkReceiver> weak_factory_; |
108 | 108 |
109 DISALLOW_COPY_AND_ASSIGN(DataSinkReceiver); | 109 DISALLOW_COPY_AND_ASSIGN(DataSinkReceiver); |
110 }; | 110 }; |
111 | 111 |
112 } // namespace device | 112 } // namespace device |
113 | 113 |
114 #endif // DEVICE_SERIAL_DATA_SINK_RECEIVER_H_ | 114 #endif // DEVICE_SERIAL_DATA_SINK_RECEIVER_H_ |
OLD | NEW |