-
Notifications
You must be signed in to change notification settings - Fork 0
/
classproio_1_1Reader.html
292 lines (274 loc) · 13.8 KB
/
classproio_1_1Reader.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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
<!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.11"/>
<title>proio: proio::Reader 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>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</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="projectalign" style="padding-left: 0.5em;">
<div id="projectname">proio
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</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>proio</b></li><li class="navelem"><a class="el" href="classproio_1_1Reader.html">Reader</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classproio_1_1Reader-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">proio::Reader Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <<a class="el" href="reader_8h_source.html">reader.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for proio::Reader:</div>
<div class="dyncontent">
<div class="center">
<img src="classproio_1_1Reader.png" usemap="#proio::Reader_map" alt=""/>
<map id="proio::Reader_map" name="proio::Reader_map">
</map>
</div></div>
<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:a8826662f9b377ea0d2959f623db363f5"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classproio_1_1Reader.html#a8826662f9b377ea0d2959f623db363f5">Reader</a> (int fd)</td></tr>
<tr class="separator:a8826662f9b377ea0d2959f623db363f5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae1ecb4f76f8ea6348ecff9dcc1bfe0cc"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classproio_1_1Reader.html#ae1ecb4f76f8ea6348ecff9dcc1bfe0cc">Reader</a> (std::string filename)</td></tr>
<tr class="separator:ae1ecb4f76f8ea6348ecff9dcc1bfe0cc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af58d6e7a51441099ff419c6f03d77565"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classproio_1_1Event.html">Event</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classproio_1_1Reader.html#af58d6e7a51441099ff419c6f03d77565">Next</a> (<a class="el" href="classproio_1_1Event.html">Event</a> *recycledEvent=NULL, bool metadataOnly=false)</td></tr>
<tr class="separator:af58d6e7a51441099ff419c6f03d77565"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8da8aea30ccd4ebcda49b5abf1fa1185"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classproio_1_1Reader.html#a8da8aea30ccd4ebcda49b5abf1fa1185">Next</a> (std::string *data)</td></tr>
<tr class="separator:a8da8aea30ccd4ebcda49b5abf1fa1185"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afd1326802327d7f4241188c4eb8a7b4f"><td class="memItemLeft" align="right" valign="top">uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classproio_1_1Reader.html#afd1326802327d7f4241188c4eb8a7b4f">Skip</a> (uint64_t nEvents)</td></tr>
<tr class="separator:afd1326802327d7f4241188c4eb8a7b4f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a841aff8caf5ca4436555daad3b24a57b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classproio_1_1Reader.html#a841aff8caf5ca4436555daad3b24a57b">SeekToStart</a> ()</td></tr>
<tr class="separator:a841aff8caf5ca4436555daad3b24a57b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa7e4eb70b07c2624be3653e734f0b724"><td class="memItemLeft" align="right" valign="top">const google::protobuf::DescriptorPool * </td><td class="memItemRight" valign="bottom"><a class="el" href="classproio_1_1Reader.html#aa7e4eb70b07c2624be3653e734f0b724">DescriptorPool</a> ()</td></tr>
<tr class="separator:aa7e4eb70b07c2624be3653e734f0b724"><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="classproio_1_1Reader.html">Reader</a> for proio files </p>
<p>Definition at line <a class="el" href="reader_8h_source.html#l00038">38</a> of file <a class="el" href="reader_8h_source.html">reader.h</a>.</p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a8826662f9b377ea0d2959f623db363f5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Reader::Reader </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>fd</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor for providing a file descriptor </p>
<p>Definition at line <a class="el" href="reader_8cc_source.html#l00013">13</a> of file <a class="el" href="reader_8cc_source.html">reader.cc</a>.</p>
</div>
</div>
<a class="anchor" id="ae1ecb4f76f8ea6348ecff9dcc1bfe0cc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Reader::Reader </td>
<td>(</td>
<td class="paramtype">std::string </td>
<td class="paramname"><em>filename</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor that creates a file descriptor from the path of an existing file. </p>
<p>Definition at line <a class="el" href="reader_8cc_source.html#l00021">21</a> of file <a class="el" href="reader_8cc_source.html">reader.cc</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="aa7e4eb70b07c2624be3653e734f0b724"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const google::protobuf::DescriptorPool* proio::Reader::DescriptorPool </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>DescriptorPool returns a pointer to a protobuf descriptor pool that has been built from information included in the stream or file. This can be passed to Events in order to dynamically read entries of types that are not known at compile time. </p>
<p>Definition at line <a class="el" href="reader_8h_source.html#l00073">73</a> of file <a class="el" href="reader_8h_source.html">reader.h</a>.</p>
</div>
</div>
<a class="anchor" id="af58d6e7a51441099ff419c6f03d77565"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classproio_1_1Event.html">Event</a> * Reader::Next </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classproio_1_1Event.html">Event</a> * </td>
<td class="paramname"><em>recycledEvent</em> = <code>NULL</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>metadataOnly</em> = <code>false</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Next returns the next available <a class="el" href="classproio_1_1Event.html">Event</a>. This function takes two important optional arguments. The first argument is a pointer to a recycled <a class="el" href="classproio_1_1Event.html">Event</a> to be cleared and filled by the <a class="el" href="classproio_1_1Reader.html">Reader</a>. The second argument is an option for filling only metadata; this is useful for scanning a file on disk, since only bucket headers need to be read for this. </p>
<p>Definition at line <a class="el" href="reader_8cc_source.html#l00039">39</a> of file <a class="el" href="reader_8cc_source.html">reader.cc</a>.</p>
</div>
</div>
<a class="anchor" id="a8da8aea30ccd4ebcda49b5abf1fa1185"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Reader::Next </td>
<td>(</td>
<td class="paramtype">std::string * </td>
<td class="paramname"><em>data</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Next copies the next event data in protobuf wire format into the given string. </p>
<p>Definition at line <a class="el" href="reader_8cc_source.html#l00059">59</a> of file <a class="el" href="reader_8cc_source.html">reader.cc</a>.</p>
</div>
</div>
<a class="anchor" id="a841aff8caf5ca4436555daad3b24a57b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Reader::SeekToStart </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>SeekToStart sends the reader to the beginning of the stream if it is seekable. </p>
<p>Definition at line <a class="el" href="reader_8cc_source.html#l00096">96</a> of file <a class="el" href="reader_8cc_source.html">reader.cc</a>.</p>
</div>
</div>
<a class="anchor" id="afd1326802327d7f4241188c4eb8a7b4f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint64_t Reader::Skip </td>
<td>(</td>
<td class="paramtype">uint64_t </td>
<td class="paramname"><em>nEvents</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Skip skips the next nEvents events. </p>
<p>Definition at line <a class="el" href="reader_8cc_source.html#l00074">74</a> of file <a class="el" href="reader_8cc_source.html">reader.cc</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>/home/travis/build/proio-org/cpp-proio/src/<a class="el" href="reader_8h_source.html">reader.h</a></li>
<li>/home/travis/build/proio-org/cpp-proio/src/<a class="el" href="reader_8cc_source.html">reader.cc</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>