librsync.github.io/job_8h.html at master · librsync/librsync.github.io · GitHub

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
<!-- 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: job.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
   &#160;<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&amp;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="#nested-classes">Data Structures</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle"><div class="title">job.h File Reference</div></div>
</div><!--header-->
<div class="contents">

<p>Generic state-machine interface.
<a href="#details">More...</a></p>
<div class="textblock"><div class="dynheader">
Include dependency graph for job.h:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="job_8h__incl.svg" width="854" height="262"><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="job_8h__dep__incl.svg" width="766" 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>
<p><a href="job_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="nested-classes" name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structrs__job.html">rs_job</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">The contents of this structure are private.  <a href="structrs__job.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a4d281d644a0a999beb08c2353fd84279"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="job_8h.html#a4d281d644a0a999beb08c2353fd84279">RS_JOB_TAG</a>&#160;&#160;&#160;20010225</td></tr>
<tr class="memdesc:a4d281d644a0a999beb08c2353fd84279"><td class="mdescLeft">&#160;</td><td class="mdescRight">Magic job tag number for checking jobs have been initialized.  <a href="job_8h.html#a4d281d644a0a999beb08c2353fd84279">More...</a><br /></td></tr>
<tr class="separator:a4d281d644a0a999beb08c2353fd84279"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abdbdf5fbcdaed953e687867db175e4c5"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="job_8h.html#abdbdf5fbcdaed953e687867db175e4c5">MAX_DELTA_CMD</a>&#160;&#160;&#160;(1&lt;&lt;16)</td></tr>
<tr class="memdesc:abdbdf5fbcdaed953e687867db175e4c5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Max length of a singled delta command is including command bytes.  <a href="job_8h.html#abdbdf5fbcdaed953e687867db175e4c5">More...</a><br /></td></tr>
<tr class="separator:abdbdf5fbcdaed953e687867db175e4c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab715a4b7294c5fe2ae74765477a521dd"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="job_8h.html#ab715a4b7294c5fe2ae74765477a521dd">rs_job_check</a>(job)</td></tr>
<tr class="memdesc:ab715a4b7294c5fe2ae74765477a521dd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Assert that a job is valid.  <a href="job_8h.html#ab715a4b7294c5fe2ae74765477a521dd">More...</a><br /></td></tr>
<tr class="separator:ab715a4b7294c5fe2ae74765477a521dd"><td class="memSeparator" colspan="2">&#160;</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:ad6121365900dae19a3747de04415616d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="librsync_8h.html#add6622b38e3fa557301a190876d5ed4a">rs_job_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="job_8h.html#ad6121365900dae19a3747de04415616d">rs_job_new</a> (const char *, <a class="el" href="librsync_8h.html#a7feb858ceba3b8f3cf048d49be108253">rs_result</a>(*statefn)(<a class="el" href="librsync_8h.html#add6622b38e3fa557301a190876d5ed4a">rs_job_t</a> *))</td></tr>
<tr class="separator:ad6121365900dae19a3747de04415616d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p >Generic state-machine interface. </p>
<p >The point of this is that we need to be able to suspend and resume processing at any point at which the buffers may block.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="api_streaming.html">Streaming API</a> </dd>
<dd>
<a class="el" href="librsync_8h.html#aede8e0f42424b9aa29093f94b59ea029" title="Run a rs_job state machine until it blocks (RS_BLOCKED), returns an error, or completes (RS_DONE).">rs_job_iter()</a> </dd>
<dd>
<a class="el" href="structrs__job.html" title="The contents of this structure are private.">rs_job</a> </dd></dl>

<p class="definition">Definition in file <a class="el" href="job_8h_source.html">job.h</a>.</p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a4d281d644a0a999beb08c2353fd84279" name="a4d281d644a0a999beb08c2353fd84279"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4d281d644a0a999beb08c2353fd84279">&#9670;&nbsp;</a></span>RS_JOB_TAG</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define RS_JOB_TAG&#160;&#160;&#160;20010225</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Magic job tag number for checking jobs have been initialized. </p>

<p class="definition">Definition at line <a class="el" href="job_8h_source.html#l00039">39</a> of file <a class="el" href="job_8h_source.html">job.h</a>.</p>

</div>
</div>
<a id="abdbdf5fbcdaed953e687867db175e4c5" name="abdbdf5fbcdaed953e687867db175e4c5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abdbdf5fbcdaed953e687867db175e4c5">&#9670;&nbsp;</a></span>MAX_DELTA_CMD</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define MAX_DELTA_CMD&#160;&#160;&#160;(1&lt;&lt;16)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Max length of a singled delta command is including command bytes. </p>
<p >This is used to constrain and set the internal buffer sizes. </p>

<p class="definition">Definition at line <a class="el" href="job_8h_source.html#l00044">44</a> of file <a class="el" href="job_8h_source.html">job.h</a>.</p>

</div>
</div>
<a id="ab715a4b7294c5fe2ae74765477a521dd" name="ab715a4b7294c5fe2ae74765477a521dd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab715a4b7294c5fe2ae74765477a521dd">&#9670;&nbsp;</a></span>rs_job_check</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define rs_job_check</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">job</td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line">    <span class="keywordflow">do</span> {\</div>
<div class="line">    assert(job-&gt;dogtag == <a class="code hl_define" href="job_8h.html#a4d281d644a0a999beb08c2353fd84279">RS_JOB_TAG</a>);\</div>
<div class="line">} <span class="keywordflow">while</span> (0)</div>
<div class="ttc" id="ajob_8h_html_a4d281d644a0a999beb08c2353fd84279"><div class="ttname"><a href="job_8h.html#a4d281d644a0a999beb08c2353fd84279">RS_JOB_TAG</a></div><div class="ttdeci">#define RS_JOB_TAG</div><div class="ttdoc">Magic job tag number for checking jobs have been initialized.</div><div class="ttdef"><b>Definition:</b> <a href="job_8h_source.html#l00039">job.h:39</a></div></div>
</div><!-- fragment -->
<p>Assert that a job is valid. </p>
<p >We don't use a static inline function here so that assert failure output points at where <a class="el" href="job_8h.html#ab715a4b7294c5fe2ae74765477a521dd" title="Assert that a job is valid.">rs_job_check()</a> was called from. </p>

<p class="definition">Definition at line <a class="el" href="job_8h_source.html#l00130">130</a> of file <a class="el" href="job_8h_source.html">job.h</a>.</p>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ad6121365900dae19a3747de04415616d" name="ad6121365900dae19a3747de04415616d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad6121365900dae19a3747de04415616d">&#9670;&nbsp;</a></span>rs_job_new()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="librsync_8h.html#add6622b38e3fa557301a190876d5ed4a">rs_job_t</a> * rs_job_new </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>job_name</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="librsync_8h.html#a7feb858ceba3b8f3cf048d49be108253">rs_result</a>(*)(<a class="el" href="librsync_8h.html#add6622b38e3fa557301a190876d5ed4a">rs_job_t</a> *)&#160;</td>
          <td class="paramname"><em>statefn</em>&#160;</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="job_8c_source.html#l00040">40</a> of file <a class="el" href="job_8c_source.html">job.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 &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.9.4
</small></address>
</body>
</html>