blob: 3b28e3637200c370626cdd0eb40624ea1f5089eb (
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
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
|
/*
* Copyright 2017 Google
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#import <Foundation/Foundation.h>
#import "Firestore/Source/Core/FSTTypes.h"
#import "Firestore/Source/Remote/FSTRemoteStore.h"
#include "Firestore/core/src/firebase/firestore/auth/user.h"
@class FSTDispatchQueue;
@class FSTLocalStore;
@class FSTMutation;
@class FSTQuery;
@class FSTRemoteEvent;
@class FSTRemoteStore;
@class FSTViewSnapshot;
NS_ASSUME_NONNULL_BEGIN
#pragma mark - FSTSyncEngineDelegate
/** A Delegate to be notified when the sync engine produces new view snapshots or errors. */
@protocol FSTSyncEngineDelegate
- (void)handleViewSnapshots:(NSArray<FSTViewSnapshot *> *)viewSnapshots;
- (void)handleError:(NSError *)error forQuery:(FSTQuery *)query;
@end
/**
* SyncEngine is the central controller in the client SDK architecture. It is the glue code
* between the EventManager, LocalStore, and RemoteStore. Some of SyncEngine's responsibilities
* include:
* 1. Coordinating client requests and remote events between the EventManager and the local and
* remote data stores.
* 2. Managing a View object for each query, providing the unified view between the local and
* remote data stores.
* 3. Notifying the RemoteStore when the LocalStore has new mutations in its queue that need
* sending to the backend.
*
* The SyncEngine’s methods should only ever be called by methods running on our own worker
* dispatch queue.
*/
@interface FSTSyncEngine : NSObject <FSTRemoteSyncer>
- (instancetype)init NS_UNAVAILABLE;
- (instancetype)initWithLocalStore:(FSTLocalStore *)localStore
remoteStore:(FSTRemoteStore *)remoteStore
initialUser:(const firebase::firestore::auth::User &)user
NS_DESIGNATED_INITIALIZER;
/**
* A delegate to be notified when queries being listened to produce new view snapshots or
* errors.
*/
@property(nonatomic, weak) id<FSTSyncEngineDelegate> delegate;
/**
* Initiates a new listen. The FSTLocalStore will be queried for initial data and the listen will
* be sent to the FSTRemoteStore to get remote data. The registered FSTSyncEngineDelegate will be
* notified of resulting view snapshots and/or listen errors.
*
* @return the target ID assigned to the query.
*/
- (FSTTargetID)listenToQuery:(FSTQuery *)query;
/** Stops listening to a query previously listened to via listenToQuery:. */
- (void)stopListeningToQuery:(FSTQuery *)query;
/**
* Initiates the write of local mutation batch which involves adding the writes to the mutation
* queue, notifying the remote store about new mutations, and raising events for any changes this
* write caused. The provided completion block will be called once the write has been acked or
* rejected by the backend (or failed locally for any other reason).
*/
- (void)writeMutations:(NSArray<FSTMutation *> *)mutations completion:(FSTVoidErrorBlock)completion;
/**
* Runs the given transaction block up to retries times and then calls completion.
*
* @param retries The number of times to try before giving up.
* @param workerDispatchQueue The queue to dispatch sync engine calls to.
* @param updateBlock The block to call to execute the user's transaction.
* @param completion The block to call when the transaction is finished or failed.
*/
- (void)transactionWithRetries:(int)retries
workerDispatchQueue:(FSTDispatchQueue *)workerDispatchQueue
updateBlock:(FSTTransactionBlock)updateBlock
completion:(FSTVoidIDErrorBlock)completion;
- (void)userDidChange:(const firebase::firestore::auth::User &)user;
/** Applies an FSTOnlineState change to the sync engine and notifies any views of the change. */
- (void)applyChangedOnlineState:(FSTOnlineState)onlineState;
@end
NS_ASSUME_NONNULL_END
|
