Simplify fetch transport API to just one function
[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 unsigned verbose : 1;
9 unsigned fetch : 1;
10 struct remote *remote;
11 const char *url;
12
13 void *data;
14
15 struct ref *remote_refs;
16
17 const struct transport_ops *ops;
18 };
19
20 #define TRANSPORT_PUSH_ALL 1
21 #define TRANSPORT_PUSH_FORCE 2
22
23 struct transport_ops {
24 /**
25 * Returns 0 if successful, positive if the option is not
26 * recognized or is inapplicable, and negative if the option
27 * is applicable but the value is invalid.
28 **/
29 int (*set_option)(struct transport *connection, const char *name,
30 const char *value);
31
32 struct ref *(*get_refs_list)(const struct transport *transport);
33 int (*fetch)(const struct transport *transport, int refs_nr, struct ref **refs);
34 int (*push)(struct transport *connection, int refspec_nr, const char **refspec, int flags);
35
36 int (*disconnect)(struct transport *connection);
37 };
38
39 /* Returns a transport suitable for the url */
40 struct transport *transport_get(struct remote *remote, const char *url,
41 int fetch);
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 /* Unpack the objects if fewer than this number of objects are fetched */
58 #define TRANS_OPT_UNPACKLIMIT "unpacklimit"
59
60 /* Limit the depth of the fetch if not null */
61 #define TRANS_OPT_DEPTH "depth"
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 struct ref *transport_get_remote_refs(struct transport *transport);
74
75 int transport_fetch_refs(struct transport *transport, struct ref *refs);
76
77 int transport_disconnect(struct transport *transport);
78
79 #endif