keychain/ckks/CKKSAPSReceiver.h

   1 /*
   2  * Copyright (c) 2016 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 #import <Foundation/Foundation.h>
  25
  26 #if OCTAGON
  27 #import <ApplePushService/ApplePushService.h>
  28 #import <CloudKit/CloudKit.h>
  29 #import "keychain/ckks/CKKSCondition.h"
  30 #import "keychain/ckks/CloudKitDependencies.h"
  31
  32 NS_ASSUME_NONNULL_BEGIN
  33
  34 @protocol CKKSZoneUpdateReceiver <NSObject>
  35 - (void)notifyZoneChange:(CKRecordZoneNotification* _Nullable)notification;
  36 @end
  37
  38 @interface CKKSAPSReceiver : NSObject <APSConnectionDelegate>
  39
  40 @property NSMapTable<CKRecordZoneID*, id<CKKSZoneUpdateReceiver>>* zoneMap;
  41
  42 // class dependencies (for injection)
  43 @property (readonly) Class<CKKSAPSConnection> apsConnectionClass;
  44 @property (nullable) id<CKKSAPSConnection> apsConnection;
  45
  46 + (instancetype)receiverForEnvironment:(NSString*)environmentName
  47                      namedDelegatePort:(NSString*)namedDelegatePort
  48                     apsConnectionClass:(Class<CKKSAPSConnection>)apsConnectionClass;
  49 - (CKKSCondition*)registerReceiver:(id<CKKSZoneUpdateReceiver>)receiver forZoneID:(CKRecordZoneID*)zoneID;
  50
  51 // Test support:
  52 - (instancetype)initWithEnvironmentName:(NSString*)environmentName
  53                       namedDelegatePort:(NSString*)namedDelegatePort
  54                      apsConnectionClass:(Class<CKKSAPSConnection>)apsConnectionClass;
  55 // This is the queue that APNS will use send the notifications to us
  56 + (dispatch_queue_t)apsDeliveryQueue;
  57
  58 @end
  59
  60 NS_ASSUME_NONNULL_END
  61 #endif  // OCTAGON