FPRInstrumentation.h 1.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445
  1. // Copyright 2020 Google LLC
  2. //
  3. // Licensed under the Apache License, Version 2.0 (the "License");
  4. // you may not use this file except in compliance with the License.
  5. // You may obtain a copy of the License at
  6. //
  7. // http://www.apache.org/licenses/LICENSE-2.0
  8. //
  9. // Unless required by applicable law or agreed to in writing, software
  10. // distributed under the License is distributed on an "AS IS" BASIS,
  11. // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12. // See the License for the specific language governing permissions and
  13. // limitations under the License.
  14. #import <Foundation/Foundation.h>
  15. NS_ASSUME_NONNULL_BEGIN
  16. /** The key for the network instrumentation group. */
  17. FOUNDATION_EXTERN NSString *const kFPRInstrumentationGroupNetworkKey;
  18. /** The key for the UIKit instrumentation group. */
  19. FOUNDATION_EXTERN NSString *const kFPRInstrumentationGroupUIKitKey;
  20. /** This class manages all automatic instrumentation. */
  21. NS_EXTENSION_UNAVAILABLE("Firebase Performance is not supported for extensions.")
  22. @interface FPRInstrumentation : NSObject
  23. /** Registers the instrument group.
  24. *
  25. * @param group The group whose instrumentation should be registered.
  26. * @return The number of instruments in the group.
  27. */
  28. - (NSUInteger)registerInstrumentGroup:(NSString *)group;
  29. /** Deregisters the instrument group.
  30. *
  31. * @param group The group whose instrumentation should be deregistered.
  32. * @return YES if there are no registered instruments in the group, NO otherwise.
  33. */
  34. - (BOOL)deregisterInstrumentGroup:(NSString *)group;
  35. @end
  36. NS_ASSUME_NONNULL_END