Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(376)

Side by Side Diff: chrome/browser/sync/engine/syncapi.h

Issue 7614001: [Sync] Add comment for SyncBackendHost::OnBackendInitialized (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src
Patch Set: Created 9 years, 4 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch | Annotate | Revision Log
OLDNEW
1 // Copyright (c) 2011 The Chromium Authors. All rights reserved. 1 // Copyright (c) 2011 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be 2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file. 3 // found in the LICENSE file.
4 4
5 // This file defines the "sync API", an interface to the syncer 5 // This file defines the "sync API", an interface to the syncer
6 // backend that exposes (1) the core functionality of maintaining a consistent 6 // backend that exposes (1) the core functionality of maintaining a consistent
7 // local snapshot of a hierarchical object set; (2) a means to transactionally 7 // local snapshot of a hierarchical object set; (2) a means to transactionally
8 // access and modify those objects; (3) a means to control client/server 8 // access and modify those objects; (3) a means to control client/server
9 // synchronization tasks, namely: pushing local object modifications to a 9 // synchronization tasks, namely: pushing local object modifications to a
10 // server, pulling nonlocal object modifications from a server to this client, 10 // server, pulling nonlocal object modifications from a server to this client,
(...skipping 827 matching lines...) Expand 10 before | Expand all | Expand 10 after
838 virtual void OnPassphraseAccepted(const std::string& bootstrap_token) = 0; 838 virtual void OnPassphraseAccepted(const std::string& bootstrap_token) = 0;
839 839
840 // Called when initialization is complete to the point that SyncManager can 840 // Called when initialization is complete to the point that SyncManager can
841 // process changes. This does not necessarily mean authentication succeeded 841 // process changes. This does not necessarily mean authentication succeeded
842 // or that the SyncManager is online. 842 // or that the SyncManager is online.
843 // IMPORTANT: Creating any type of transaction before receiving this 843 // IMPORTANT: Creating any type of transaction before receiving this
844 // notification is illegal! 844 // notification is illegal!
845 // WARNING: Calling methods on the SyncManager before receiving this 845 // WARNING: Calling methods on the SyncManager before receiving this
846 // message, unless otherwise specified, produces undefined behavior. 846 // message, unless otherwise specified, produces undefined behavior.
847 // 847 //
848 // The given backend can emit the following events: 848 // |js_backend| is what about:sync interacts with. It can emit
849 // |the following events:
tim (not reviewing) 2011/08/11 21:43:19 Is this really the best spot for the full JsBacken
akalin 2011/08/12 18:24:26 I can't think of a better place that won't get out
849 850
850 /** 851 /**
851 * @param {{ enabled: boolean }} details A dictionary containing: 852 * @param {{ enabled: boolean }} details A dictionary containing:
852 * - enabled: whether or not notifications are enabled. 853 * - enabled: whether or not notifications are enabled.
853 */ 854 */
854 // function onNotificationStateChange(details); 855 // function onNotificationStateChange(details);
855 856
856 /** 857 /**
857 * @param {{ changedTypes: Array.<string> }} details A dictionary 858 * @param {{ changedTypes: Array.<string> }} details A dictionary
858 * containing: 859 * containing:
859 * - changedTypes: a list of types (as strings) for which there 860 * - changedTypes: a list of types (as strings) for which there
860 are new updates. 861 are new updates.
861 */ 862 */
862 // function onIncomingNotification(details); 863 // function onIncomingNotification(details);
863 864
864 // The given backend responds to the following messages (all other 865 // Also, it responds to the following messages (all other messages
865 // messages are ignored): 866 // are ignored):
866 867
867 /** 868 /**
868 * Gets the current notification state. 869 * Gets the current notification state.
869 * 870 *
870 * @param {function(boolean)} callback Called with whether or not 871 * @param {function(boolean)} callback Called with whether or not
871 * notifications are enabled. 872 * notifications are enabled.
872 */ 873 */
873 // function getNotificationState(callback); 874 // function getNotificationState(callback);
874 875
875 /** 876 /**
(...skipping 209 matching lines...) Expand 10 before | Expand all | Expand 10 after
1085 private: 1086 private:
1086 // An opaque pointer to the nested private class. 1087 // An opaque pointer to the nested private class.
1087 SyncInternal* data_; 1088 SyncInternal* data_;
1088 1089
1089 DISALLOW_COPY_AND_ASSIGN(SyncManager); 1090 DISALLOW_COPY_AND_ASSIGN(SyncManager);
1090 }; 1091 };
1091 1092
1092 } // namespace sync_api 1093 } // namespace sync_api
1093 1094
1094 #endif // CHROME_BROWSER_SYNC_ENGINE_SYNCAPI_H_ 1095 #endif // CHROME_BROWSER_SYNC_ENGINE_SYNCAPI_H_
OLDNEW
« no previous file with comments | « no previous file | chrome/browser/sync/glue/sync_backend_host.h » ('j') | chrome/browser/sync/glue/sync_backend_host.h » ('J')

Powered by Google App Engine
This is Rietveld 408576698