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
|
/*
* 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/snapshot_version.h"
@class FSTQuery;
NS_ASSUME_NONNULL_BEGIN
/** An enumeration of the different purposes we have for queries. */
typedef NS_ENUM(NSInteger, FSTQueryPurpose) {
/** A regular, normal query. */
FSTQueryPurposeListen,
/** The query was used to refill a query after an existence filter mismatch. */
FSTQueryPurposeExistenceFilterMismatch,
/** The query was used to resolve a limbo document. */
FSTQueryPurposeLimboResolution,
};
/** An immutable set of metadata that the store will need to keep track of for each query. */
@interface FSTQueryData : NSObject
- (instancetype)initWithQuery:(FSTQuery *)query
targetID:(FSTTargetID)targetID
listenSequenceNumber:(FSTListenSequenceNumber)sequenceNumber
purpose:(FSTQueryPurpose)purpose
snapshotVersion:(firebase::firestore::model::SnapshotVersion)snapshotVersion
resumeToken:(NSData *)resumeToken NS_DESIGNATED_INITIALIZER;
/** Convenience initializer for use when creating an FSTQueryData for the first time. */
- (instancetype)initWithQuery:(FSTQuery *)query
targetID:(FSTTargetID)targetID
listenSequenceNumber:(FSTListenSequenceNumber)sequenceNumber
purpose:(FSTQueryPurpose)purpose;
- (instancetype)init NS_UNAVAILABLE;
/**
* Creates a new query data instance with an updated snapshot version, resume token, and sequence
* number.
*/
- (instancetype)queryDataByReplacingSnapshotVersion:
(firebase::firestore::model::SnapshotVersion)snapshotVersion
resumeToken:(NSData *)resumeToken
sequenceNumber:(FSTListenSequenceNumber)sequenceNumber;
/** The latest snapshot version seen for this target. */
- (const firebase::firestore::model::SnapshotVersion &)snapshotVersion;
/** The query being listened to. */
@property(nonatomic, strong, readonly) FSTQuery *query;
/**
* The targetID to which the query corresponds, assigned by the FSTLocalStore for user queries or
* the FSTSyncEngine for limbo queries.
*/
@property(nonatomic, assign, readonly) FSTTargetID targetID;
@property(nonatomic, assign, readonly) FSTListenSequenceNumber sequenceNumber;
/** The purpose of the query. */
@property(nonatomic, assign, readonly) FSTQueryPurpose purpose;
/**
* An opaque, server-assigned token that allows watching a query to be resumed after disconnecting
* without retransmitting all the data that matches the query. The resume token essentially
* identifies a point in time from which the server should resume sending results.
*/
@property(nonatomic, copy, readonly) NSData *resumeToken;
@end
NS_ASSUME_NONNULL_END
|
