GCKLogger Class

Class Methods | Properties
GCKLogger Class Reference

Overview

A singleton object used for logging by the framework.

If a delegate is assigned, the formatted log messages are passed to the delegate. Otherwise, the messages are written using NSLog() in debug builds and are discarded otherwise.

See GCKLoggerDelegate for the delegate protocol.

Inherits NSObject.

Class Method Summary

(GCKLogger *) + sharedInstance
 Returns the GCKLogger singleton instance. More...
 

Property Summary

id< GCKLoggerDelegate > delegate
 The delegate to pass log messages to. More...
 
GCKLoggerFilter * filter
 The filter to apply to log messages. More...
 
BOOL loggingEnabled
 Flag for enabling or disabling logging. More...
 
BOOL fileLoggingEnabled
 Flag for enabling or disabling file logging. More...
 
BOOL consoleLoggingEnabled
 Flag for enabling or disabling logging directly to the console (via NSLog). More...
 
NSUInteger maxLogFileSize
 The maximum size of a log file, in bytes. More...
 
NSUInteger maxLogFileCount
 The maximum number of log files. More...
 
GCKLoggerLevel minimumLevel
 The minimum logging level that will be logged. More...
 

Method Detail

+ (GCKLogger *) sharedInstance

Returns the GCKLogger singleton instance.

Property Detail

- (id<GCKLoggerDelegate>) delegate
readwritenonatomicweak

The delegate to pass log messages to.

- (GCKLoggerFilter*) filter
readwritenonatomicstrong

The filter to apply to log messages.

Since
3.0
- (BOOL) loggingEnabled
readwritenonatomicassign

Flag for enabling or disabling logging.

On by default.

Since
3.0
- (BOOL) fileLoggingEnabled
readwritenonatomicassign

Flag for enabling or disabling file logging.

Off by default. If enabled, log messages are written to a set of rotating files in the app's cache directory. The number and maximum size of these files can be configured via other properties of this class.

Since
3.1
- (BOOL) consoleLoggingEnabled
readwritenonatomicassign

Flag for enabling or disabling logging directly to the console (via NSLog).

Off by default.

Since
4.1
- (NSUInteger) maxLogFileSize
readwritenonatomicassign

The maximum size of a log file, in bytes.

The minimum is 32 KiB. If the value is 0, the default maximum size of 2 MiB will be used.

Since
3.1
- (NSUInteger) maxLogFileCount
readwritenonatomicassign

The maximum number of log files.

The minimum is 2.

Since
3.1
- (GCKLoggerLevel) minimumLevel
readwritenonatomicassign

The minimum logging level that will be logged.

Since
3.0
Deprecated:
Specify minimum logging level in GCKLoggerFilter.