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
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
|
<!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>dashel: Dashel::Stream 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="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">dashel
 <span id="projectnumber">1.3.3</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</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>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</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>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceDashel.html">Dashel</a></li><li class="navelem"><a class="el" href="classDashel_1_1Stream.html">Stream</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> |
<a href="#friends">Friends</a> |
<a href="classDashel_1_1Stream-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Dashel::Stream Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>A data stream, with low-level (not-endian safe) read/write functions.
<a href="classDashel_1_1Stream.html#details">More...</a></p>
<p><code>#include <<a class="el" href="dashel_8h_source.html">dashel.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for Dashel::Stream:</div>
<div class="dyncontent">
<div class="center">
<img src="classDashel_1_1Stream.png" usemap="#Dashel::Stream_map" alt=""/>
<map id="Dashel::Stream_map" name="Dashel::Stream_map">
<area href="classDashel_1_1PacketStream.html" title="A data stream, that can be later send data as at UDP packet or read data from an UDP packet..." alt="Dashel::PacketStream" shape="rect" coords="0,56,134,80"/>
</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:a935d5ea862d616c18ce56fc5ccd24cac"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDashel_1_1Stream.html#a935d5ea862d616c18ce56fc5ccd24cac">fail</a> (<a class="el" href="classDashel_1_1DashelException.html#a6d3b944b80a994ec376e26a035b45c43">DashelException::Source</a> s, int se, const char *reason)</td></tr>
<tr class="memdesc:a935d5ea862d616c18ce56fc5ccd24cac"><td class="mdescLeft"> </td><td class="mdescRight">Set stream to failed state. <a href="#a935d5ea862d616c18ce56fc5ccd24cac">More...</a><br /></td></tr>
<tr class="separator:a935d5ea862d616c18ce56fc5ccd24cac"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9b75831260a3dc9941533985ad5084c7"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classDashel_1_1Stream.html#a9b75831260a3dc9941533985ad5084c7">failed</a> () const </td></tr>
<tr class="memdesc:a9b75831260a3dc9941533985ad5084c7"><td class="mdescLeft"> </td><td class="mdescRight">Query failed state of stream. <a href="#a9b75831260a3dc9941533985ad5084c7">More...</a><br /></td></tr>
<tr class="separator:a9b75831260a3dc9941533985ad5084c7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a41520ca590a0a5e4b416518a40994226"><td class="memItemLeft" align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classDashel_1_1Stream.html#a41520ca590a0a5e4b416518a40994226">getFailReason</a> () const </td></tr>
<tr class="memdesc:a41520ca590a0a5e4b416518a40994226"><td class="mdescLeft"> </td><td class="mdescRight">Returns the reason the stream has failed. <a href="#a41520ca590a0a5e4b416518a40994226">More...</a><br /></td></tr>
<tr class="separator:a41520ca590a0a5e4b416518a40994226"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5de8184d40762acbfe59f3672285fb72"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5de8184d40762acbfe59f3672285fb72"></a>
const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classDashel_1_1Stream.html#a5de8184d40762acbfe59f3672285fb72">getProtocolName</a> () const </td></tr>
<tr class="memdesc:a5de8184d40762acbfe59f3672285fb72"><td class="mdescLeft"> </td><td class="mdescRight">Returns the protocol name of the stream. <br /></td></tr>
<tr class="separator:a5de8184d40762acbfe59f3672285fb72"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad82f0c136eb60bdbc2ba632e716f97e9"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classDashel_1_1Stream.html#ad82f0c136eb60bdbc2ba632e716f97e9">getTargetName</a> () const </td></tr>
<tr class="memdesc:ad82f0c136eb60bdbc2ba632e716f97e9"><td class="mdescLeft"> </td><td class="mdescRight">Returns the name of the target. <a href="#ad82f0c136eb60bdbc2ba632e716f97e9">More...</a><br /></td></tr>
<tr class="separator:ad82f0c136eb60bdbc2ba632e716f97e9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a81848313db8d819c893fdd6ad582a22f"><td class="memItemLeft" align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classDashel_1_1Stream.html#a81848313db8d819c893fdd6ad582a22f">getTargetParameter</a> (const char *param) const </td></tr>
<tr class="memdesc:a81848313db8d819c893fdd6ad582a22f"><td class="mdescLeft"> </td><td class="mdescRight">Returns the value of a parameter extracted from the target. <a href="#a81848313db8d819c893fdd6ad582a22f">More...</a><br /></td></tr>
<tr class="separator:a81848313db8d819c893fdd6ad582a22f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a41e9e6bb996f8075eb77ba47fa1ca250"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classDashel_1_1ParameterSet.html">ParameterSet</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classDashel_1_1Stream.html#a41e9e6bb996f8075eb77ba47fa1ca250">getTarget</a> () const </td></tr>
<tr class="memdesc:a41e9e6bb996f8075eb77ba47fa1ca250"><td class="mdescLeft"> </td><td class="mdescRight">Returns the target description. <a href="#a41e9e6bb996f8075eb77ba47fa1ca250">More...</a><br /></td></tr>
<tr class="separator:a41e9e6bb996f8075eb77ba47fa1ca250"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7cf44afc44d69075ffdd7170d4341ba7"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDashel_1_1Stream.html#a7cf44afc44d69075ffdd7170d4341ba7">write</a> (const void *data, const size_t size)=0</td></tr>
<tr class="memdesc:a7cf44afc44d69075ffdd7170d4341ba7"><td class="mdescLeft"> </td><td class="mdescRight">Write data to the stream. <a href="#a7cf44afc44d69075ffdd7170d4341ba7">More...</a><br /></td></tr>
<tr class="separator:a7cf44afc44d69075ffdd7170d4341ba7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1114aa6f8a0d40e8c1f922d568d5145d"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
<tr class="memitem:a1114aa6f8a0d40e8c1f922d568d5145d"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classDashel_1_1Stream.html#a1114aa6f8a0d40e8c1f922d568d5145d">write</a> (T v)</td></tr>
<tr class="memdesc:a1114aa6f8a0d40e8c1f922d568d5145d"><td class="mdescLeft"> </td><td class="mdescRight">Write a variable of basic type to the stream. <a href="#a1114aa6f8a0d40e8c1f922d568d5145d">More...</a><br /></td></tr>
<tr class="separator:a1114aa6f8a0d40e8c1f922d568d5145d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a52d85bd17026db637a702a9db59ce7c1"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDashel_1_1Stream.html#a52d85bd17026db637a702a9db59ce7c1">flush</a> ()=0</td></tr>
<tr class="memdesc:a52d85bd17026db637a702a9db59ce7c1"><td class="mdescLeft"> </td><td class="mdescRight">Flushes stream. <a href="#a52d85bd17026db637a702a9db59ce7c1">More...</a><br /></td></tr>
<tr class="separator:a52d85bd17026db637a702a9db59ce7c1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2f20b20cf7929f19851c5501d2abc4ed"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDashel_1_1Stream.html#a2f20b20cf7929f19851c5501d2abc4ed">read</a> (void *data, size_t size)=0</td></tr>
<tr class="memdesc:a2f20b20cf7929f19851c5501d2abc4ed"><td class="mdescLeft"> </td><td class="mdescRight">Reads data from the stream. <a href="#a2f20b20cf7929f19851c5501d2abc4ed">More...</a><br /></td></tr>
<tr class="separator:a2f20b20cf7929f19851c5501d2abc4ed"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a285a0773aecbe3362dfe54430cfcf6e7"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
<tr class="memitem:a285a0773aecbe3362dfe54430cfcf6e7"><td class="memTemplItemLeft" align="right" valign="top">T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classDashel_1_1Stream.html#a285a0773aecbe3362dfe54430cfcf6e7">read</a> ()</td></tr>
<tr class="memdesc:a285a0773aecbe3362dfe54430cfcf6e7"><td class="mdescLeft"> </td><td class="mdescRight">Read a variable of basic type from the stream. <a href="#a285a0773aecbe3362dfe54430cfcf6e7">More...</a><br /></td></tr>
<tr class="separator:a285a0773aecbe3362dfe54430cfcf6e7"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:ad8d9725470a8d5c19ef79599939580f7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad8d9725470a8d5c19ef79599939580f7"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classDashel_1_1Stream.html#ad8d9725470a8d5c19ef79599939580f7">Stream</a> (const std::string &<a class="el" href="classDashel_1_1Stream.html#af7de9b4311e7ad2e6580def9826e0396">protocolName</a>)</td></tr>
<tr class="memdesc:ad8d9725470a8d5c19ef79599939580f7"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <br /></td></tr>
<tr class="separator:ad8d9725470a8d5c19ef79599939580f7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a945e75312c20b560a2634d3ec5d75e62"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a945e75312c20b560a2634d3ec5d75e62"></a>
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classDashel_1_1Stream.html#a945e75312c20b560a2634d3ec5d75e62">~Stream</a> ()</td></tr>
<tr class="memdesc:a945e75312c20b560a2634d3ec5d75e62"><td class="mdescLeft"> </td><td class="mdescRight">Virtual destructor, to ensure calls to destructors of sub-classes. <br /></td></tr>
<tr class="separator:a945e75312c20b560a2634d3ec5d75e62"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a50d83e8bc9c99ad83df53ccc6ffbe362"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a50d83e8bc9c99ad83df53ccc6ffbe362"></a>
<a class="el" href="classDashel_1_1ParameterSet.html">ParameterSet</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classDashel_1_1Stream.html#a50d83e8bc9c99ad83df53ccc6ffbe362">target</a></td></tr>
<tr class="memdesc:a50d83e8bc9c99ad83df53ccc6ffbe362"><td class="mdescLeft"> </td><td class="mdescRight">The target description. <br /></td></tr>
<tr class="separator:a50d83e8bc9c99ad83df53ccc6ffbe362"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af7de9b4311e7ad2e6580def9826e0396"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af7de9b4311e7ad2e6580def9826e0396"></a>
std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classDashel_1_1Stream.html#af7de9b4311e7ad2e6580def9826e0396">protocolName</a></td></tr>
<tr class="memdesc:af7de9b4311e7ad2e6580def9826e0396"><td class="mdescLeft"> </td><td class="mdescRight">The protocol name. <br /></td></tr>
<tr class="separator:af7de9b4311e7ad2e6580def9826e0396"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:aea14f5495b4697c28ed665a9054acf5e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aea14f5495b4697c28ed665a9054acf5e"></a>
class </td><td class="memItemRight" valign="bottom"><b>Hub</b></td></tr>
<tr class="separator:aea14f5495b4697c28ed665a9054acf5e"><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 data stream, with low-level (not-endian safe) read/write functions. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a935d5ea862d616c18ce56fc5ccd24cac"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Dashel::Stream::fail </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classDashel_1_1DashelException.html#a6d3b944b80a994ec376e26a035b45c43">DashelException::Source</a> </td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>se</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>reason</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set stream to failed state. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">s</td><td>Source of failure </td></tr>
<tr><td class="paramname">se</td><td>System error code </td></tr>
<tr><td class="paramname">reason</td><td>The logical reason as a human readable string. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a9b75831260a3dc9941533985ad5084c7"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool Dashel::Stream::failed </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</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>Query failed state of stream. </p>
<dl class="section return"><dt>Returns</dt><dd>true if stream has failed. </dd></dl>
</div>
</div>
<a class="anchor" id="a52d85bd17026db637a702a9db59ce7c1"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void Dashel::Stream::flush </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Flushes stream. </p>
<p>Calling this function requests the stream to be flushed, this may ensure that data is written to physical media or actually sent over a wire. The exact performed function depends on the stream type and operating system. </p>
</div>
</div>
<a class="anchor" id="a41520ca590a0a5e4b416518a40994226"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const std::string& Dashel::Stream::getFailReason </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</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>Returns the reason the stream has failed. </p>
<dl class="section return"><dt>Returns</dt><dd>the reason the stream has failed, or an empty string if <a class="el" href="classDashel_1_1Stream.html#a935d5ea862d616c18ce56fc5ccd24cac" title="Set stream to failed state. ">fail()</a> is false. </dd></dl>
</div>
</div>
<a class="anchor" id="a41e9e6bb996f8075eb77ba47fa1ca250"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classDashel_1_1ParameterSet.html">ParameterSet</a> Dashel::Stream::getTarget </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</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>Returns the target description. </p>
<dl class="section return"><dt>Returns</dt><dd>The set of parameters describing this target </dd></dl>
</div>
</div>
<a class="anchor" id="ad82f0c136eb60bdbc2ba632e716f97e9"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string Dashel::Stream::getTargetName </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</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>Returns the name of the target. </p>
<p>The name of the target contains all parameters and the protocol name.</p>
<dl class="section return"><dt>Returns</dt><dd>Name of the target </dd></dl>
<p>References <a class="el" href="classDashel_1_1ParameterSet.html#a1057f2eeacfe0f1603162927b15cd715">Dashel::ParameterSet::getString()</a>.</p>
</div>
</div>
<a class="anchor" id="a81848313db8d819c893fdd6ad582a22f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const std::string& Dashel::Stream::getTargetParameter </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>param</em></td><td>)</td>
<td> const</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>Returns the value of a parameter extracted from the target. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">param</td><td>the name of the parameter </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A string containing the parameter. </dd></dl>
<p>References <a class="el" href="classDashel_1_1ParameterSet.html#a8385ebe2740c3c908cbc4e72ce96b8fc">Dashel::ParameterSet::get()</a>.</p>
</div>
</div>
<a class="anchor" id="a2f20b20cf7929f19851c5501d2abc4ed"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void Dashel::Stream::read </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>size</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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reads data from the stream. </p>
<p>Reads all requested data from the stream, blocking until all the data has been read, or some error occurs. Errors are signaled by throwing a <a class="el" href="classDashel_1_1DashelException.html" title="The one size fits all exception for streams. ">DashelException</a> exception, which may be caused either by device errors or reaching the end of file.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>Pointer to the memory where the read data should be stored. </td></tr>
<tr><td class="paramname">size</td><td>Amount of data to read in bytes. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a285a0773aecbe3362dfe54430cfcf6e7"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">T Dashel::Stream::read </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>Read a variable of basic type from the stream. </p>
<p>This function does not perform any endian conversion.</p>
<dl class="section return"><dt>Returns</dt><dd>variable to read. </dd></dl>
</div>
</div>
<a class="anchor" id="a7cf44afc44d69075ffdd7170d4341ba7"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void Dashel::Stream::write </td>
<td>(</td>
<td class="paramtype">const void * </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const size_t </td>
<td class="paramname"><em>size</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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Write data to the stream. </p>
<p>Writes all requested data to the stream, blocking until all the data has been written, or some error occurs. Errors are signaled by throwing a <a class="el" href="classDashel_1_1DashelException.html" title="The one size fits all exception for streams. ">DashelException</a> exception. This function does not flush devices, therefore the data may not really have been written on return, but only been buffered. In order to flush the stream, call <a class="el" href="classDashel_1_1Stream.html#a52d85bd17026db637a702a9db59ce7c1" title="Flushes stream. ">flush()</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>Pointer to the data to write. </td></tr>
<tr><td class="paramname">size</td><td>Amount of data to write in bytes. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a1114aa6f8a0d40e8c1f922d568d5145d"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void Dashel::Stream::write </td>
<td>(</td>
<td class="paramtype">T </td>
<td class="paramname"><em>v</em></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>Write a variable of basic type to the stream. </p>
<p>This function does not perform any endian conversion. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">v</td><td>variable to write. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>dashel/<a class="el" href="dashel_8h_source.html">dashel.h</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>
|
