keychain/ckks/CKKSControlProtocol.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 #import <Foundation/Foundation.h>
  25
  26 @protocol CKKSControlProtocol <NSObject>
  27 - (void)performanceCounters:(void(^)(NSDictionary <NSString *, NSNumber *> *))reply;
  28 - (void)rpcResetLocal:    (NSString*)viewName reply: (void(^)(NSError* result)) reply;
  29
  30 /**
  31  * Reset CloudKit zone with a caller provided reason, the reason will be logged in the operation group
  32  * name so that the reason for reset can be summarized server side.
  33  */
  34 - (void)rpcResetCloudKit: (NSString*)viewName reason:(NSString *)reason reply: (void(^)(NSError* result)) reply;
  35 - (void)rpcResync:(NSString*)viewName reply: (void(^)(NSError* result)) reply;
  36 - (void)rpcResyncLocal:(NSString*)viewName reply:(void(^)(NSError* result))reply;
  37 /**
  38  * Fetch status for the CKKS zones. If NULL is passed in a viewname, all zones are fetched.
  39  */
  40 - (void)rpcStatus:(NSString*)viewName reply: (void(^)(NSArray<NSDictionary*>* result, NSError* error)) reply;
  41 /**
  42  * Same as rpcStatus:reply: but avoid expensive operations (and thus don't report them). fastStatus doesn't include global status.
  43  */
  44 - (void)rpcFastStatus:(NSString*)viewName reply: (void(^)(NSArray<NSDictionary*>* result, NSError* error)) reply;
  45 - (void)rpcFetchAndProcessChanges:(NSString*)viewName reply: (void(^)(NSError* result)) reply;
  46 - (void)rpcFetchAndProcessClassAChanges:(NSString*)viewName reply: (void(^)(NSError* result)) reply;
  47 - (void)rpcPushOutgoingChanges:(NSString*)viewName reply: (void(^)(NSError* result)) reply;
  48 - (void)rpcGetCKDeviceIDWithReply: (void (^)(NSString* ckdeviceID))reply;
  49 - (void)rpcCKMetric:(NSString *)eventName attributes:(NSDictionary *)attributes reply:(void(^)(NSError* result)) reply;
  50 @end
  51
  52 NSXPCInterface* CKKSSetupControlProtocol(NSXPCInterface* interface);