blob: c4651aba7794bf91546d69d4cccfce66dd75f2d8 (
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
|
/*
* 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/core/src/firebase/firestore/local/leveldb_transaction.h"
@class FSTWriteGroup;
NS_ASSUME_NONNULL_BEGIN
/**
* Helper class for FSTPersistence implementations to create WriteGroups and verify internal
* contracts are maintained:
* 1. Can't create a group when an uncommitted group exists (no nesting).
* 2. Can't commit a group that differs from the last created one.
*/
@interface FSTWriteGroupTracker : NSObject
/** Creates and returns an FSTWriteGroupTracker instance. */
+ (instancetype)tracker;
/**
* Verifies there's no active group already and then creates a new group and stores it for later
* validation with `endGroup`.
*/
- (FSTWriteGroup *)startGroupWithAction:(NSString *)action;
- (FSTWriteGroup *)startGroupWithAction:(NSString *)action
transaction:
(firebase::firestore::local::LevelDbTransaction *)transaction;
/** Ends a group previously started with `startGroupWithAction`. */
- (void)endGroup:(FSTWriteGroup *)group;
@end
NS_ASSUME_NONNULL_END
|