FMIceLinkLogProvider Class Reference

Inherits from	NSObject
Declared in	FMIceLinkLogProvider.h FMIceLinkLogProvider.m

`– doLogWithTimestamp:level:tag:message:ex:`

Logs a message at the specified log [level](#//api/name/level).

- (void)doLogWithTimestamp:(NSDate *)timestamp level:(FMIceLinkLogLevel)level tag:(NSString *)tag message:(NSString *)message ex:(NSException *)ex

Parameters

`timestamp`	The timestamp when the event occurred.
`level`	The log level.
`tag`	The logger tag.
`message`	The message.
`ex`	The exception.

Discussion

Logs a message at the specified log [level](#//api/name/level).

Declared In

FMIceLinkLogProvider.h

`– filter`

Gets a filter on the log provider.

- (FMIceLinkFunction2 *)filter

Discussion

Gets a filter on the log provider.

Declared In

FMIceLinkLogProvider.h

`– generateLogLineWithTimestamp:level:tag:message:ex:`

Generates a default log line.

- (NSString *)generateLogLineWithTimestamp:(NSDate *)timestamp level:(FMIceLinkLogLevel)level tag:(NSString *)tag message:(NSString *)message ex:(NSException *)ex

Parameters

`timestamp`	When the event occurred.
`level`	The log level,
`tag`	Which logger it came from.
`message`	The log message.
`ex`	The exception if one is available.

Discussion

Generates a default log line.

Declared In

FMIceLinkLogProvider.h

`+ getPrefixTimestamp:`

Converts a timestamp to a string formatted for rendering in a log message (yyyy/MM/dd-hh:mm:ss).

+ (NSString *)getPrefixTimestamp:(NSDate *)timestamp

Parameters

`timestamp`	The timestamp.

Return Value

The timestamp as a formatted string.

Discussion

Converts a timestamp to a string formatted for rendering in a log message (yyyy/MM/dd-hh:mm:ss).

Declared In

FMIceLinkLogProvider.h

`+ getPrefixWithLevel:`

Converts a log[level](#//api/name/level) to a 5-character string for consistently-spaced character sequences.

+ (NSString *)getPrefixWithLevel:(FMIceLinkLogLevel)level

Parameters

`level`	The log level.

Return Value

The log level as an upper-case string with right-side whitespace padding to ensure a 5-character sequence.

Discussion

Converts a log[level](#//api/name/level) to a 5-character string for consistently-spaced character sequences.

Declared In

FMIceLinkLogProvider.h

`+ getPrefixWithLevel:includeTimestamp:`

Converts a log[level](#//api/name/level) to a 5-character string for consistently-spaced character sequences.

+ (NSString *)getPrefixWithLevel:(FMIceLinkLogLevel)level includeTimestamp:(bool)includeTimestamp

Parameters

`level`	The log level.
`includeTimestamp`	Whether to include a timestamp in the prefix.

Return Value

The log level as an upper-case string with right-side whitespace padding to ensure a 5-character sequence.

Discussion

Converts a log[level](#//api/name/level) to a 5-character string for consistently-spaced character sequences.

Declared In

FMIceLinkLogProvider.h

`– init`

Initializes a new instance of the FMIceLinkLogProvider class.

- (instancetype)init

Discussion

Initializes a new instance of the FMIceLinkLogProvider class.

Declared In

FMIceLinkLogProvider.h

`– level`

Gets the log level.

- (FMIceLinkLogLevel)level

Discussion

Gets the log level.

Declared In

FMIceLinkLogProvider.h

`+ logProvider`

Initializes a new instance of the FMIceLinkLogProvider class.

+ (FMIceLinkLogProvider *)logProvider

Discussion

Initializes a new instance of the FMIceLinkLogProvider class.

Declared In

FMIceLinkLogProvider.h

`– logWithTimestamp:level:tag:message:`

Log a message with no exception.

- (void)logWithTimestamp:(NSDate *)timestamp level:(FMIceLinkLogLevel)level tag:(NSString *)tag message:(NSString *)message

Parameters

`timestamp`	The timestamp when the event occurred.
`level`	The level of log message.
`tag`	The logger tag.
`message`	The log message.

Discussion

Log a message with no exception.

Declared In

FMIceLinkLogProvider.h

`– logWithTimestamp:level:tag:message:ex:`

Log a message.

- (void)logWithTimestamp:(NSDate *)timestamp level:(FMIceLinkLogLevel)level tag:(NSString *)tag message:(NSString *)message ex:(NSException *)ex

Parameters

`timestamp`	The timestamp when the event occurred.
`level`	The level of log message.
`tag`	The logger tag.
`message`	The log message.
`ex`	The exception that occured.

Discussion

Log a message.