Teach send-pack a mirror mode
[git/git.git] / transport.h
CommitLineData
9b288516
DB
1#ifndef TRANSPORT_H
2#define TRANSPORT_H
3
4#include "cache.h"
5#include "remote.h"
6
7struct transport {
9b288516
DB
8 struct remote *remote;
9 const char *url;
9b288516 10 void *data;
4577370e 11 const struct ref *remote_refs;
9b288516 12
9b288516
DB
13 /**
14 * Returns 0 if successful, positive if the option is not
15 * recognized or is inapplicable, and negative if the option
16 * is applicable but the value is invalid.
17 **/
18 int (*set_option)(struct transport *connection, const char *name,
19 const char *value);
20
4577370e 21 struct ref *(*get_refs_list)(struct transport *transport);
1788c39c 22 int (*fetch)(struct transport *transport, int refs_nr, struct ref **refs);
9b288516
DB
23 int (*push)(struct transport *connection, int refspec_nr, const char **refspec, int flags);
24
25 int (*disconnect)(struct transport *connection);
824d5776 26 char *pack_lockfile;
2b5a06ed 27 signed verbose : 2;
9b288516
DB
28};
29
824d5776
SP
30#define TRANSPORT_PUSH_ALL 1
31#define TRANSPORT_PUSH_FORCE 2
2e13e5d8 32#define TRANSPORT_PUSH_DRY_RUN 4
824d5776 33
9b288516 34/* Returns a transport suitable for the url */
e5f4e214 35struct transport *transport_get(struct remote *, const char *);
9b288516
DB
36
37/* Transport options which apply to git:// and scp-style URLs */
38
c29727d5
DB
39/* The program to use on the remote side to send a pack */
40#define TRANS_OPT_UPLOADPACK "uploadpack"
41
9b288516
DB
42/* The program to use on the remote side to receive a pack */
43#define TRANS_OPT_RECEIVEPACK "receivepack"
44
45/* Transfer the data as a thin pack if not null */
46#define TRANS_OPT_THIN "thin"
47
c29727d5
DB
48/* Keep the pack that was transferred if not null */
49#define TRANS_OPT_KEEP "keep"
50
c29727d5
DB
51/* Limit the depth of the fetch if not null */
52#define TRANS_OPT_DEPTH "depth"
53
9b288516
DB
54/**
55 * Returns 0 if the option was used, non-zero otherwise. Prints a
56 * message to stderr if the option is not used.
57 **/
58int transport_set_option(struct transport *transport, const char *name,
59 const char *value);
60
61int transport_push(struct transport *connection,
62 int refspec_nr, const char **refspec, int flags);
63
4577370e 64const struct ref *transport_get_remote_refs(struct transport *transport);
c29727d5
DB
65
66int transport_fetch_refs(struct transport *transport, struct ref *refs);
1788c39c 67void transport_unlock_pack(struct transport *transport);
9b288516
DB
68int transport_disconnect(struct transport *transport);
69
70#endif