Add support for external programs for handling native fetches
[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, int for_push);
22 int (*fetch)(struct transport *transport, int refs_nr, const struct ref **refs);
23 int (*push_refs)(struct transport *transport, struct ref *refs, int flags);
24 int (*push)(struct transport *connection, int refspec_nr, const char **refspec, int flags);
25
26 int (*disconnect)(struct transport *connection);
27 char *pack_lockfile;
28 signed verbose : 2;
29 /* Force progress even if the output is not a tty */
30 unsigned progress : 1;
31 };
32
33 #define TRANSPORT_PUSH_ALL 1
34 #define TRANSPORT_PUSH_FORCE 2
35 #define TRANSPORT_PUSH_DRY_RUN 4
36 #define TRANSPORT_PUSH_MIRROR 8
37 #define TRANSPORT_PUSH_VERBOSE 16
38 #define TRANSPORT_PUSH_PORCELAIN 32
39
40 /* Returns a transport suitable for the url */
41 struct transport *transport_get(struct remote *, const char *);
42
43 /* Transport options which apply to git:// and scp-style URLs */
44
45 /* The program to use on the remote side to send a pack */
46 #define TRANS_OPT_UPLOADPACK "uploadpack"
47
48 /* The program to use on the remote side to receive a pack */
49 #define TRANS_OPT_RECEIVEPACK "receivepack"
50
51 /* Transfer the data as a thin pack if not null */
52 #define TRANS_OPT_THIN "thin"
53
54 /* Keep the pack that was transferred if not null */
55 #define TRANS_OPT_KEEP "keep"
56
57 /* Limit the depth of the fetch if not null */
58 #define TRANS_OPT_DEPTH "depth"
59
60 /* Aggressively fetch annotated tags if possible */
61 #define TRANS_OPT_FOLLOWTAGS "followtags"
62
63 /**
64 * Returns 0 if the option was used, non-zero otherwise. Prints a
65 * message to stderr if the option is not used.
66 **/
67 int transport_set_option(struct transport *transport, const char *name,
68 const char *value);
69
70 int transport_push(struct transport *connection,
71 int refspec_nr, const char **refspec, int flags);
72
73 const struct ref *transport_get_remote_refs(struct transport *transport);
74
75 int transport_fetch_refs(struct transport *transport, const struct ref *refs);
76 void transport_unlock_pack(struct transport *transport);
77 int transport_disconnect(struct transport *transport);
78 char *transport_anonymize_url(const char *url);
79
80 /* Transport methods defined outside transport.c */
81 int transport_helper_init(struct transport *transport);
82
83 #endif