Merge branch 'aw/mirror-push' into jk/send-pack
[git/git.git] / transport.h
1 #ifndef TRANSPORT_H
2 #define TRANSPORT_H
3
4 #include "cache.h"
5 #include "remote.h"
6
7 struct transport {
8 struct remote *remote;
9 const char *url;
10 void *data;
11 const struct ref *remote_refs;
12
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
21 struct ref *(*get_refs_list)(struct transport *transport);
22 int (*fetch)(struct transport *transport, int refs_nr, struct ref **refs);
23 int (*push)(struct transport *connection, int refspec_nr, const char **refspec, int flags);
24
25 int (*disconnect)(struct transport *connection);
26 char *pack_lockfile;
27 signed verbose : 2;
28 };
29
30 #define TRANSPORT_PUSH_ALL 1
31 #define TRANSPORT_PUSH_FORCE 2
32 #define TRANSPORT_PUSH_DRY_RUN 4
33 #define TRANSPORT_PUSH_MIRROR 8
34 #define TRANSPORT_PUSH_VERBOSE 16
35
36 /* Returns a transport suitable for the url */
37 struct transport *transport_get(struct remote *, const char *);
38
39 /* Transport options which apply to git:// and scp-style URLs */
40
41 /* The program to use on the remote side to send a pack */
42 #define TRANS_OPT_UPLOADPACK "uploadpack"
43
44 /* The program to use on the remote side to receive a pack */
45 #define TRANS_OPT_RECEIVEPACK "receivepack"
46
47 /* Transfer the data as a thin pack if not null */
48 #define TRANS_OPT_THIN "thin"
49
50 /* Keep the pack that was transferred if not null */
51 #define TRANS_OPT_KEEP "keep"
52
53 /* Limit the depth of the fetch if not null */
54 #define TRANS_OPT_DEPTH "depth"
55
56 /**
57 * Returns 0 if the option was used, non-zero otherwise. Prints a
58 * message to stderr if the option is not used.
59 **/
60 int transport_set_option(struct transport *transport, const char *name,
61 const char *value);
62
63 int transport_push(struct transport *connection,
64 int refspec_nr, const char **refspec, int flags);
65
66 const struct ref *transport_get_remote_refs(struct transport *transport);
67
68 int transport_fetch_refs(struct transport *transport, struct ref *refs);
69 void transport_unlock_pack(struct transport *transport);
70 int transport_disconnect(struct transport *transport);
71
72 #endif