-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathbuf_8h.html
More file actions
274 lines (257 loc) · 13.5 KB
/
buf_8h.html
File metadata and controls
274 lines (257 loc) · 13.5 KB
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
<!-- HTML header for doxygen 1.8.10-->
<!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.9.4"/>
<title>librsync: buf.h File 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! -->
<!-- ad -->
<script async src="//pagead2.googlesyndication.com/pagead/js/adsbygoogle.js"></script>
<!-- librsync -->
<ins class="adsbygoogle"
style="display:block"
data-ad-client="ca-pub-3547096055927362"
data-ad-slot="8322976738"
data-ad-format="auto"></ins>
<script>
(adsbygoogle = window.adsbygoogle || []).push({});
</script>
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">librsync
 <span id="projectnumber">2.3.4</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() {
initMenu('',false,false,'search.php','Search');
});
/* @license-end */
</script>
<div id="main-nav"></div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">buf.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Buffers that map between stdio file streams and librsync streams.
<a href="#details">More...</a></p>
<div class="textblock"><div class="dynheader">
Include dependency graph for buf.h:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="buf_8h__incl.svg" width="422" height="187"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
</div>
</div><div class="textblock"><div class="dynheader">
This graph shows which files directly or indirectly include this file:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="buf_8h__dep__incl.svg" width="160" height="112"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
</div>
</div>
<p><a href="buf_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:aa63f18e52e4f1ec7c2992586e4d5fc0d"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structrs__filebuf.html">rs_filebuf</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="buf_8h.html#aa63f18e52e4f1ec7c2992586e4d5fc0d">rs_filebuf_t</a></td></tr>
<tr class="separator:aa63f18e52e4f1ec7c2992586e4d5fc0d"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a5bebdf459784529e1fbf406329f21688"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structrs__filebuf.html">rs_filebuf_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="buf_8h.html#a5bebdf459784529e1fbf406329f21688">rs_filebuf_new</a> (FILE *f, size_t buf_len)</td></tr>
<tr class="separator:a5bebdf459784529e1fbf406329f21688"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aded00ad7bc7680c37da5634b03cb57df"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="buf_8h.html#aded00ad7bc7680c37da5634b03cb57df">rs_filebuf_free</a> (<a class="el" href="structrs__filebuf.html">rs_filebuf_t</a> *fb)</td></tr>
<tr class="separator:aded00ad7bc7680c37da5634b03cb57df"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5353f439325fb75d59031454124c4ce8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="librsync_8h.html#a7feb858ceba3b8f3cf048d49be108253">rs_result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="buf_8h.html#a5353f439325fb75d59031454124c4ce8">rs_infilebuf_fill</a> (<a class="el" href="librsync_8h.html#add6622b38e3fa557301a190876d5ed4a">rs_job_t</a> *, <a class="el" href="librsync_8h.html#abf9f543dbfe5c1e60c8ed1c93d087767">rs_buffers_t</a> *buf, void *fb)</td></tr>
<tr class="separator:a5353f439325fb75d59031454124c4ce8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a95629a3e2b79ed7d37b4a03ba0dd3bca"><td class="memItemLeft" align="right" valign="top"><a class="el" href="librsync_8h.html#a7feb858ceba3b8f3cf048d49be108253">rs_result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="buf_8h.html#a95629a3e2b79ed7d37b4a03ba0dd3bca">rs_outfilebuf_drain</a> (<a class="el" href="librsync_8h.html#add6622b38e3fa557301a190876d5ed4a">rs_job_t</a> *, <a class="el" href="librsync_8h.html#abf9f543dbfe5c1e60c8ed1c93d087767">rs_buffers_t</a> *, void *fb)</td></tr>
<tr class="separator:a95629a3e2b79ed7d37b4a03ba0dd3bca"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p >Buffers that map between stdio file streams and librsync streams. </p>
<p >As the stream consumes input and produces output, it is refilled from appropriate input and output FILEs. A dynamically allocated buffer of configurable size is used as an intermediary.</p>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000001">Todo:</a></b></dt><dd>Perhaps be more efficient by filling the buffer on every call even if not yet completely empty. Check that it's really our buffer, and shuffle remaining data down to the front.</dd></dl>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000002">Todo:</a></b></dt><dd>Perhaps expose a routine for shuffling the buffers. </dd></dl>
<p class="definition">Definition in file <a class="el" href="buf_8h_source.html">buf.h</a>.</p>
</div><h2 class="groupheader">Typedef Documentation</h2>
<a id="aa63f18e52e4f1ec7c2992586e4d5fc0d" name="aa63f18e52e4f1ec7c2992586e4d5fc0d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa63f18e52e4f1ec7c2992586e4d5fc0d">◆ </a></span>rs_filebuf_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structrs__filebuf.html">rs_filebuf</a> <a class="el" href="structrs__filebuf.html">rs_filebuf_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="buf_8h_source.html#l00040">40</a> of file <a class="el" href="buf_8h_source.html">buf.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a5bebdf459784529e1fbf406329f21688" name="a5bebdf459784529e1fbf406329f21688"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5bebdf459784529e1fbf406329f21688">◆ </a></span>rs_filebuf_new()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structrs__filebuf.html">rs_filebuf_t</a> * rs_filebuf_new </td>
<td>(</td>
<td class="paramtype">FILE * </td>
<td class="paramname"><em>f</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>buf_len</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="buf_8c_source.html#l00043">43</a> of file <a class="el" href="buf_8c_source.html">buf.c</a>.</p>
</div>
</div>
<a id="aded00ad7bc7680c37da5634b03cb57df" name="aded00ad7bc7680c37da5634b03cb57df"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aded00ad7bc7680c37da5634b03cb57df">◆ </a></span>rs_filebuf_free()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void rs_filebuf_free </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structrs__filebuf.html">rs_filebuf_t</a> * </td>
<td class="paramname"><em>fb</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="buf_8c_source.html#l00053">53</a> of file <a class="el" href="buf_8c_source.html">buf.c</a>.</p>
</div>
</div>
<a id="a5353f439325fb75d59031454124c4ce8" name="a5353f439325fb75d59031454124c4ce8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5353f439325fb75d59031454124c4ce8">◆ </a></span>rs_infilebuf_fill()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="librsync_8h.html#a7feb858ceba3b8f3cf048d49be108253">rs_result</a> rs_infilebuf_fill </td>
<td>(</td>
<td class="paramtype"><a class="el" href="librsync_8h.html#add6622b38e3fa557301a190876d5ed4a">rs_job_t</a> * </td>
<td class="paramname"><em>job</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="librsync_8h.html#abf9f543dbfe5c1e60c8ed1c93d087767">rs_buffers_t</a> * </td>
<td class="paramname"><em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>fb</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="buf_8c_source.html#l00063">63</a> of file <a class="el" href="buf_8c_source.html">buf.c</a>.</p>
</div>
</div>
<a id="a95629a3e2b79ed7d37b4a03ba0dd3bca" name="a95629a3e2b79ed7d37b4a03ba0dd3bca"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a95629a3e2b79ed7d37b4a03ba0dd3bca">◆ </a></span>rs_outfilebuf_drain()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="librsync_8h.html#a7feb858ceba3b8f3cf048d49be108253">rs_result</a> rs_outfilebuf_drain </td>
<td>(</td>
<td class="paramtype"><a class="el" href="librsync_8h.html#add6622b38e3fa557301a190876d5ed4a">rs_job_t</a> * </td>
<td class="paramname"><em>job</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="librsync_8h.html#abf9f543dbfe5c1e60c8ed1c93d087767">rs_buffers_t</a> * </td>
<td class="paramname"><em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>fb</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="buf_8c_source.html#l00103">103</a> of file <a class="el" href="buf_8c_source.html">buf.c</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- HTML footer for doxygen 1.8.10-->
<!-- start footer part -->
<!-- ad -->
<script async src="//pagead2.googlesyndication.com/pagead/js/adsbygoogle.js"></script>
<!-- librsync -->
<ins class="adsbygoogle"
style="display:block"
data-ad-client="ca-pub-3547096055927362"
data-ad-slot="8322976738"
data-ad-format="auto"></ins>
<script>
(adsbygoogle = window.adsbygoogle || []).push({});
</script>
<!-- analytics -->
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-71109100-1', 'auto');
ga('send', 'pageview');
</script>
<hr class="footer"/><address class="footer"><small>
Generated on Sun Feb 19 2023 16:26:50 for librsync by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.9.4
</small></address>
</body>
</html>