firebase-ios-sdk/Firestore/Example/Tests/Util/FSTEventAccumulator.h

/*
 * 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>

@class FIRDocumentSnapshot;
@class FIRQuerySnapshot;
@class XCTestCase;
@class XCTestExpectation;

NS_ASSUME_NONNULL_BEGIN

typedef void (^FSTValueEventHandler)(id _Nullable, NSError *_Nullable error);

@interface FSTEventAccumulator<EventType> : NSObject

+ (instancetype)accumulatorForTest:(XCTestCase *)testCase;

- (instancetype)init NS_UNAVAILABLE;

- (EventType)awaitEventWithName:(NSString *)name;

- (NSArray<EventType> *)awaitEvents:(NSUInteger)events name:(NSString *)name;

/** Waits for a latency compensated local snapshot. */
- (EventType)awaitLocalEvent;

/** Waits for a snapshot that has no pending writes */
- (EventType)awaitRemoteEvent;

- (void)assertNoAdditionalEvents;

@property(nonatomic, strong, readonly) FSTValueEventHandler valueEventHandler;

@end

NS_ASSUME_NONNULL_END