[thirdparty/git.git] / connected.h

#ifndef CONNECTED_H
#define CONNECTED_H

struct object_id;
struct transport;

/*
 * Take callback data, and return next object name in the buffer.
 * When called after returning the name for the last object, return -1
 * to signal EOF, otherwise return 0.
 */
typedef int (*oid_iterate_fn)(void *, struct object_id *oid);

/*
 * Named-arguments struct for check_connected. All arguments are
 * optional, and can be left to defaults as set by CHECK_CONNECTED_INIT.
 */
struct check_connected_options {
	/* Avoid printing any errors to stderr. */
	int quiet;

	/* --shallow-file to pass to rev-list sub-process */
	const char *shallow_file;

	/* Transport whose objects we are checking, if available. */
	struct transport *transport;

	/*
	 * If non-zero, send error messages to this descriptor rather
	 * than stderr. The descriptor is closed before check_connected
	 * returns.
	 */
	int err_fd;

	/* If non-zero, show progress as we traverse the objects. */
	int progress;

	/*
	 * Insert these variables into the environment of the child process.
	 */
	const char **env;

	/*
	 * If non-zero, check the ancestry chain completely, not stopping at
	 * any existing ref. This is necessary when deepening existing refs
	 * during a fetch.
	 */
	unsigned is_deepening_fetch : 1;
};

#define CHECK_CONNECTED_INIT { 0 }

/*
 * Make sure that all given objects and all objects reachable from them
 * either exist in our object store or (if the repository is a partial
 * clone) are promised to be available.
 *
 * Return 0 if Ok, non zero otherwise (i.e. some missing objects)
 *
 * If "opt" is NULL, behaves as if CHECK_CONNECTED_INIT was passed.
 */
int check_connected(oid_iterate_fn fn, void *cb_data,
		    struct check_connected_options *opt);

#endif /* CONNECTED_H */
Commit	Line	Data
f96400cb JH	1	#ifndef CONNECTED_H
	2	#define CONNECTED_H
	3
ef3ca954	4	struct object_id;
c6807a40 NTND	5	struct transport;
c6807a40 NTND	6
f96400cb JH	7	/*
	8	* Take callback data, and return next object name in the buffer.
	9	* When called after returning the name for the last object, return -1
	10	* to signal EOF, otherwise return 0.
	11	*/
6ccac9ee	12	typedef int (oid_iterate_fn)(void , struct object_id *oid);
f96400cb	13
7043c707 JK	14	/*
	15	* Named-arguments struct for check_connected. All arguments are
	16	* optional, and can be left to defaults as set by CHECK_CONNECTED_INIT.
	17	*/
	18	struct check_connected_options {
	19	/* Avoid printing any errors to stderr. */
	20	int quiet;
	21
	22	/* --shallow-file to pass to rev-list sub-process */
	23	const char *shallow_file;
	24
	25	/* Transport whose objects we are checking, if available. */
	26	struct transport *transport;
e0331849 JK	27
	28	/*
	29	* If non-zero, send error messages to this descriptor rather
	30	* than stderr. The descriptor is closed before check_connected
	31	* returns.
	32	*/
	33	int err_fd;
70d5e2d7 JK	34
	35	/* If non-zero, show progress as we traverse the objects. */
	36	int progress;
526f108a JK	37
	38	/*
	39	* Insert these variables into the environment of the child process.
	40	*/
	41	const char **env;
cf1e7c07 JT	42
	43	/*
	44	* If non-zero, check the ancestry chain completely, not stopping at
	45	* any existing ref. This is necessary when deepening existing refs
	46	* during a fetch.
	47	*/
	48	unsigned is_deepening_fetch : 1;
7043c707 JK	49	};
	50
	51	#define CHECK_CONNECTED_INIT { 0 }
	52
f96400cb	53	/*
4937291b JT	54	* Make sure that all given objects and all objects reachable from them
	55	* either exist in our object store or (if the repository is a partial
	56	* clone) are promised to be available.
f96400cb JH	57	*
f96400cb JH	58	* Return 0 if Ok, non zero otherwise (i.e. some missing objects)
7043c707 JK	59	*
7043c707 JK	60	* If "opt" is NULL, behaves as if CHECK_CONNECTED_INIT was passed.
f96400cb	61	*/
6ccac9ee	62	int check_connected(oid_iterate_fn fn, void *cb_data,
7043c707	63	struct check_connected_options *opt);
f96400cb JH	64
f96400cb JH	65	#endif /* CONNECTED_H */