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
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
|
<h1>SDLLogConfiguration Class Reference</h1>
<h3>Section Contents</h3>
<ul>
<li><a href="#section-modules">modules</a></li>
<li><a href="#section-targets">targets</a></li>
<li><a href="#section-filters">filters</a></li>
<li><a href="#section-formatType">formatType</a></li>
<li><a href="#section-asynchronous">asynchronous</a></li>
<li><a href="#section-errorsAsynchronous">errorsAsynchronous</a></li>
<li><a href="#section-disableAssertions">disableAssertions</a></li>
<li><a href="#section-globalLogLevel">globalLogLevel</a></li>
<li><a href="#section-+defaultConfiguration">+defaultConfiguration</a></li>
<li><a href="#section-+debugConfiguration">+debugConfiguration</a></li>
</ul>
<h3>Overview</h3>
<p>Information about the current logging configuration</p>
<section class="section task-group-section">
<h3 id="section-modules">
modules
</h3>
<p>Any custom logging modules used by the developer’s code. Defaults to none.</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">copy</span><span class="p">)</span> <span class="n">NSSet</span><span class="o"><</span><span class="n"><a href="../Classes/SDLLogFileModule.html">SDLLogFileModule</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">modules</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">modules</span><span class="p">:</span> <span class="kt">Set</span><span class="o"><</span><span class="kt">AnyHashable</span><span class="o">></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
<h3 id="section-targets">
targets
</h3>
<p>Where the logs will attempt to output. Defaults to Console.</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">copy</span><span class="p">)</span> <span class="n">NSSet</span><span class="o"><</span><span class="n">id</span><span class="o"><</span><span class="n"><a href="../Protocols/SDLLogTarget.html">SDLLogTarget</a></span><span class="o">>></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">targets</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">targets</span><span class="p">:</span> <span class="kt">Set</span><span class="o"><</span><span class="kt">AnyHashable</span><span class="o">></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
<h3 id="section-filters">
filters
</h3>
<p>What log filters will run over this session. Defaults to none.</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">copy</span><span class="p">)</span> <span class="n">NSSet</span><span class="o"><</span><span class="n"><a href="../Classes/SDLLogFilter.html">SDLLogFilter</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">filters</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">filters</span><span class="p">:</span> <span class="kt">Set</span><span class="o"><</span><span class="kt"><a href="../Classes/SDLLogFilter.html">SDLLogFilter</a></span><span class="o">></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
<h3 id="section-formatType">
formatType
</h3>
<p>How detailed of logs will be output. Defaults to Default.</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Enums/SDLLogFormatType.html">SDLLogFormatType</a></span> <span class="n">formatType</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">formatType</span><span class="p">:</span> <span class="kt"><a href="../Enums/SDLLogFormatType.html">SDLLogFormatType</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
<h3 id="section-asynchronous">
asynchronous
</h3>
<p>Whether or not logs will be run on a separate queue, asynchronously, allowing the following code to run before the log completes. Or if it will occur synchronously, which will prevent logs from being missed, but will slow down surrounding code. Defaults to YES.</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">assign</span><span class="p">,</span> <span class="n">unsafe_unretained</span><span class="p">,</span> <span class="n">readwrite</span><span class="p">,</span>
<span class="n">getter</span><span class="o">=</span><span class="n">isAsynchronous</span><span class="p">)</span> <span class="n">BOOL</span> <span class="n">asynchronous</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">isAsynchronous</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
<h3 id="section-errorsAsynchronous">
errorsAsynchronous
</h3>
<p>Whether or not error logs will be dispatched to loggers asynchronously. Defaults to NO.</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">assign</span><span class="p">,</span> <span class="n">unsafe_unretained</span><span class="p">,</span> <span class="n">readwrite</span><span class="p">,</span>
<span class="n">getter</span><span class="o">=</span><span class="n">areErrorsAsynchronous</span><span class="p">)</span> <span class="n">BOOL</span> <span class="n">errorsAsynchronous</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">areErrorsAsynchronous</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
<h3 id="section-disableAssertions">
disableAssertions
</h3>
<p>Whether or not assert logs will fire assertions in DEBUG mode. Assertions are always disabled in RELEASE builds. If assertions are disabled, only an error log will fire instead. Defaults to NO.</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">assign</span><span class="p">,</span> <span class="n">unsafe_unretained</span><span class="p">,</span> <span class="n">readwrite</span><span class="p">,</span>
<span class="n">getter</span><span class="o">=</span><span class="n">areAssertionsDisabled</span><span class="p">)</span> <span class="n">BOOL</span> <span class="n">disableAssertions</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">areAssertionsDisabled</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
<h3 id="section-globalLogLevel">
globalLogLevel
</h3>
<p>Any modules that do not have an explicitly specified level will by default use the global log level. Defaults to Error.
Do not specify Default for this parameter.</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Enums/SDLLogLevel.html">SDLLogLevel</a></span> <span class="n">globalLogLevel</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">globalLogLevel</span><span class="p">:</span> <span class="kt"><a href="../Enums/SDLLogLevel.html">SDLLogLevel</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
<h3 id="section-+defaultConfiguration">
+defaultConfiguration
</h3>
<p>A default logger for production. This sets the format type to Default, the log level to Error, and only enables the ASL logger.</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">+</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span><span class="n">defaultConfiguration</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="kd">class</span> <span class="kd">func</span> <span class="p">`</span><span class="nv">default</span><span class="p">`()</span> <span class="o">-></span> <span class="k">Self</span></code></pre>
<div>
<h4>Return Value</h4>
<p>A default configuration that may be customized.</p>
</div>
<h3 id="section-+debugConfiguration">
+debugConfiguration
</h3>
<p>A debug logger for use in development. This sets the format type to Detailed, the log level to Debug, and enables the Console and ASL loggers.</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">+</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span><span class="n">debugConfiguration</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">debug</span><span class="p">()</span> <span class="o">-></span> <span class="k">Self</span></code></pre>
<div>
<h4>Return Value</h4>
<p>A debug configuration that may be customized.</p>
</div>
</section>
|
