blob: c0e8ec2cb9a6c2e50bbd5cad3e48f155dcb10549 [file] [log] [blame]
// 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.
// Simple system resources class that uses the current message loop
// for scheduling. Assumes the current message loop is already
// running.
#include <set>
#include <string>
#include <vector>
#include "base/compiler_specific.h"
#include "base/memory/scoped_ptr.h"
#include "base/memory/weak_ptr.h"
#include "base/message_loop/message_loop.h"
#include "base/threading/non_thread_safe.h"
#include "base/values.h"
#include "components/invalidation/invalidation_export.h"
#include "components/invalidation/state_writer.h"
#include "google/cacheinvalidation/include/system-resources.h"
#include "jingle/notifier/base/notifier_options.h"
#include "sync/internal_api/public/base/invalidator_state.h"
namespace syncer {
class GCMNetworkChannelDelegate;
class SyncLogger : public invalidation::Logger {
virtual ~SyncLogger();
// invalidation::Logger implementation.
virtual void Log(LogLevel level, const char* file, int line,
const char* format, ...) OVERRIDE;
virtual void SetSystemResources(
invalidation::SystemResources* resources) OVERRIDE;
class SyncInvalidationScheduler : public invalidation::Scheduler {
virtual ~SyncInvalidationScheduler();
// Start and stop the scheduler.
void Start();
void Stop();
// invalidation::Scheduler implementation.
virtual void Schedule(invalidation::TimeDelta delay,
invalidation::Closure* task) OVERRIDE;
virtual bool IsRunningOnThread() const OVERRIDE;
virtual invalidation::Time GetCurrentTime() const OVERRIDE;
virtual void SetSystemResources(
invalidation::SystemResources* resources) OVERRIDE;
// Runs the task, deletes it, and removes it from |posted_tasks_|.
void RunPostedTask(invalidation::Closure* task);
// Holds all posted tasks that have not yet been run.
std::set<invalidation::Closure*> posted_tasks_;
const base::MessageLoop* created_on_loop_;
bool is_started_;
bool is_stopped_;
base::WeakPtrFactory<SyncInvalidationScheduler> weak_factory_;
// SyncNetworkChannel implements common tasks needed to interact with
// invalidation library:
// - registering message and network status callbacks
// - notifying observers about network channel state change
// Implementation of particular network protocol should implement
// SendMessage and call NotifyStateChange and DeliverIncomingMessage.
: public NON_EXPORTED_BASE(invalidation::NetworkChannel) {
class Observer {
// Called when network channel state changes. Possible states are:
// - INVALIDATIONS_ENABLED : connection is established and working
// - TRANSIENT_INVALIDATION_ERROR : no network, connection lost, etc.
virtual void OnNetworkChannelStateChanged(
InvalidatorState invalidator_state) = 0;
virtual ~SyncNetworkChannel();
// invalidation::NetworkChannel implementation.
// SyncNetworkChannel doesn't implement SendMessage. It is responsibility of
// subclass to implement it.
virtual void SetMessageReceiver(
invalidation::MessageCallback* incoming_receiver) OVERRIDE;
virtual void AddNetworkStatusReceiver(
invalidation::NetworkStatusCallback* network_status_receiver) OVERRIDE;
virtual void SetSystemResources(
invalidation::SystemResources* resources) OVERRIDE;
// Subclass should implement UpdateCredentials to pass new token to channel
// library.
virtual void UpdateCredentials(const std::string& email,
const std::string& token) = 0;
// Return value from GetInvalidationClientType will be passed to
// invalidation::CreateInvalidationClient. Subclass should return one of the
// values from ipc::invalidation::ClientType enum from types.proto.
virtual int GetInvalidationClientType() = 0;
// Subclass should implement RequestDetailedStatus to provide debugging
// information.
virtual void RequestDetailedStatus(
base::Callback<void(const base::DictionaryValue&)> callback) = 0;
// Classes interested in network channel state changes should implement
// SyncNetworkChannel::Observer and register here.
void AddObserver(Observer* observer);
void RemoveObserver(Observer* observer);
// Helper functions that know how to construct network channels from channel
// specific parameters.
static scoped_ptr<SyncNetworkChannel> CreatePushClientChannel(
const notifier::NotifierOptions& notifier_options);
static scoped_ptr<SyncNetworkChannel> CreateGCMNetworkChannel(
scoped_refptr<net::URLRequestContextGetter> request_context_getter,
scoped_ptr<GCMNetworkChannelDelegate> delegate);
// Get the count of how many valid received messages were received.
int GetReceivedMessagesCount() const;
// Subclass should call NotifyNetworkStatusChange to notify about network
// changes. This triggers cacheinvalidation to try resending failed message
// ahead of schedule when client comes online or IP address changes.
void NotifyNetworkStatusChange(bool online);
// Subclass should notify about connection state through
// NotifyChannelStateChange. If communication doesn't work and it is possible
// that invalidations from server will not reach this client then channel
// should call this function with TRANSIENT_INVALIDATION_ERROR.
void NotifyChannelStateChange(InvalidatorState invalidator_state);
// Subclass should call DeliverIncomingMessage for message to reach
// invalidations library.
bool DeliverIncomingMessage(const std::string& message);
typedef std::vector<invalidation::NetworkStatusCallback*>
// Callbacks into invalidation library
scoped_ptr<invalidation::MessageCallback> incoming_receiver_;
NetworkStatusReceiverList network_status_receivers_;
// Last network status for new network status receivers.
bool last_network_status_;
int received_messages_count_;
ObserverList<Observer> observers_;
class SyncStorage : public invalidation::Storage {
SyncStorage(StateWriter* state_writer, invalidation::Scheduler* scheduler);
virtual ~SyncStorage();
void SetInitialState(const std::string& value) {
cached_state_ = value;
// invalidation::Storage implementation.
virtual void WriteKey(const std::string& key, const std::string& value,
invalidation::WriteKeyCallback* done) OVERRIDE;
virtual void ReadKey(const std::string& key,
invalidation::ReadKeyCallback* done) OVERRIDE;
virtual void DeleteKey(const std::string& key,
invalidation::DeleteKeyCallback* done) OVERRIDE;
virtual void ReadAllKeys(
invalidation::ReadAllKeysCallback* key_callback) OVERRIDE;
virtual void SetSystemResources(
invalidation::SystemResources* resources) OVERRIDE;
// Runs the given storage callback with SUCCESS status and deletes it.
void RunAndDeleteWriteKeyCallback(
invalidation::WriteKeyCallback* callback);
// Runs the given callback with the given value and deletes it.
void RunAndDeleteReadKeyCallback(
invalidation::ReadKeyCallback* callback, const std::string& value);
StateWriter* state_writer_;
invalidation::Scheduler* scheduler_;
std::string cached_state_;
: public NON_EXPORTED_BASE(invalidation::SystemResources) {
SyncSystemResources(SyncNetworkChannel* sync_network_channel,
StateWriter* state_writer);
virtual ~SyncSystemResources();
// invalidation::SystemResources implementation.
virtual void Start() OVERRIDE;
virtual void Stop() OVERRIDE;
virtual bool IsStarted() const OVERRIDE;
virtual void set_platform(const std::string& platform);
virtual std::string platform() const OVERRIDE;
virtual SyncLogger* logger() OVERRIDE;
virtual SyncStorage* storage() OVERRIDE;
virtual SyncNetworkChannel* network() OVERRIDE;
virtual SyncInvalidationScheduler* internal_scheduler() OVERRIDE;
virtual SyncInvalidationScheduler* listener_scheduler() OVERRIDE;
bool is_started_;
std::string platform_;
scoped_ptr<SyncLogger> logger_;
scoped_ptr<SyncInvalidationScheduler> internal_scheduler_;
scoped_ptr<SyncInvalidationScheduler> listener_scheduler_;
scoped_ptr<SyncStorage> storage_;
// sync_network_channel_ is owned by SyncInvalidationListener.
SyncNetworkChannel* sync_network_channel_;
} // namespace syncer