librsync
2.3.4
src
whole.h
Go to the documentation of this file.
1
/*= -*- c-basic-offset: 4; indent-tabs-mode: nil; -*-
2
*
3
* librsync -- the library for network deltas
4
*
5
* Copyright (C) 2001 by Martin Pool <mbp@sourcefrog.net>
6
*
7
* This program is free software; you can redistribute it and/or
8
* modify it under the terms of the GNU Lesser General Public License
9
* as published by the Free Software Foundation; either version 2.1 of
10
* the License, or (at your option) any later version.
11
*
12
* This program is distributed in the hope that it will be useful, but
13
* WITHOUT ANY WARRANTY; without even the implied warranty of
14
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15
* Lesser General Public License for more details.
16
*
17
* You should have received a copy of the GNU Lesser General Public
18
* License along with this program; if not, write to the Free Software
19
* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20
*/
21
22
/** \file whole.h
23
* Whole-file API driver functions. */
24
#ifndef WHOLE_H
25
# define WHOLE_H
26
27
# include <stdio.h>
28
# include "
librsync.h
"
29
30
/** Run a job continuously, with input to/from the two specified files.
31
*
32
* The job should already be set up, and must be freed by the caller after
33
* return. If rs_inbuflen or rs_outbuflen are set, they will override the
34
* inbuflen and outbuflen arguments.
35
*
36
* \param job - the job instance to run.
37
*
38
* \param in_file - input file, or NULL if there is no input.
39
*
40
* \param out_file - output file, or NULL if there is no output.
41
*
42
* \param inbuflen - recommended input buffer size to use.
43
*
44
* \param outbuflen - recommended output buffer size to use.
45
*
46
* \return RS_DONE if the job completed, or otherwise an error result. */
47
rs_result
rs_whole_run
(
rs_job_t
*job, FILE *in_file, FILE *out_file,
48
int
inbuflen,
int
outbuflen);
49
50
#endif
/* !WHOLE_H */
librsync.h
Public header for librsync.
rs_result
rs_result
Return codes from nonblocking rsync operations.
Definition
librsync.h:180
rs_job_t
struct rs_job rs_job_t
Job of work to be done.
Definition
librsync.h:384
rs_whole_run
rs_result rs_whole_run(rs_job_t *job, FILE *in_file, FILE *out_file, int inbuflen, int outbuflen)
Run a job continuously, with input to/from the two specified files.
Definition
whole.c:43
Generated on Fri Jan 17 2025 00:00:00 for librsync by
1.13.2