Chromium side of geofencing event dispatching.

content/browser/geofencing/geofencing_manager.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_BROWSER_GEOFENCING_GEOFENCING_MANAGER_H_
 #define CONTENT_BROWSER_GEOFENCING_GEOFENCING_MANAGER_H_
 
 #include <map>
 #include <string>
 #include <vector>
 
 #include "base/callback_forward.h"
 #include "base/macros.h"
 #include "base/memory/ref_counted.h"
 #include "base/memory/scoped_ptr.h"
 #include "content/browser/geofencing/geofencing_registration_delegate.h"
+#include "content/browser/service_worker/service_worker_storage.h"
 #include "content/common/content_export.h"
 #include "content/common/geofencing_status.h"
+#include "content/common/service_worker/service_worker_status_code.h"
 
 template <typename T>
 struct DefaultSingletonTraits;
 class GURL;
 
 namespace blink {
 struct WebCircularGeofencingRegion;
 };
 
 namespace content {
 
 class GeofencingService;
 class ServiceWorkerContextWrapper;
+class ServiceWorkerRegistration;
 
 // This is the main API to the geofencing subsystem. There is one instance of
 // this class per storage partition.
 // This class is responsible for keeping track of which geofences are currently
 // registered by websites/workers, persisting this list of registrations and
 // registering them with the global |GeofencingService|.
 // This class is created on the UI thread, but all its methods should only be
 // called from the IO thread.
 // TODO(mek): Implement some kind of persistence of registrations.
+// TODO(mek): Unregister a geofence when the ServiceWorkerRegistration it
+//    belongs to goes away.
 class CONTENT_EXPORT GeofencingManager
     : NON_EXPORTED_BASE(public GeofencingRegistrationDelegate),
       public base::RefCountedThreadSafe<GeofencingManager> {
  public:
   typedef base::Callback<void(GeofencingStatus)> StatusCallback;
 
   explicit GeofencingManager(
       const scoped_refptr<ServiceWorkerContextWrapper>& service_worker_context);
 
   // Init and Shutdown are for use on the UI thread when the storagepartition is
@@ skipping 44 matching lines @@
  private:
   // Internal bookkeeping associated with each registered geofence.
   struct Registration;
 
   void InitOnIO();
   void ShutdownOnIO();
 
   // GeofencingRegistrationDelegate implementation.
   void RegistrationFinished(int64 geofencing_registration_id,
                             GeofencingStatus status) override;
+  void RegionEntered(int64 geofencing_registration_id) override;
+  void RegionExited(int64 geofencing_registration_id) override;
 
   // Looks up a particular geofence registration. Returns nullptr if no
   // registration with the given IDs exists.
   Registration* FindRegistration(int64 service_worker_registration_id,
                                  const std::string& region_id);
 
   // Looks up a particular geofence registration. Returns nullptr if no
   // registration with the given ID exists.
   Registration* FindRegistrationById(int64 geofencing_registration_id);
 
   // Registers a new registration, returning a reference to the newly inserted
   // object. Assumes no registration with the same IDs currently exists.
   Registration& AddRegistration(
       int64 service_worker_registration_id,
       const GURL& service_worker_origin,
       const std::string& region_id,
       const blink::WebCircularGeofencingRegion& region,
       const StatusCallback& callback,
       int64 geofencing_registration_id);
 
   // Clears a registration.
   void ClearRegistration(Registration* registration);
 
+  void DispatchGeofencingEvent(blink::WebGeofencingEventType event_type,

[Michael van Ouwerkerk, 2014/10/27 15:57:40]

Please document these methods. I can't tell from this header what the difference
is between 'DispatchGeofencingEvent' and 'DeliverGeofencingEvent'.

[Marijn Kruisselbrink, 2014/10/27 18:29:10]

Done.

+                               int64 geofencing_registration_id);
+  void DeliverGeofencingEvent(blink::WebGeofencingEventType event_type,
+                              int64 geofencing_registration_id,
+                              ServiceWorkerStatusCode service_worker_status,
+                              const scoped_refptr<ServiceWorkerRegistration>&
+                                  service_worker_registration);
+  void DeliverGeofencingEventEnd(const scoped_refptr<ServiceWorkerRegistration>&
+                                     service_worker_registration,
+                                 ServiceWorkerStatusCode service_worker_status);
+
   // Map of all registered regions for a particular service worker registration.
   typedef std::map<std::string, Registration> RegionIdRegistrationMap;
   // Map of service worker registration id to the regions registered by that
   // service worker.
   typedef std::map<int64, RegionIdRegistrationMap>
       ServiceWorkerRegistrationsMap;
   ServiceWorkerRegistrationsMap registrations_;
 
   // Map of all registered regions by geofencing_registration_id.
   typedef std::map<int64, RegionIdRegistrationMap::iterator>
       RegistrationIdRegistrationMap;
   RegistrationIdRegistrationMap registrations_by_id_;
 
   GeofencingService* service_;
   scoped_refptr<ServiceWorkerContextWrapper> service_worker_context_;
 
   DISALLOW_COPY_AND_ASSIGN(GeofencingManager);
 };
 
 }  // namespace content
 
 #endif  // CONTENT_BROWSER_GEOFENCING_GEOFENCING_MANAGER_H_