xref: /netbsd-src/external/mit/libcbor/dist/docs/doxygen/streaming_8h.html (revision 5dd36a3bc8bf2a9dec29ceb6349550414570c447)
1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xmlns="http://www.w3.org/1999/xhtml">
3<head>
4<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6<meta name="generator" content="Doxygen 1.8.12"/>
7<meta name="viewport" content="width=device-width, initial-scale=1"/>
8<title>libcbor: src/cbor/streaming.h File Reference</title>
9<link href="tabs.css" rel="stylesheet" type="text/css"/>
10<script type="text/javascript" src="jquery.js"></script>
11<script type="text/javascript" src="dynsections.js"></script>
12<link href="search/search.css" rel="stylesheet" type="text/css"/>
13<script type="text/javascript" src="search/searchdata.js"></script>
14<script type="text/javascript" src="search/search.js"></script>
15<link href="doxygen.css" rel="stylesheet" type="text/css" />
16<link href="customdoxygen.css" rel="stylesheet" type="text/css"/>
17</head>
18<body>
19<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
20<div id="titlearea">
21<table cellspacing="0" cellpadding="0">
22 <tbody>
23 <tr style="height: 56px;">
24  <td id="projectalign" style="padding-left: 0.5em;">
25   <div id="projectname">libcbor
26   &#160;<span id="projectnumber">0.5.0</span>
27   </div>
28   <div id="projectbrief">libcbor is a C library for parsing and generating CBOR, the general-purpose schema-less binary data format.</div>
29  </td>
30 </tr>
31 </tbody>
32</table>
33</div>
34<!-- end header part -->
35<!-- Generated by Doxygen 1.8.12 -->
36<script type="text/javascript">
37var searchBox = new SearchBox("searchBox", "search",false,'Search');
38</script>
39<script type="text/javascript" src="menudata.js"></script>
40<script type="text/javascript" src="menu.js"></script>
41<script type="text/javascript">
42$(function() {
43  initMenu('',true,false,'search.php','Search');
44  $(document).ready(function() { init_search(); });
45});
46</script>
47<div id="main-nav"></div>
48<!-- window showing the filter options -->
49<div id="MSearchSelectWindow"
50     onmouseover="return searchBox.OnSearchSelectShow()"
51     onmouseout="return searchBox.OnSearchSelectHide()"
52     onkeydown="return searchBox.OnSearchSelectKey(event)">
53</div>
54
55<!-- iframe showing the search results (closed by default) -->
56<div id="MSearchResultsWindow">
57<iframe src="javascript:void(0)" frameborder="0"
58        name="MSearchResults" id="MSearchResults">
59</iframe>
60</div>
61
62<div id="nav-path" class="navpath">
63  <ul>
64<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_cb565ba51d82ea933604984cbab6233d.html">cbor</a></li>  </ul>
65</div>
66</div><!-- top -->
67<div class="header">
68  <div class="summary">
69<a href="#func-members">Functions</a>  </div>
70  <div class="headertitle">
71<div class="title">streaming.h File Reference</div>  </div>
72</div><!--header-->
73<div class="contents">
74<div class="textblock"><code>#include &quot;<a class="el" href="common_8h_source.html">cbor/common.h</a>&quot;</code><br />
75<code>#include &quot;<a class="el" href="callbacks_8h_source.html">callbacks.h</a>&quot;</code><br />
76</div>
77<p><a href="streaming_8h_source.html">Go to the source code of this file.</a></p>
78<table class="memberdecls">
79<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
80Functions</h2></td></tr>
81<tr class="memitem:aadf8db8555f22bbd5a2acfd77170b2be"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structcbor__decoder__result.html">cbor_decoder_result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="streaming_8h.html#aadf8db8555f22bbd5a2acfd77170b2be">cbor_stream_decode</a> (<a class="el" href="data_8h.html#a121c5944682215e742475f12f07c0a72">cbor_data</a> buffer, size_t buffer_size, const struct <a class="el" href="structcbor__callbacks.html">cbor_callbacks</a> *callbacks, void *context)</td></tr>
82<tr class="memdesc:aadf8db8555f22bbd5a2acfd77170b2be"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stateless decoder.  <a href="#aadf8db8555f22bbd5a2acfd77170b2be">More...</a><br /></td></tr>
83<tr class="separator:aadf8db8555f22bbd5a2acfd77170b2be"><td class="memSeparator" colspan="2">&#160;</td></tr>
84</table>
85<h2 class="groupheader">Function Documentation</h2>
86<a id="aadf8db8555f22bbd5a2acfd77170b2be"></a>
87<h2 class="memtitle"><span class="permalink"><a href="#aadf8db8555f22bbd5a2acfd77170b2be">&sect;&nbsp;</a></span>cbor_stream_decode()</h2>
88
89<div class="memitem">
90<div class="memproto">
91      <table class="memname">
92        <tr>
93          <td class="memname">struct <a class="el" href="structcbor__decoder__result.html">cbor_decoder_result</a> cbor_stream_decode </td>
94          <td>(</td>
95          <td class="paramtype"><a class="el" href="data_8h.html#a121c5944682215e742475f12f07c0a72">cbor_data</a>&#160;</td>
96          <td class="paramname"><em>buffer</em>, </td>
97        </tr>
98        <tr>
99          <td class="paramkey"></td>
100          <td></td>
101          <td class="paramtype">size_t&#160;</td>
102          <td class="paramname"><em>buffer_size</em>, </td>
103        </tr>
104        <tr>
105          <td class="paramkey"></td>
106          <td></td>
107          <td class="paramtype">const struct <a class="el" href="structcbor__callbacks.html">cbor_callbacks</a> *&#160;</td>
108          <td class="paramname"><em>callbacks</em>, </td>
109        </tr>
110        <tr>
111          <td class="paramkey"></td>
112          <td></td>
113          <td class="paramtype">void *&#160;</td>
114          <td class="paramname"><em>context</em>&#160;</td>
115        </tr>
116        <tr>
117          <td></td>
118          <td>)</td>
119          <td></td><td></td>
120        </tr>
121      </table>
122</div><div class="memdoc">
123
124<p>Stateless decoder. </p>
125<p>Will try parsing the <code>buffer</code> and will invoke the appropriate callback on success. Decodes one item at a time. No memory allocations occur.</p>
126<dl class="params"><dt>Parameters</dt><dd>
127  <table class="params">
128    <tr><td class="paramname">buffer</td><td>Input buffer </td></tr>
129    <tr><td class="paramname">buffer_size</td><td>Length of the buffer </td></tr>
130    <tr><td class="paramname">callbacks</td><td>The callback bundle </td></tr>
131    <tr><td class="paramname">context</td><td>An arbitrary pointer to allow for maintaining context. </td></tr>
132  </table>
133  </dd>
134</dl>
135
136<p>Definition at line <a class="el" href="streaming_8c_source.html#l00026">26</a> of file <a class="el" href="streaming_8c_source.html">streaming.c</a>.</p>
137
138</div>
139</div>
140</div><!-- contents -->
141<!-- start footer part -->
142<hr class="footer"/><address class="footer"><small>
143Generated on Mon Feb 6 2017 00:26:19 for libcbor by &#160;<a href="http://www.doxygen.org/index.html">
144<img class="footer" src="doxygen.png" alt="doxygen"/>
145</a> 1.8.12
146</small></address>
147</body>
148</html>
149