87 строки
2.5 KiB
Objective-C
87 строки
2.5 KiB
Objective-C
/**
|
|
* Copyright (c) 2015-present, Facebook, Inc.
|
|
* All rights reserved.
|
|
*
|
|
* This source code is licensed under the BSD-style license found in the
|
|
* LICENSE file in the root directory of this source tree. An additional grant
|
|
* of patent rights can be found in the PATENTS file in the same directory.
|
|
*/
|
|
|
|
#import <Foundation/Foundation.h>
|
|
|
|
/**
|
|
A Protocol for Classes that recieve Logger Messages.
|
|
*/
|
|
@protocol FBControlCoreLogger <NSObject>
|
|
|
|
/**
|
|
Logs a Message with the provided String.
|
|
|
|
@param string the string to log.
|
|
@return the reciever, for chaining.
|
|
*/
|
|
- (id<FBControlCoreLogger>)log:(NSString *)string;
|
|
|
|
/**
|
|
Logs a Message with the provided Format String.
|
|
|
|
@param format the Format String for the Logger.
|
|
@return the reciever, for chaining.
|
|
*/
|
|
- (id<FBControlCoreLogger>)logFormat:(NSString *)format, ... NS_FORMAT_FUNCTION(1,2);
|
|
|
|
/**
|
|
Returns the Info Logger variant.
|
|
*/
|
|
- (id<FBControlCoreLogger>)info;
|
|
|
|
/**
|
|
Returns the Debug Logger variant.
|
|
*/
|
|
- (id<FBControlCoreLogger>)debug;
|
|
|
|
/**
|
|
Returns the Error Logger variant.
|
|
*/
|
|
- (id<FBControlCoreLogger>)error;
|
|
|
|
/**
|
|
Returns a Logger that will accept log values on the given queue.
|
|
|
|
@param queue the queue to accept log messages on.
|
|
@return a new Logger that will allows logging of messages on the provided queue.
|
|
*/
|
|
- (id<FBControlCoreLogger>)onQueue:(dispatch_queue_t)queue;
|
|
|
|
/**
|
|
Returns a Logger that will prefix all messages with the given string
|
|
|
|
@param prefix the prefix to prepend to all messages.
|
|
@return a new Logger that will allows logging of messages on the provided queue.
|
|
*/
|
|
- (id<FBControlCoreLogger>)withPrefix:(NSString *)prefix;
|
|
|
|
@end
|
|
|
|
@interface FBControlCoreLogger : NSObject
|
|
|
|
/**
|
|
An implementation of `FBControlCoreLogger` that logs all events using ASL.
|
|
|
|
@param writeToStdErr YES if all future log messages should be written to stderr, NO otherwise.
|
|
@param debugLogging YES if Debug messages should be written to stderr, NO otherwise.
|
|
@return an FBControlCoreLogger instance.
|
|
*/
|
|
+ (id<FBControlCoreLogger>)aslLoggerWritingToStderrr:(BOOL)writeToStdErr withDebugLogging:(BOOL)debugLogging;
|
|
|
|
/**
|
|
An implementation of `FBControlCoreLogger` that logs all to a file descriptor using ASL.
|
|
|
|
@param fileDescriptor the file descriptor to log to, if 0 no file descriptor logging will occur.
|
|
@param debugLogging YES if Debug messages should be written to stderr, NO otherwise.
|
|
@return an FBControlCoreLogger instance.
|
|
*/
|
|
+ (id<FBControlCoreLogger>)aslLoggerWritingToFileDescriptor:(int)fileDescriptor withDebugLogging:(BOOL)debugLogging;
|
|
|
|
@end
|