Code

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