mirror of
https://github.com/firebase/firebase-ios-sdk
synced 2026-11-10 22:45:59 +05:45
Gil
4fbc96904f
This simplifies the import process back into google3 and allows us to add additional directories to the project without needing to update the project files for each directory we add. This shows up most clearly in the change to Firestore/Example/Firestore.xcodeproj/project.pbxproj: this no longer needs to list essentially every directory in the project as a header search path. * Clang-format configuration for C++ files * Add support C++-only sources to the podspec * Podspec support for fully qualified imports * xcodeproj changes for fully-qualified imports * Use fully-qualified imports in Firestore sources
114 lines
4.0 KiB
Objective-C
114 lines
4.0 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"
|
|
#import "Firestore/Source/Local/FSTGarbageCollector.h"
|
|
#import "Firestore/Source/Model/FSTDocumentKeySet.h"
|
|
|
|
@class FSTDocumentKey;
|
|
@class FSTDocumentSet;
|
|
@class FSTMaybeDocument;
|
|
@class FSTQuery;
|
|
@class FSTQueryData;
|
|
@class FSTWriteGroup;
|
|
@class FSTSnapshotVersion;
|
|
|
|
NS_ASSUME_NONNULL_BEGIN
|
|
|
|
/**
|
|
* Represents cached queries received from the remote backend. This contains both a mapping between
|
|
* queries and the documents that matched them according to the server, but also metadata about the
|
|
* queries.
|
|
*
|
|
* The cache is keyed by FSTQuery and entries in the cache are FSTQueryData instances.
|
|
*/
|
|
@protocol FSTQueryCache <NSObject, FSTGarbageSource>
|
|
|
|
/** Starts the query cache up. */
|
|
- (void)start;
|
|
|
|
/** Shuts this cache down, closing open files, etc. */
|
|
- (void)shutdown;
|
|
|
|
/**
|
|
* Returns the highest target ID of any query in the cache. Typically called during startup to
|
|
* seed a target ID generator and avoid collisions with existing queries. If there are no queries
|
|
* in the cache, returns zero.
|
|
*/
|
|
- (FSTTargetID)highestTargetID;
|
|
|
|
/**
|
|
* A global snapshot version representing the last consistent snapshot we received from the
|
|
* backend. This is monotonically increasing and any snapshots received from the backend prior to
|
|
* this version (e.g. for targets resumed with a resume_token) should be suppressed (buffered)
|
|
* until the backend has caught up to this snapshot version again. This prevents our cache from
|
|
* ever going backwards in time.
|
|
*
|
|
* This is updated whenever our we get a TargetChange with a read_time and empty target_ids.
|
|
*/
|
|
- (FSTSnapshotVersion *)lastRemoteSnapshotVersion;
|
|
|
|
/**
|
|
* Set the snapshot version representing the last consistent snapshot received from the backend.
|
|
* (see -lastRemoteSnapshotVersion for more details).
|
|
*
|
|
* @param snapshotVersion The new snapshot version.
|
|
*/
|
|
- (void)setLastRemoteSnapshotVersion:(FSTSnapshotVersion *)snapshotVersion
|
|
group:(FSTWriteGroup *)group;
|
|
|
|
/**
|
|
* Adds or replaces an entry in the cache.
|
|
*
|
|
* The cache key is extracted from `queryData.query`. If there is already a cache entry for the
|
|
* key, it will be replaced.
|
|
*
|
|
* @param queryData An FSTQueryData instance to put in the cache.
|
|
*/
|
|
- (void)addQueryData:(FSTQueryData *)queryData group:(FSTWriteGroup *)group;
|
|
|
|
/** Removes the cached entry for the given query data (no-op if no entry exists). */
|
|
- (void)removeQueryData:(FSTQueryData *)queryData group:(FSTWriteGroup *)group;
|
|
|
|
/**
|
|
* Looks up an FSTQueryData entry in the cache.
|
|
*
|
|
* @param query The query corresponding to the entry to look up.
|
|
* @return The cached FSTQueryData entry, or nil if the cache has no entry for the query.
|
|
*/
|
|
- (nullable FSTQueryData *)queryDataForQuery:(FSTQuery *)query;
|
|
|
|
/** Adds the given document keys to cached query results of the given target ID. */
|
|
- (void)addMatchingKeys:(FSTDocumentKeySet *)keys
|
|
forTargetID:(FSTTargetID)targetID
|
|
group:(FSTWriteGroup *)group;
|
|
|
|
/** Removes the given document keys from the cached query results of the given target ID. */
|
|
- (void)removeMatchingKeys:(FSTDocumentKeySet *)keys
|
|
forTargetID:(FSTTargetID)targetID
|
|
group:(FSTWriteGroup *)group;
|
|
|
|
/** Removes all the keys in the query results of the given target ID. */
|
|
- (void)removeMatchingKeysForTargetID:(FSTTargetID)targetID group:(FSTWriteGroup *)group;
|
|
|
|
- (FSTDocumentKeySet *)matchingKeysForTargetID:(FSTTargetID)targetID;
|
|
|
|
@end
|
|
|
|
NS_ASSUME_NONNULL_END
|