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 #import "keychain/ckks/OctagonAPSReceiver.h"
  30
  31 NS_ASSUME_NONNULL_BEGIN
  32
  33 /*
  34  * This class implements a CloudKit-fetch-with-retry.
  35  * In the case of network or other failures, it'll issue retries.
  36  * Only in the case of a clean fetch will its operation dependency resolve.
  37  */
  38
  39 @class CKKSKeychainView;
  40 @class CKKSReachabilityTracker;
  41 @class CKKSNearFutureScheduler;
  42
  43 @interface CKKSZoneChangeFetcher : NSObject <CKKSZoneUpdateReceiverProtocol>
  44 @property (readonly) Class<CKKSFetchRecordZoneChangesOperation> fetchRecordZoneChangesOperationClass;
  45 @property (readonly) CKContainer* container;
  46 @property CKKSReachabilityTracker* reachabilityTracker;
  47
  48 @property (readonly) NSError* lastCKFetchError;
  49
  50 - (instancetype)init NS_UNAVAILABLE;
  51 - (instancetype)initWithContainer:(CKContainer*)container
  52                        fetchClass:(Class<CKKSFetchRecordZoneChangesOperation>)fetchRecordZoneChangesOperationClass
  53               reachabilityTracker:(CKKSReachabilityTracker *)reachabilityTracker;
  54
  55 - (void)registerClient:(id<CKKSChangeFetcherClient>)client;
  56
  57 - (CKKSResultOperation*)requestSuccessfulFetch:(CKKSFetchBecause*)why;
  58 - (CKKSResultOperation*)requestSuccessfulFetchForManyReasons:(NSSet<CKKSFetchBecause*>*)why;
  59
  60 // Returns the next fetch, if one is scheduled, or the last/currently executing fetch if not.
  61 - (CKKSResultOperation* _Nullable)inflightFetch;
  62
  63 // CKKSZoneUpdateReceiverProtocol
  64 - (void)notifyZoneChange:(CKRecordZoneNotification* _Nullable)notification;
  65
  66 // We don't particularly care what this does, as long as it finishes
  67 - (void)holdFetchesUntil:(CKKSResultOperation* _Nullable)holdOperation;
  68
  69 - (void)cancel;
  70
  71 // I don't recommend using these unless you're a test.
  72 @property CKKSNearFutureScheduler* fetchScheduler;
  73 @end
  74
  75 NS_ASSUME_NONNULL_END
  76 #endif