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
  39 /* Returns a transport suitable for the url */
  40 struct transport *transport_get(struct remote *, const char *);
  41
  42 /* Transport options which apply to git:// and scp-style URLs */
  43
  44 /* The program to use on the remote side to send a pack */
  45 #define TRANS_OPT_UPLOADPACK "uploadpack"
  46
  47 /* The program to use on the remote side to receive a pack */
  48 #define TRANS_OPT_RECEIVEPACK "receivepack"
  49
  50 /* Transfer the data as a thin pack if not null */
  51 #define TRANS_OPT_THIN "thin"
  52
  53 /* Keep the pack that was transferred if not null */
  54 #define TRANS_OPT_KEEP "keep"
  55
  56 /* Limit the depth of the fetch if not null */
  57 #define TRANS_OPT_DEPTH "depth"
  58
  59 /* Aggressively fetch annotated tags if possible */
  60 #define TRANS_OPT_FOLLOWTAGS "followtags"
  61
  62 /**
  63  * Returns 0 if the option was used, non-zero otherwise. Prints a
  64  * message to stderr if the option is not used.
  65  **/
  66 int transport_set_option(struct transport *transport, const char *name,
  67                          const char *value);
  68
  69 int transport_push(struct transport *connection,
  70                    int refspec_nr, const char **refspec, int flags);
  71
  72 const struct ref *transport_get_remote_refs(struct transport *transport);
  73
  74 int transport_fetch_refs(struct transport *transport, const struct ref *refs);
  75 void transport_unlock_pack(struct transport *transport);
  76 int transport_disconnect(struct transport *transport);
  77 char *transport_anonymize_url(const char *url);
  78
  79 #endif