Analytics/SFAnalyticsSampler.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 __OBJC2__
  25 #ifndef SFAnalyticsSampler_h
  26 #define SFAnalyticsSampler_h
  27
  28 #import <Foundation/Foundation.h>
  29
  30 @interface SFAnalyticsSampler : NSObject
  31
  32 @property (nonatomic) NSTimeInterval samplingInterval;
  33 @property (nonatomic, readonly) NSString* name;
  34 @property (nonatomic, readonly) BOOL oncePerReport;
  35
  36 - (instancetype)init NS_UNAVAILABLE;
  37 - (NSNumber*)sampleNow;
  38 - (void)pauseSampling;
  39 - (void)resumeSampling;
  40
  41 @end
  42
  43 #endif
  44 #endif