bluetooth: Subscribe to notifications

content/renderer/bluetooth/bluetooth_dispatcher.h

 // 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 CONTENT_CHILD_BLUETOOTH_BLUETOOTH_DISPATCHER_H_
 #define CONTENT_CHILD_BLUETOOTH_BLUETOOTH_DISPATCHER_H_
 
+#include <queue>
+
 #include "base/id_map.h"
 #include "base/memory/ref_counted.h"
 #include "content/common/bluetooth/bluetooth_device.h"
 #include "content/public/child/worker_thread.h"
 #include "third_party/WebKit/public/platform/modules/bluetooth/WebBluetooth.h"
 #include "third_party/WebKit/public/platform/modules/bluetooth/WebBluetoothError.h"
 
 namespace base {
 class MessageLoop;
 class TaskRunner;
 }
 
+namespace blink {
+class WebBluetoothGATTCharacteristic;
+}
+
 namespace IPC {
 class Message;
 }
 
 struct BluetoothCharacteristicRequest;
 struct BluetoothPrimaryServiceRequest;
+struct BluetoothNotificationsRequest;
 
 namespace content {
 class ThreadSafeSender;
 
 // Dispatcher for child process threads which communicates to the browser's
 // BluetoothDispatcherHost.
 //
 // Instances are created for each thread as necessary by WebBluetoothImpl.
 //
 // Incoming IPC messages are received by the BluetoothMessageFilter and
@@ skipping 26 matching lines @@
 
   void getCharacteristic(
       const blink::WebString& service_instance_id,
       const blink::WebString& characteristic_uuid,
       blink::WebBluetoothGetCharacteristicCallbacks* callbacks);
   void readValue(const blink::WebString& characteristic_instance_id,
                  blink::WebBluetoothReadValueCallbacks* callbacks);
   void writeValue(const blink::WebString& characteristic_instance_id,
                   const std::vector<uint8_t>& value,
                   blink::WebBluetoothWriteValueCallbacks*);
+  void startNotifications(const blink::WebString& characteristic_instance_id,
+                          blink::WebBluetoothGATTCharacteristic* delegate,
+                          blink::WebBluetoothNotificationsCallbacks*);
+  void stopNotifications(const blink::WebString& characteristic_instance_id,
+                         blink::WebBluetoothGATTCharacteristic* delegate,
+                         blink::WebBluetoothNotificationsCallbacks*);
+  void characteristicObjectRemoved(
+      const blink::WebString& characteristic_instance_id,
+      blink::WebBluetoothGATTCharacteristic* delegate);
 
   // WorkerThread::Observer implementation.
   void WillStopCurrentWorkerThread() override;
 
+  enum class NotificationsRequestType { START = 0, STOP = 1 };
+
  private:
+  // To avoid races and sending unnecessary IPC messages we implement

[scheib, 2015/10/01 22:05:23]

Title this block so for readability and so it can be reference. 
// Notifications Queueing Note:

[ortuno, 2015/10/03 04:03:04]

Done.

+  // a queueing system for notification requests. When receiving
+  // a notification request, the request is immediately queued. If
+  // there are no other pending requests then the request is processed.
+  // When a characteristic object gets destroyed BluetoothDispatcher
+  // gets notified by characteristicObjectRemoved. When this happens
+  // a stop request should be queued if the characteristic was subscribed
+  // to notifications.
+
+  // Helper functions for notification requests queue.

[scheib, 2015/10/01 22:05:23]

End in a colon and blank line to show that this applies to the group.

[ortuno, 2015/10/03 04:03:04]

Done.

+  // Creates a notification request and queues it.
+  int QueueNotificationRequest(
+      const std::string& characteristic_instance_id,
+      blink::WebBluetoothGATTCharacteristic* characteristic,
+      blink::WebBluetoothNotificationsCallbacks* callbacks,
+      NotificationsRequestType type);
+  // Pops the last requests and runs the next request in the queue.
+  void ProcessQueuedNotificationRequests(int request_id);

[scheib, 2015/10/01 22:05:23]

ProcessQueuedNotificationRequests -> PopNotificationRequestQueueAndProcessNext

[ortuno, 2015/10/03 04:03:04]

Done.

+  // Check if there is more than one request in the queue i.e. if there

[scheib, 2015/10/01 22:05:23]

"Checks if ..." (from guide, see 'descriptive')
http://google-styleguide.googlecode.com/svn/trunk/cppguide.html#Function_Comm...

Also a few methods below.

[ortuno, 2015/10/03 04:03:03]

Done.

+  // are other requests besides the one being processed.
+  bool PendingNotificationRequest(

[scheib, 2015/10/01 22:05:23]

PendingNotificationRequest -> HasUnsentNotificationRequest

[ortuno, 2015/10/03 04:03:04]

Unset doesn't reflect the state of the notification request. What about
HasNotificationRequestResponsePending?

[scheib, 2015/10/04 01:35:58]

SG

+      const std::string& characteristic_instance_id);
+  // Check if there are any objects subscribed to the characteristic's
+  // notifications.
+  bool HasActiveNotificationSubscription(
+      const std::string& characteristic_instance_id);
+  // Add the object to the set of subscribed objects to a characteristic's
+  // notifications.
+  void AddToActiveNotificationSubscriptions(
+      const std::string& characteristic_instance_id,
+      blink::WebBluetoothGATTCharacteristic* characteristic);
+  // Remove the object from the set of subscribed object to the
+  // characteristic's notifications. Returns if the subscription

[scheib, 2015/10/01 22:05:23]

Returns true if

[ortuno, 2015/10/03 04:03:03]

Done.

+  // becomes inactive.
+  bool RemoveFromActiveNotificationSubscriptions(
+      const std::string& characteristic_instance_id,
+      blink::WebBluetoothGATTCharacteristic* characteristic);
+
+  // The following functions decide whether to resolve the request immediately
+  // or send an IPC to change the subscription state.
+  // You should never call this functions if PendingNotificationRequest

[scheib, 2015/10/01 22:05:23]

'call these functions'

[ortuno, 2015/10/03 04:03:04]

Done.

+  // is true since there is currently another request being processed.
+  void processStartNotificationsRequest(int request_id);

[scheib, 2015/10/01 22:05:23]

processStartNotificationsRequest -> SendStartNotificationsRequestIfNeeded

[ortuno, 2015/10/03 04:03:04]

bikeshedding: ResolveOrSendStartNotificationsRequest()?

[scheib, 2015/10/04 01:35:58]

SG

+  void processStopNotificationsRequest(int request_id);
+
   // IPC Handlers, see definitions in bluetooth_messages.h.
   void OnRequestDeviceSuccess(int thread_id,
                               int request_id,
                               const BluetoothDevice& device);
   void OnRequestDeviceError(int thread_id,
                             int request_id,
                             blink::WebBluetoothError error);
-
   void OnConnectGATTSuccess(int thread_id,
                             int request_id,
                             const std::string& message);
-
   void OnConnectGATTError(int thread_id,
                           int request_id,
                           blink::WebBluetoothError error);
   void OnGetPrimaryServiceSuccess(int thread_id,
                                   int request_id,
                                   const std::string& service_instance_id);
   void OnGetPrimaryServiceError(int thread_id,
                                 int request_id,
                                 blink::WebBluetoothError error);
   void OnGetCharacteristicSuccess(
       int thread_id,
       int request_id,
       const std::string& characteristic_instance_id);
   void OnGetCharacteristicError(int thread_id,
                                 int request_id,
                                 blink::WebBluetoothError error);
   void OnReadValueSuccess(int thread_id,
                           int request_id,
                           const std::vector<uint8_t>& value);
   void OnReadValueError(int thread_id,
                         int request_id,
                         blink::WebBluetoothError error);
   void OnWriteValueSuccess(int thread_id, int request_id);
   void OnWriteValueError(int thread_id,
                          int request_id,
                          blink::WebBluetoothError error);
+  void OnStartNotificationsSuccess(int thread_id, int request_id);
+  void OnStartNotificationsError(int thread_id,
+                                 int request_id,
+                                 blink::WebBluetoothError error);
+  void OnStopNotificationsSuccess(int thread_id, int request_id);
 
   scoped_refptr<ThreadSafeSender> thread_safe_sender_;
 
+  // Map of characteristic_instance_id to a queue of Notification Requests' IDs.
+  // See note about why we queue notifications above.

[scheib, 2015/10/01 22:05:23]

Refer to note by name (so that it can be text searched easily), and location.
See "Notifications Queueing Note" above.

Also, this is a map of queues, but the name makes it seem like a single queue of
notification requests. Consider name: notification_queues_ or
notification_request_queues_.

[ortuno, 2015/10/03 04:03:04]

Done.
Done.

+  std::map<std::string, std::queue<int>> queued_notification_requests_;
+
   // Tracks device requests sent to browser to match replies with callbacks.
   // Owns callback objects.
   IDMap<blink::WebBluetoothRequestDeviceCallbacks, IDMapOwnPointer>
       pending_requests_;
   // Tracks requests to connect to a device.
   // Owns callback objects.
   IDMap<blink::WebBluetoothConnectGATTCallbacks, IDMapOwnPointer>
       pending_connect_requests_;
   // Tracks requests to get a primary service from a device.
   // Owns request objects.
   IDMap<BluetoothPrimaryServiceRequest, IDMapOwnPointer>
       pending_primary_service_requests_;
   // Tracks requests to get a characteristic from a service.
   IDMap<BluetoothCharacteristicRequest, IDMapOwnPointer>
       pending_characteristic_requests_;
   // Tracks requests to read from a characteristics.
   IDMap<blink::WebBluetoothReadValueCallbacks, IDMapOwnPointer>
       pending_read_value_requests_;
   IDMap<blink::WebBluetoothWriteValueCallbacks, IDMapOwnPointer>
       pending_write_value_requests_;
+  IDMap<BluetoothNotificationsRequest, IDMapOwnPointer>
+      pending_notifications_requests_;
+
+  // Map of characteristic_instance_id to a set of
+  // WebBluetoothGATTCharacteristic pointers. Keeps track of which
+  // objects are subscribed to notifications.
+  std::map<std::string, std::set<blink::WebBluetoothGATTCharacteristic*>>
+      active_notification_subscriptions_;
 
   DISALLOW_COPY_AND_ASSIGN(BluetoothDispatcher);
 };
 
 }  // namespace content
 
 #endif  // CONTENT_CHILD_BLUETOOTH_BLUETOOTH_DISPATCHER_H_