blob: 6fb4526cda5fc1ee1178fdf1d0840c90b88aa26c [file] [log] [blame]
Daniel Barkalow9b288512007-09-10 23:03:04 -04001#ifndef TRANSPORT_H
2#define TRANSPORT_H
3
4#include "cache.h"
5#include "remote.h"
6
7struct transport {
Daniel Barkalow9b288512007-09-10 23:03:04 -04008 struct remote *remote;
9 const char *url;
Daniel Barkalow9b288512007-09-10 23:03:04 -040010 void *data;
Daniel Barkalow45773702007-10-29 21:05:40 -040011 const struct ref *remote_refs;
Daniel Barkalow9b288512007-09-10 23:03:04 -040012
Daniel Barkalow9b288512007-09-10 23:03:04 -040013 /**
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
Daniel Barkalow45773702007-10-29 21:05:40 -040021 struct ref *(*get_refs_list)(struct transport *transport);
Shawn O. Pearce1788c392007-09-14 03:31:23 -040022 int (*fetch)(struct transport *transport, int refs_nr, struct ref **refs);
Daniel Barkalow9b288512007-09-10 23:03:04 -040023 int (*push)(struct transport *connection, int refspec_nr, const char **refspec, int flags);
24
25 int (*disconnect)(struct transport *connection);
Shawn O. Pearce824d5772007-09-19 00:49:31 -040026 char *pack_lockfile;
Daniel Barkalow2b5a06e2007-10-02 22:49:15 -040027 signed verbose : 2;
Daniel Barkalow9b288512007-09-10 23:03:04 -040028};
29
Shawn O. Pearce824d5772007-09-19 00:49:31 -040030#define TRANSPORT_PUSH_ALL 1
31#define TRANSPORT_PUSH_FORCE 2
Shawn O. Pearce2e13e5d2007-10-16 00:15:25 -040032#define TRANSPORT_PUSH_DRY_RUN 4
Andy Whitcroft94c89ba2007-11-09 23:32:25 +000033#define TRANSPORT_PUSH_MIRROR 8
Junio C Hamanobcd2e262007-11-14 03:13:30 -080034#define TRANSPORT_PUSH_VERBOSE 16
Shawn O. Pearce824d5772007-09-19 00:49:31 -040035
Daniel Barkalow9b288512007-09-10 23:03:04 -040036/* Returns a transport suitable for the url */
Shawn O. Pearcee5f4e212007-09-15 03:23:14 -040037struct transport *transport_get(struct remote *, const char *);
Daniel Barkalow9b288512007-09-10 23:03:04 -040038
39/* Transport options which apply to git:// and scp-style URLs */
40
Daniel Barkalowc29727d2007-09-10 23:03:11 -040041/* The program to use on the remote side to send a pack */
42#define TRANS_OPT_UPLOADPACK "uploadpack"
43
Daniel Barkalow9b288512007-09-10 23:03:04 -040044/* 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
Daniel Barkalowc29727d2007-09-10 23:03:11 -040050/* Keep the pack that was transferred if not null */
51#define TRANS_OPT_KEEP "keep"
52
Daniel Barkalowc29727d2007-09-10 23:03:11 -040053/* Limit the depth of the fetch if not null */
54#define TRANS_OPT_DEPTH "depth"
55
Daniel Barkalow9b288512007-09-10 23:03:04 -040056/**
57 * Returns 0 if the option was used, non-zero otherwise. Prints a
58 * message to stderr if the option is not used.
59 **/
60int transport_set_option(struct transport *transport, const char *name,
61 const char *value);
62
63int transport_push(struct transport *connection,
64 int refspec_nr, const char **refspec, int flags);
65
Daniel Barkalow45773702007-10-29 21:05:40 -040066const struct ref *transport_get_remote_refs(struct transport *transport);
Daniel Barkalowc29727d2007-09-10 23:03:11 -040067
68int transport_fetch_refs(struct transport *transport, struct ref *refs);
Shawn O. Pearce1788c392007-09-14 03:31:23 -040069void transport_unlock_pack(struct transport *transport);
Daniel Barkalow9b288512007-09-10 23:03:04 -040070int transport_disconnect(struct transport *transport);
71
72#endif