blob: 9d842cb5b0f24d31fc3de49b2e44bb08c27165e6 (
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
|
/*
* 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/Local/FSTGarbageCollector.h"
#import "Firestore/Source/Model/FSTDocumentKeySet.h"
NS_ASSUME_NONNULL_BEGIN
/**
* A collection of references to a document from some kind of numbered entity (either a targetID or
* batchID). As references are added to or removed from the set corresponding events are emitted to
* a registered garbage collector.
*
* Each reference is represented by a FSTDocumentReference object. Each of them contains enough
* information to uniquely identify the reference. They are all stored primarily in a set sorted
* by key. A document is considered garbage if there's no references in that set (this can be
* efficiently checked thanks to sorting by key).
*
* FSTReferenceSet also keeps a secondary set that contains references sorted by IDs. This one is
* used to efficiently implement removal of all references by some target ID.
*/
@interface FSTReferenceSet : NSObject <FSTGarbageSource>
/** Keeps track of keys that have references. */
@property(nonatomic, weak, readwrite, nullable) id<FSTGarbageCollector> garbageCollector;
/** Returns YES if the reference set contains no references. */
- (BOOL)isEmpty;
/** Adds a reference to the given document key for the given ID. */
- (void)addReferenceToKey:(const firebase::firestore::model::DocumentKey &)key forID:(int)ID;
/** Add references to the given document keys for the given ID. */
- (void)addReferencesToKeys:(FSTDocumentKeySet *)keys forID:(int)ID;
/** Removes a reference to the given document key for the given ID. */
- (void)removeReferenceToKey:(const firebase::firestore::model::DocumentKey &)key forID:(int)ID;
/** Removes references to the given document keys for the given ID. */
- (void)removeReferencesToKeys:(FSTDocumentKeySet *)keys forID:(int)ID;
/** Clears all references with a given ID. Calls -removeReferenceToKey: for each key removed. */
- (void)removeReferencesForID:(int)ID;
/** Clears all references for all IDs. */
- (void)removeAllReferences;
/** Returns all of the document keys that have had references added for the given ID. */
- (FSTDocumentKeySet *)referencedKeysForID:(int)ID;
@end
NS_ASSUME_NONNULL_END
|
