df12ea74243cab68cc13eecf61106bba8ace1be4
[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 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)(const 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
34 /* Returns a transport suitable for the url */
35 struct transport *transport_get(struct remote *, const char *);
36
37 /* Transport options which apply to git:// and scp-style URLs */
38
39 /* The program to use on the remote side to send a pack */
40 #define TRANS_OPT_UPLOADPACK "uploadpack"
41
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
48 /* Keep the pack that was transferred if not null */
49 #define TRANS_OPT_KEEP "keep"
50
51 /* Limit the depth of the fetch if not null */
52 #define TRANS_OPT_DEPTH "depth"
53
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 **/
58 int transport_set_option(struct transport *transport, const char *name,
59 const char *value);
60
61 int transport_push(struct transport *connection,
62 int refspec_nr, const char **refspec, int flags);
63
64 struct ref *transport_get_remote_refs(struct transport *transport);
65
66 int transport_fetch_refs(struct transport *transport, struct ref *refs);
67 void transport_unlock_pack(struct transport *transport);
68 int transport_disconnect(struct transport *transport);
69
70 #endif