mirror of
https://github.com/firebase/firebase-ios-sdk
synced 2026-11-10 22:45:59 +05:45
Greg Soltis
16a5210b3c
* Switch to reference delegates for garbage collection (#1410) * Bump sequence number on resume token refresh * Style * Fix comment formatting * Add FSTReferenceDelegate definition and documentation * Add methods to return nil for delegates, wire up inMemoryPins * Add hook for removing a reference * Start work on reference delegates * Fix up tests to support adding documents at a sequence number * Implement removing references * Remove from target when dropped from local view * Fix warning * Add hooks for removal from mutation queue * Add hooks for limbo document updates * Style * Drop commented-out code * Fixup after merging master * Start importing delegate implementations * Memory LRU tests pass * Make memory lru work, start fixing up lru tests. All with hidden sequence numbers * Most LRU tests passing w/ memory * Big LRU test passes w/ memory * Leveldb LRU tests pass * All passing except local store tests * All tests pass * Fix localstore tests * Revert removeQueryData change * Remove collectGarbage calls * Remove NoOp GC * More cleanup * Refactor FSTHelpers * Cleanup and commenting * Comments and cleanup * Comments * Drop nullable for reference delegates, and old persistence method on spec tests * Fix missing sequence bump, remove unneeded targetID * Style * Drop commented-out code * Satisfy the linters and copyrighters, etc. * Drop more commented-out code * Fix import -> include, NSUInteger -> int * Start work on test comments * FSTDocumentKey -> DocumentKey * Sample of LRU test refactor (#1424) * Sample of test refactor * Drop errant 'struct' keyword * More test refactoring * Make gc a member variable too * Tests refactored to use member variables * Assign delegates procedurally, rather than passing in a block * Fix up FSTLevelDB a little * listens -> listenTargets * Rename GCEnabled * remove isSentinel * reword comment * Add case for non-eager GC to test * Style * Cleaning the lint trap * Clean up LRU tests (#1433) * Add copious helpers and some docs to lru tests * Style * Method name refactor, add comment * Drop FSTGarbageCollector and FSTEagerGarbageCollector (#1440) * Drop FSTGarbageCollector and FSTEagerGarbageCollector * Drop unused containsKey from FSTLevelDBMutationQueue * Style * Include sequence number in FSTQueryData hash and isEqual (#1568) * Include sequence number in FSTQueryData hash and isEqual methods * Style * Switch to util::Hash * Fix preserving query cache metadata (#1569) * Add failing test * Move the restart tests to the leveldb test suite * Style * Add new persistence test helper * Fix test failure * Review feedback * Style
73 lines
2.8 KiB
Objective-C
73 lines
2.8 KiB
Objective-C
/*
|
|
* 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"
|
|
|
|
#include "Firestore/core/src/firebase/firestore/model/document_key_set.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
|
|
|
|
/** 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:(const firebase::firestore::model::DocumentKeySet &)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:(const firebase::firestore::model::DocumentKeySet &)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. */
|
|
- (firebase::firestore::model::DocumentKeySet)referencedKeysForID:(int)ID;
|
|
|
|
/**
|
|
* Checks to see if there are any references to a document with the given key.
|
|
*/
|
|
- (BOOL)containsKey:(const firebase::firestore::model::DocumentKey &)key;
|
|
|
|
@end
|
|
|
|
NS_ASSUME_NONNULL_END
|