sync/notifier/invalidator_factory.h

// Copyright 2012 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 SYNC_NOTIFIER_INVALIDATOR_FACTORY_H_
#define SYNC_NOTIFIER_INVALIDATOR_FACTORY_H_

#include <string>

#include "base/memory/weak_ptr.h"
#include "jingle/notifier/base/notifier_options.h"
#include "sync/base/sync_export.h"
#include "sync/internal_api/public/util/weak_handle.h"
#include "sync/notifier/invalidation_state_tracker.h"

namespace syncer {

class Invalidator;

// Class to instantiate various implementations of the Invalidator
// interface.
class SYNC_EXPORT InvalidatorFactory {
 public:
  // |client_info| is a string identifying the client, e.g. a user
  // agent string.  |invalidation_state_tracker| may be NULL (for
  // tests).
  InvalidatorFactory(
      const notifier::NotifierOptions& notifier_options,
      const std::string& client_info,
      const base::WeakPtr<InvalidationStateTracker>&
          invalidation_state_tracker);
  ~InvalidatorFactory();

  // Creates an invalidator. Caller takes ownership of the returned
  // object.  However, the returned object must not outlive the
  // factory from which it was created.  Can be called on any thread.
  Invalidator* CreateInvalidator();

 private:
  const notifier::NotifierOptions notifier_options_;
  const std::string client_info_;
  const InvalidationStateMap initial_invalidation_state_map_;
  const std::string invalidation_bootstrap_data_;
  const WeakHandle<InvalidationStateTracker>
      invalidation_state_tracker_;
};

}  // namespace syncer

#endif  // SYNC_NOTIFIER_INVALIDATOR_FACTORY_H_