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_SYNC_DRIVER_SYNC_FRONTEND_H_ 6 #define COMPONENTS_SYNC_DRIVER_SYNC_FRONTEND_H_ 7 8 #include "base/basictypes.h" 9 #include "sync/internal_api/public/base/model_type.h" 10 #include "sync/internal_api/public/sync_encryption_handler.h" 11 #include "sync/internal_api/public/sync_manager.h" 12 #include "sync/internal_api/public/util/weak_handle.h" 13 #include "sync/protocol/sync_protocol_error.h" 14 15 namespace syncer { 16 class DataTypeDebugInfoListener; 17 class JsBackend; 18 class ProtocolEvent; 19 struct CommitCounters; 20 struct StatusCounters; 21 struct UpdateCounters; 22 } // namespace syncer 23 24 namespace sync_pb { 25 class EncryptedData; 26 } // namespace sync_pb 27 28 namespace browser_sync { 29 30 // SyncFrontend is the interface used by SyncBackendHost to communicate with 31 // the entity that created it and, presumably, is interested in sync-related 32 // activity. 33 // NOTE: All methods will be invoked by a SyncBackendHost on the same thread 34 // used to create that SyncBackendHost. 35 class SyncFrontend { 36 public: 37 SyncFrontend(); 38 virtual ~SyncFrontend(); 39 40 // The backend has completed initialization and it is now ready to 41 // accept and process changes. If success is false, initialization 42 // wasn't able to be completed and should be retried. 43 // 44 // |js_backend| is what about:sync interacts with; it's different 45 // from the 'Backend' in 'OnBackendInitialized' (unfortunately). It 46 // is initialized only if |success| is true. 47 virtual void OnBackendInitialized( 48 const syncer::WeakHandle<syncer::JsBackend>& js_backend, 49 const syncer::WeakHandle<syncer::DataTypeDebugInfoListener>& 50 debug_info_listener, 51 bool success) = 0; 52 53 // The backend queried the server recently and received some updates. 54 virtual void OnSyncCycleCompleted() = 0; 55 56 // Configure ran into some kind of error. But it is scheduled to be 57 // retried. 58 virtual void OnSyncConfigureRetry() = 0; 59 60 // Informs the frontned of some network event. These notifications are 61 // disabled by default and must be enabled through an explicit request to the 62 // SyncBackendHost. 63 // 64 // It's disabld by default to avoid copying data across threads when no one 65 // is listening for it. 66 virtual void OnProtocolEvent(const syncer::ProtocolEvent& event) = 0; 67 68 // Called when we receive an updated commit counter for a directory type. 69 // 70 // Disabled by default. Enable by calling 71 // EnableDirectoryTypeDebugInfoForwarding() on the backend. 72 virtual void OnDirectoryTypeCommitCounterUpdated( 73 syncer::ModelType type, 74 const syncer::CommitCounters& counters) = 0; 75 76 // Called when we receive an updated update counter for a directory type. 77 // 78 // Disabled by default. Enable by calling 79 // EnableDirectoryTypeDebugInfoForwarding() on the backend. 80 virtual void OnDirectoryTypeUpdateCounterUpdated( 81 syncer::ModelType type, 82 const syncer::UpdateCounters& counters) = 0; 83 84 // Called when we receive an updated status counter for a directory type. 85 // 86 // Disabled by default. Enable by calling 87 // EnableDirectoryTypeDebugInfoForwarding() on the backend. 88 virtual void OnDirectoryTypeStatusCounterUpdated( 89 syncer::ModelType type, 90 const syncer::StatusCounters& counters) = 0; 91 92 // The status of the connection to the sync server has changed. 93 virtual void OnConnectionStatusChange( 94 syncer::ConnectionStatus status) = 0; 95 96 // The syncer requires a passphrase to decrypt sensitive updates. This is 97 // called when the first sensitive data type is setup by the user and anytime 98 // the passphrase is changed by another synced client. |reason| denotes why 99 // the passphrase was required. |pending_keys| is a copy of the 100 // cryptographer's pending keys to be passed on to the frontend in order to 101 // be cached. 102 virtual void OnPassphraseRequired( 103 syncer::PassphraseRequiredReason reason, 104 const sync_pb::EncryptedData& pending_keys) = 0; 105 106 // Called when the passphrase provided by the user is 107 // accepted. After this is called, updates to sensitive nodes are 108 // encrypted using the accepted passphrase. 109 virtual void OnPassphraseAccepted() = 0; 110 111 // Called when the set of encrypted types or the encrypt everything 112 // flag has been changed. Note that encryption isn't complete until 113 // the OnEncryptionComplete() notification has been sent (see 114 // below). 115 // 116 // |encrypted_types| will always be a superset of 117 // syncer::Cryptographer::SensitiveTypes(). If |encrypt_everything| is 118 // true, |encrypted_types| will be the set of all known types. 119 // 120 // Until this function is called, observers can assume that the set 121 // of encrypted types is syncer::Cryptographer::SensitiveTypes() and that 122 // the encrypt everything flag is false. 123 virtual void OnEncryptedTypesChanged( 124 syncer::ModelTypeSet encrypted_types, 125 bool encrypt_everything) = 0; 126 127 // Called after we finish encrypting the current set of encrypted 128 // types. 129 virtual void OnEncryptionComplete() = 0; 130 131 // Called to perform migration of |types|. 132 virtual void OnMigrationNeededForTypes(syncer::ModelTypeSet types) = 0; 133 134 // Inform the Frontend that new datatypes are available for registration. 135 virtual void OnExperimentsChanged( 136 const syncer::Experiments& experiments) = 0; 137 138 // Called when the sync cycle returns there is an user actionable error. 139 virtual void OnActionableError(const syncer::SyncProtocolError& error) = 0; 140 }; 141 142 } // namespace browser_sync 143 144 #endif // COMPONENTS_SYNC_DRIVER_SYNC_FRONTEND_H_ 145
