keychain/ckks/CKKSZoneChangeFetcher.h

   1 /*
   2  * Copyright (c) 2017 Apple Inc. All Rights Reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. Please obtain a copy of the License at
  10  * http://www.opensource.apple.com/apsl/ and read it before using this
  11  * file.
  12  *
  13  * The Original Code and all software distributed under the License are
  14  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18  * Please see the License for the specific language governing rights and
  19  * limitations under the License.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22  */
  23
  24 #if OCTAGON
  25 #import <CloudKit/CloudKit.h>
  26 #import <Foundation/Foundation.h>
  27 #import "keychain/ckks/CKKSResultOperation.h"
  28 #import "keychain/ckks/CKKSFetchAllRecordZoneChangesOperation.h"
  29
  30 NS_ASSUME_NONNULL_BEGIN
  31
  32 /*
  33  * This class implements a CloudKit-fetch-with-retry.
  34  * In the case of network or other failures, it'll issue retries.
  35  * Only in the case of a clean fetch will its operation dependency resolve.
  36  */
  37
  38 @class CKKSKeychainView;
  39 @class CKKSReachabilityTracker;
  40 @class CKKSNearFutureScheduler;
  41
  42 @interface CKKSZoneChangeFetcher : NSObject
  43 @property (readonly) Class<CKKSFetchRecordZoneChangesOperation> fetchRecordZoneChangesOperationClass;
  44 @property (readonly) CKContainer* container;
  45 @property CKKSReachabilityTracker* reachabilityTracker;
  46
  47 @property (readonly) NSError* lastCKFetchError;
  48
  49 - (instancetype)init NS_UNAVAILABLE;
  50 - (instancetype)initWithContainer:(CKContainer*)container
  51                        fetchClass:(Class<CKKSFetchRecordZoneChangesOperation>)fetchRecordZoneChangesOperationClass
  52               reachabilityTracker:(CKKSReachabilityTracker *)reachabilityTracker;
  53
  54 - (void)registerClient:(id<CKKSChangeFetcherClient>)client;
  55
  56 - (CKKSResultOperation*)requestSuccessfulFetch:(CKKSFetchBecause*)why;
  57 - (CKKSResultOperation*)requestSuccessfulFetchForManyReasons:(NSSet<CKKSFetchBecause*>*)why;
  58
  59 // let server know we seen this push and if zones are ready actually perform a fetch
  60 - (CKKSResultOperation* _Nullable)requestFetchDueToAPNS:(CKRecordZoneNotification*)notification;
  61
  62 // We don't particularly care what this does, as long as it finishes
  63 - (void)holdFetchesUntil:(CKKSResultOperation* _Nullable)holdOperation;
  64
  65 - (void)cancel;
  66
  67 // I don't recommend using these unless you're a test.
  68 @property CKKSNearFutureScheduler* fetchScheduler;
  69 @end
  70
  71 NS_ASSUME_NONNULL_END
  72 #endif