summaryrefslogtreecommitdiff
path: root/SmartDeviceLink/SDLLogTarget.h
blob: 0751dcb16c787e7c2062f839a7816db501eb29ed (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
//
//  SDLLogTarget.h
//  SmartDeviceLink-iOS
//
//  Created by Joel Fischer on 2/27/17.
//  Copyright © 2017 smartdevicelink. All rights reserved.
//

#import <Foundation/Foundation.h>

@class SDLLogModel;


NS_ASSUME_NONNULL_BEGIN

@protocol SDLLogTarget <NSObject>

/**
 A simple convenience initializer to create the object. This *should not* start up the logger.

 @return An instance of the logger.
 */
+ (id<SDLLogTarget>)logger;

/**
 A call to setup the logger in whatever manner it needs to do so.

 @return Whether or not the logger set up correctly.
 */
- (BOOL)setupLogger;

/**
 Log a particular log using the model and the formatted log message to the target.

 @param log The log model, if you can log additional data, such as the log level, use this
 @param stringLog The formatted message
 */
- (void)logWithLog:(SDLLogModel *)log formattedLog:(NSString *)stringLog;
- (void)teardownLogger;

@end

NS_ASSUME_NONNULL_END