mirror of
https://github.com/mollyim/webrtc.git
synced 2025-05-14 14:20:45 +01:00
a81e9c82fc
This CL introduced 2 new macros that affect the WebRTC OBJC API symbols: - RTC_OBJC_TYPE_PREFIX: Macro used to prepend a prefix to the API types that are exported with RTC_OBJC_EXPORT. Clients can patch the definition of this macro locally and build WebRTC.framework with their own prefix in case symbol clashing is a problem. This macro must only be defined by changing the value in sdk/objc/base/RTCMacros.h and not on via compiler flag to ensure it has a unique value. - RCT_OBJC_TYPE: Macro used internally to reference API types. Declaring an API type without using this macro will not include the declared type in the set of types that will be affected by the configurable RTC_OBJC_TYPE_PREFIX. Manual changes: https://webrtc-review.googlesource.com/c/src/+/173781/5..10 The auto-generated changes in PS#5 have been done with: https://webrtc-review.googlesource.com/c/src/+/174061. Bug: None Change-Id: I0d54ca94db764fb3b6cb4365873f79e14cd879b8 Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/173781 Commit-Queue: Mirko Bonadei <mbonadei@webrtc.org> Reviewed-by: Karl Wiberg <kwiberg@webrtc.org> Reviewed-by: Kári Helgason <kthelgason@webrtc.org> Cr-Commit-Position: refs/heads/master@{#31153}
74 lines
2.5 KiB
Objective-C
74 lines
2.5 KiB
Objective-C
/*
|
|
* Copyright 2015 The WebRTC project authors. All Rights Reserved.
|
|
*
|
|
* Use of this source code is governed by a BSD-style license
|
|
* that can be found in the LICENSE file in the root of the source
|
|
* tree. An additional intellectual property rights grant can be found
|
|
* in the file PATENTS. All contributing project authors may
|
|
* be found in the AUTHORS file in the root of the source tree.
|
|
*/
|
|
|
|
#import <Foundation/Foundation.h>
|
|
|
|
#import "RTCMacros.h"
|
|
|
|
typedef NS_ENUM(NSUInteger, RTCFileLoggerSeverity) {
|
|
RTCFileLoggerSeverityVerbose,
|
|
RTCFileLoggerSeverityInfo,
|
|
RTCFileLoggerSeverityWarning,
|
|
RTCFileLoggerSeverityError
|
|
};
|
|
|
|
typedef NS_ENUM(NSUInteger, RTCFileLoggerRotationType) {
|
|
RTCFileLoggerTypeCall,
|
|
RTCFileLoggerTypeApp,
|
|
};
|
|
|
|
NS_ASSUME_NONNULL_BEGIN
|
|
|
|
// This class intercepts WebRTC logs and saves them to a file. The file size
|
|
// will not exceed the given maximum bytesize. When the maximum bytesize is
|
|
// reached, logs are rotated according to the rotationType specified.
|
|
// For kRTCFileLoggerTypeCall, logs from the beginning and the end
|
|
// are preserved while the middle section is overwritten instead.
|
|
// For kRTCFileLoggerTypeApp, the oldest log is overwritten.
|
|
// This class is not threadsafe.
|
|
RTC_OBJC_EXPORT
|
|
@interface RTC_OBJC_TYPE (RTCFileLogger) : NSObject
|
|
|
|
// The severity level to capture. The default is kRTCFileLoggerSeverityInfo.
|
|
@property(nonatomic, assign) RTCFileLoggerSeverity severity;
|
|
|
|
// The rotation type for this file logger. The default is
|
|
// kRTCFileLoggerTypeCall.
|
|
@property(nonatomic, readonly) RTCFileLoggerRotationType rotationType;
|
|
|
|
// Disables buffering disk writes. Should be set before |start|. Buffering
|
|
// is enabled by default for performance.
|
|
@property(nonatomic, assign) BOOL shouldDisableBuffering;
|
|
|
|
// Default constructor provides default settings for dir path, file size and
|
|
// rotation type.
|
|
- (instancetype)init;
|
|
|
|
// Create file logger with default rotation type.
|
|
- (instancetype)initWithDirPath:(NSString *)dirPath maxFileSize:(NSUInteger)maxFileSize;
|
|
|
|
- (instancetype)initWithDirPath:(NSString *)dirPath
|
|
maxFileSize:(NSUInteger)maxFileSize
|
|
rotationType:(RTCFileLoggerRotationType)rotationType NS_DESIGNATED_INITIALIZER;
|
|
|
|
// Starts writing WebRTC logs to disk if not already started. Overwrites any
|
|
// existing file(s).
|
|
- (void)start;
|
|
|
|
// Stops writing WebRTC logs to disk. This method is also called on dealloc.
|
|
- (void)stop;
|
|
|
|
// Returns the current contents of the logs, or nil if start has been called
|
|
// without a stop.
|
|
- (nullable NSData *)logData;
|
|
|
|
@end
|
|
|
|
NS_ASSUME_NONNULL_END
|