summaryrefslogtreecommitdiffstats
path: root/sync/syncable/directory_change_delegate.h
blob: a86b770ff215f6147954f10f27f9a14eaa0ab6b8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
// Copyright (c) 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_SYNCABLE_DIRECTORY_CHANGE_DELEGATE_H_
#define SYNC_SYNCABLE_DIRECTORY_CHANGE_DELEGATE_H_
#pragma once

#include "sync/internal_api/public/syncable/model_type.h"
#include "sync/syncable/syncable.h"

namespace syncable {

// This is an interface for listening to directory change events, triggered by
// the releasing of the syncable transaction. The delegate performs work to
// 1. Calculate changes, depending on the source of the transaction
//    (HandleCalculateChangesChangeEventFromSyncer/Syncapi).
// 2. Perform final work while the transaction is held
//    (HandleTransactionEndingChangeEvent).
// 3. Perform any work that should be done after the transaction is released.
//    (HandleTransactionCompleteChangeEvent).
//
// Note that these methods may be called on *any* thread.
class DirectoryChangeDelegate {
 public:
  virtual void HandleCalculateChangesChangeEventFromSyncApi(
      const ImmutableWriteTransactionInfo& write_transaction_info,
      BaseTransaction* trans) = 0;
  virtual void HandleCalculateChangesChangeEventFromSyncer(
      const ImmutableWriteTransactionInfo& write_transaction_info,
      BaseTransaction* trans) = 0;
  // Must return the set of all ModelTypes that were modified in the
  // transaction.
  virtual ModelTypeSet HandleTransactionEndingChangeEvent(
      const ImmutableWriteTransactionInfo& write_transaction_info,
      BaseTransaction* trans) = 0;
  virtual void HandleTransactionCompleteChangeEvent(
      ModelTypeSet models_with_changes) = 0;
 protected:
  virtual ~DirectoryChangeDelegate() {}
};

}  // namespace syncable

#endif  // SYNC_SYNCABLE_DIRECTORY_CHANGE_DELEGATE_H_