VLCKit
Instance Methods | Class Methods | Properties | List of all members
VLCFileLogger Class Reference

A simple file logger to be used with a library instance. More...

#import <VLCFileLogger.h>

Inheritance diagram for VLCFileLogger:
<VLCFormattedMessageLogging> <VLCLogging>

Instance Methods

(instancetype) - NS_UNAVAILABLE
 
(instancetype) - initWithFileHandle:
 Default initializer. More...
 
- Instance Methods inherited from <VLCLogging>
(void) - handleMessage:logLevel:context:
 Called by the VLCLibrary logging handler when a log message is delivered. More...
 

Class Methods

(instancetype) + NS_UNAVAILABLE
 
(instancetype) + createWithFileHandle:
 Class default initializer. More...
 

Properties

NSFileHandle * fileHandle
 The file handle used to write or update the log file.
 
id< VLCLogMessageFormattingformatter
 Formatter used. More...
 
- Properties inherited from <VLCFormattedMessageLogging>
id< VLCLogMessageFormattingformatter
 
- Properties inherited from <VLCLogging>
VLCLogLevel level
 Gets/sets this to filter in/out messages to handle. More...
 

Detailed Description

A simple file logger to be used with a library instance.

See also
-[VLCLibrary loggers]

Method Documentation

◆ createWithFileHandle:

+ (instancetype) createWithFileHandle: (NSFileHandle *)  fileHandle

Class default initializer.

Parameters
fileHandleThe file handle that was created for write or update access
Note
The writing will silently fail if the file handle wasn't opened for write or update access

◆ initWithFileHandle:

- (instancetype) initWithFileHandle: (NSFileHandle *)  NS_DESIGNATED_INITIALIZER

Default initializer.

Parameters
fileHandleThe file handle that was created for write or update access
Note
The writing will silently fail if the file handle wasn't opened for write or update access

Property Documentation

◆ formatter

- (id<VLCLogMessageFormatting>) formatter
readwritenonatomicassign

Formatter used.

Note
Set to an instance of VLCLogMessageFormatter by default
Warning
Won't accept nil value
See also
VLCLogMessageFormatting

The documentation for this class was generated from the following file: