src/components/copresence/public/copresence_client.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 COMPONENTS_COPRESENCE_PUBLIC_COPRESENCE_CLIENT_H_
   6 #define COMPONENTS_COPRESENCE_PUBLIC_COPRESENCE_CLIENT_H_
   7
   8 #include <string>
   9 #include <vector>
  10
  11 #include "base/callback.h"
  12 #include "base/macros.h"
  13 #include "base/memory/scoped_ptr.h"
  14 #include "base/memory/weak_ptr.h"
  15 #include "components/copresence/proto/rpcs.pb.h"
  16 #include "components/copresence/public/copresence_client_delegate.h"
  17
  18 namespace net {
  19 class URLContextGetter;
  20 }
  21
  22 namespace copresence {
  23
  24 class CopresenceClientDelegate;
  25 class RpcHandler;
  26
  27 struct PendingRequest {
  28   PendingRequest(const copresence::ReportRequest& report,
  29                  const std::string app_id,
  30                  const StatusCallback& callback);
  31   ~PendingRequest();
  32
  33   copresence::ReportRequest report;
  34   std::string app_id;
  35   StatusCallback callback;
  36 };
  37
  38 // The CopresenceClient class is the central interface for Copresence
  39 // functionality. This class handles all the initialization and delegation
  40 // of copresence tasks. Any user of copresence only needs to interact
  41 // with this client.
  42 class CopresenceClient : public base::SupportsWeakPtr<CopresenceClient> {
  43  public:
  44   // The delegate must outlive us.
  45   explicit CopresenceClient(CopresenceClientDelegate* delegate);
  46   virtual ~CopresenceClient();
  47
  48   // This method will execute a report request. Each report request can have
  49   // multiple (un)publishes, (un)subscribes. This will ensure that once the
  50   // client is initialized, it sends all request to the server and handles
  51   // the response. If an error is encountered, the status callback is used
  52   // to relay it to the requester.
  53   void ExecuteReportRequest(copresence::ReportRequest request,
  54                             const std::string& app_id,
  55                             const StatusCallback& callback);
  56
  57  private:
  58   void CompleteInitialization();
  59   void InitStepComplete(const std::string& step, bool success);
  60
  61   CopresenceClientDelegate* delegate_;
  62   bool init_failed_;
  63   std::vector<PendingRequest> pending_requests_queue_;
  64
  65   // TODO(rkc): This code is almost identical to what we use in feedback to
  66   // perform multiple blocking tasks and then run a post process method. Look
  67   // into refactoring it all out to a common construct, like maybe a
  68   // PostMultipleTasksAndReply?
  69   size_t pending_init_operations_;
  70
  71   scoped_ptr<RpcHandler> rpc_handler_;
  72
  73   DISALLOW_COPY_AND_ASSIGN(CopresenceClient);
  74 };
  75
  76 }  // namespace copresence
  77
  78 #endif  // COMPONENTS_COPRESENCE_PUBLIC_COPRESENCE_CLIENT_H_