forked from alexa/alexa-auto-sdk
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathclassaace_1_1logger_1_1_logger.html
220 lines (212 loc) · 10.7 KB
/
classaace_1_1logger_1_1_logger.html
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
217
218
219
220
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Alexa Auto SDK: aace::logger::Logger Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="aace-logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Alexa Auto SDK
 <span id="projectnumber">1.0.2</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>aace</b></li><li class="navelem"><b>logger</b></li><li class="navelem"><a class="el" href="classaace_1_1logger_1_1_logger.html">Logger</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="classaace_1_1logger_1_1_logger-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">aace::logger::Logger Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:acde0b19d1be1c61274536b6a955d2d7a"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classaace_1_1logger_1_1_logger.html#acde0b19d1be1c61274536b6a955d2d7a">Level</a> = <a class="el" href="classaace_1_1logger_1_1_logger_engine_interface.html#aa97c461bbc4f77638b45f7eb9271b786">aace::logger::LoggerEngineInterface::Level</a></td></tr>
<tr class="separator:acde0b19d1be1c61274536b6a955d2d7a"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a5114127c48c451e846ca3d1b120a3f44"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classaace_1_1logger_1_1_logger.html#a5114127c48c451e846ca3d1b120a3f44">logEvent</a> (<a class="el" href="classaace_1_1logger_1_1_logger_engine_interface.html#aa97c461bbc4f77638b45f7eb9271b786">aace::logger::Logger::Level</a> level, std::chrono::system_clock::time_point time, const std::string &source, const std::string &message)</td></tr>
<tr class="separator:a5114127c48c451e846ca3d1b120a3f44"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3cb300839a1de085377517669522ad78"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaace_1_1logger_1_1_logger.html#a3cb300839a1de085377517669522ad78">log</a> (<a class="el" href="classaace_1_1logger_1_1_logger_engine_interface.html#aa97c461bbc4f77638b45f7eb9271b786">Level</a> level, const std::string &tag, const std::string &message)</td></tr>
<tr class="separator:a3cb300839a1de085377517669522ad78"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classaace_1_1logger_1_1_logger.html">Logger</a> should be extended handle log events from the AAC SDK. </p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="acde0b19d1be1c61274536b6a955d2d7a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acde0b19d1be1c61274536b6a955d2d7a">◆ </a></span>Level</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classaace_1_1logger_1_1_logger_engine_interface.html#aa97c461bbc4f77638b45f7eb9271b786">aace::logger::Logger::Level</a> = <a class="el" href="classaace_1_1logger_1_1_logger_engine_interface.html#aa97c461bbc4f77638b45f7eb9271b786">aace::logger::LoggerEngineInterface::Level</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Specifies the severity level of a log message </p><dl class="section see"><dt>See also</dt><dd><code><a class="el" href="classaace_1_1logger_1_1_logger_engine_interface.html#aa97c461bbc4f77638b45f7eb9271b786">aace::logger::LoggerEngineInterface::Level</a></code> </dd></dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a5114127c48c451e846ca3d1b120a3f44"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5114127c48c451e846ca3d1b120a3f44">◆ </a></span>logEvent()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool aace::logger::Logger::logEvent </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classaace_1_1logger_1_1_logger_engine_interface.html#aa97c461bbc4f77638b45f7eb9271b786">aace::logger::Logger::Level</a> </td>
<td class="paramname"><em>level</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::chrono::system_clock::time_point </td>
<td class="paramname"><em>time</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>message</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Notifies the platform implementation of a log event from the AAC SDK logger</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">level</td><td>The log level </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">time</td><td>The timestamp of the logged message </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">source</td><td>The source of the log message </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">message</td><td>The log message</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if the platform implementation successfully handled the log event, else <code>false</code> </dd></dl>
</div>
</div>
<a id="a3cb300839a1de085377517669522ad78"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3cb300839a1de085377517669522ad78">◆ </a></span>log()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void aace::logger::Logger::log </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classaace_1_1logger_1_1_logger_engine_interface.html#aa97c461bbc4f77638b45f7eb9271b786">Level</a> </td>
<td class="paramname"><em>level</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>tag</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>message</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Notifies the Engine to use the AAC SDK logger to log a message originating on the platform. The log event will be received by the platform with a call to <code><a class="el" href="classaace_1_1logger_1_1_logger.html#a5114127c48c451e846ca3d1b120a3f44">logEvent()</a></code> from the Engine.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">level</td><td>The log level </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">tag</td><td>The log tag </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">message</td><td>The log message </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
<html>
<body>
<hr style="height:1px;border-width:0;color:gray;background-color:gray">
<p style="text-align:left;">
Alexa Auto SDK 1.0.2 - Copyright 2017-2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
<span style="float:right;">
Licensed under the <a HREF=http://aws.amazon.com/apache2.0/>Apache License, Version 2.0</a>
</span>
</p>
</body>
</html>