extensions/browser/api/serial/serial_connection.h

   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
   3 // found in the LICENSE file.
   4
   5 #ifndef EXTENSIONS_BROWSER_API_SERIAL_SERIAL_CONNECTION_H_
   6 #define EXTENSIONS_BROWSER_API_SERIAL_SERIAL_CONNECTION_H_
   7
   8 #include <string>
   9 #include <vector>
  10
  11 #include "base/callback.h"
  12 #include "base/memory/weak_ptr.h"
  13 #include "base/time/time.h"
  14 #include "content/public/browser/browser_thread.h"
  15 #include "device/serial/serial_io_handler.h"
  16 #include "extensions/browser/api/api_resource.h"
  17 #include "extensions/browser/api/api_resource_manager.h"
  18 #include "extensions/common/api/serial.h"
  19 #include "net/base/io_buffer.h"
  20
  21 using content::BrowserThread;
  22
  23 namespace extensions {
  24
  25 // Encapsulates an open serial port.
  26 // NOTE: Instances of this object should only be constructed on the IO thread,
  27 // and all methods should only be called on the IO thread unless otherwise
  28 // noted.
  29 class SerialConnection : public ApiResource,
  30                          public base::SupportsWeakPtr<SerialConnection> {
  31  public:
  32   typedef device::SerialIoHandler::OpenCompleteCallback OpenCompleteCallback;
  33
  34   // This is the callback type expected by Receive. Note that an error result
  35   // does not necessarily imply an empty |data| string, since a receive may
  36   // complete partially before being interrupted by an error condition.
  37   typedef base::Callback<void(const std::vector<char>& data,
  38                               core_api::serial::ReceiveError error)>
  39       ReceiveCompleteCallback;
  40
  41   // This is the callback type expected by Send. Note that an error result
  42   // does not necessarily imply 0 bytes sent, since a send may complete
  43   // partially before being interrupted by an error condition.
  44   typedef base::Callback<
  45       void(int bytes_sent, core_api::serial::SendError error)>
  46       SendCompleteCallback;
  47
  48   SerialConnection(const std::string& port,
  49                    const std::string& owner_extension_id);
  50   ~SerialConnection() override;
  51
  52   // ApiResource override.
  53   bool IsPersistent() const override;
  54
  55   void set_persistent(bool persistent) { persistent_ = persistent; }
  56   bool persistent() const { return persistent_; }
  57
  58   void set_name(const std::string& name) { name_ = name; }
  59   const std::string& name() const { return name_; }
  60
  61   void set_buffer_size(int buffer_size);
  62   int buffer_size() const { return buffer_size_; }
  63
  64   void set_receive_timeout(int receive_timeout);
  65   int receive_timeout() const { return receive_timeout_; }
  66
  67   void set_send_timeout(int send_timeout);
  68   int send_timeout() const { return send_timeout_; }
  69
  70   void set_paused(bool paused);
  71   bool paused() const { return paused_; }
  72
  73   // Initiates an asynchronous Open of the device. It is the caller's
  74   // responsibility to ensure that this SerialConnection stays alive
  75   // until |callback| is run.
  76   void Open(const core_api::serial::ConnectionOptions& options,
  77             const OpenCompleteCallback& callback);
  78
  79   // Begins an asynchronous receive operation. Calling this while a Receive
  80   // is already pending is a no-op and returns |false| without calling
  81   // |callback|.
  82   bool Receive(const ReceiveCompleteCallback& callback);
  83
  84   // Begins an asynchronous send operation. Calling this while a Send
  85   // is already pending is a no-op and returns |false| without calling
  86   // |callback|.
  87   bool Send(const std::vector<char>& data,
  88             const SendCompleteCallback& callback);
  89
  90   // Flushes input and output buffers.
  91   bool Flush() const;
  92
  93   // Configures some subset of port options for this connection.
  94   // Omitted options are unchanged. Returns |true| iff the configuration
  95   // changes were successful.
  96   bool Configure(const core_api::serial::ConnectionOptions& options);
  97
  98   // Connection configuration query. Fills values in an existing
  99   // ConnectionInfo. Returns |true| iff the connection's information
 100   // was successfully retrieved.
 101   bool GetInfo(core_api::serial::ConnectionInfo* info) const;
 102
 103   // Reads current control signals (DCD, CTS, etc.) into an existing
 104   // DeviceControlSignals structure. Returns |true| iff the signals were
 105   // successfully read.
 106   bool GetControlSignals(
 107       core_api::serial::DeviceControlSignals* control_signals) const;
 108
 109   // Sets one or more control signals (DTR and/or RTS). Returns |true| iff
 110   // the signals were successfully set. Unininitialized flags in the
 111   // HostControlSignals structure are left unchanged.
 112   bool SetControlSignals(
 113       const core_api::serial::HostControlSignals& control_signals);
 114
 115   // Overrides |io_handler_| for testing.
 116   void SetIoHandlerForTest(scoped_refptr<device::SerialIoHandler> handler);
 117
 118   static const BrowserThread::ID kThreadId = BrowserThread::IO;
 119
 120  private:
 121   friend class ApiResourceManager<SerialConnection>;
 122   static const char* service_name() { return "SerialConnectionManager"; }
 123
 124   // Encapsulates a cancelable, delayed timeout task. Posts a delayed
 125   // task upon construction and implicitly cancels the task upon
 126   // destruction if it hasn't run yet.
 127   class TimeoutTask {
 128    public:
 129     TimeoutTask(const base::Closure& closure, const base::TimeDelta& delay);
 130     ~TimeoutTask();
 131
 132    private:
 133     void Run() const;
 134
 135     base::Closure closure_;
 136     base::TimeDelta delay_;
 137     base::WeakPtrFactory<TimeoutTask> weak_factory_;
 138   };
 139
 140   // Handles a receive timeout.
 141   void OnReceiveTimeout();
 142
 143   // Handles a send timeout.
 144   void OnSendTimeout();
 145
 146   // Receives read completion notification from the |io_handler_|.
 147   void OnAsyncReadComplete(int bytes_read, device::serial::ReceiveError error);
 148
 149   // Receives write completion notification from the |io_handler_|.
 150   void OnAsyncWriteComplete(int bytes_sent, device::serial::SendError error);
 151
 152   // The pathname of the serial device.
 153   std::string port_;
 154
 155   // Flag indicating whether or not the connection should persist when
 156   // its host app is suspended.
 157   bool persistent_;
 158
 159   // User-specified connection name.
 160   std::string name_;
 161
 162   // Size of the receive buffer.
 163   int buffer_size_;
 164
 165   // Amount of time (in ms) to wait for a Read to succeed before triggering a
 166   // timeout response via onReceiveError.
 167   int receive_timeout_;
 168
 169   // Amount of time (in ms) to wait for a Write to succeed before triggering
 170   // a timeout response.
 171   int send_timeout_;
 172
 173   // Flag indicating that the connection is paused. A paused connection will not
 174   // raise new onReceive events.
 175   bool paused_;
 176
 177   // Callback to handle the completion of a pending Receive() request.
 178   ReceiveCompleteCallback receive_complete_;
 179
 180   // Callback to handle the completion of a pending Send() request.
 181   SendCompleteCallback send_complete_;
 182
 183   // Closure which will trigger a receive timeout unless cancelled. Reset on
 184   // initialization and after every successful Receive().
 185   scoped_ptr<TimeoutTask> receive_timeout_task_;
 186
 187   // Write timeout closure. Reset on initialization and after every successful
 188   // Send().
 189   scoped_ptr<TimeoutTask> send_timeout_task_;
 190
 191   scoped_refptr<net::IOBuffer> receive_buffer_;
 192
 193   // Asynchronous I/O handler.
 194   scoped_refptr<device::SerialIoHandler> io_handler_;
 195 };
 196
 197 }  // namespace extensions
 198
 199 namespace mojo {
 200
 201 template <>
 202 struct TypeConverter<device::serial::HostControlSignalsPtr,
 203                      extensions::core_api::serial::HostControlSignals> {
 204   static device::serial::HostControlSignalsPtr Convert(
 205       const extensions::core_api::serial::HostControlSignals& input);
 206 };
 207
 208 template <>
 209 struct TypeConverter<device::serial::ConnectionOptionsPtr,
 210                      extensions::core_api::serial::ConnectionOptions> {
 211   static device::serial::ConnectionOptionsPtr Convert(
 212       const extensions::core_api::serial::ConnectionOptions& input);
 213 };
 214
 215 }  // namespace mojo
 216
 217 #endif  // EXTENSIONS_BROWSER_API_SERIAL_SERIAL_CONNECTION_H_