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         char *pack_lockfile;
  19 };
  20
  21 #define TRANSPORT_PUSH_ALL 1
  22 #define TRANSPORT_PUSH_FORCE 2
  23
  24 struct transport_ops {
  25         /**
  26          * Returns 0 if successful, positive if the option is not
  27          * recognized or is inapplicable, and negative if the option
  28          * is applicable but the value is invalid.
  29          **/
  30         int (*set_option)(struct transport *connection, const char *name,
  31                           const char *value);
  32
  33         struct ref *(*get_refs_list)(const struct transport *transport);
  34         int (*fetch)(struct transport *transport, int refs_nr, struct ref **refs);
  35         int (*push)(struct transport *connection, int refspec_nr, const char **refspec, int flags);
  36
  37         int (*disconnect)(struct transport *connection);
  38 };
  39
  40 /* Returns a transport suitable for the url */
  41 struct transport *transport_get(struct remote *remote, const char *url,
  42                                 int fetch);
  43
  44 /* Transport options which apply to git:// and scp-style URLs */
  45
  46 /* The program to use on the remote side to send a pack */
  47 #define TRANS_OPT_UPLOADPACK "uploadpack"
  48
  49 /* The program to use on the remote side to receive a pack */
  50 #define TRANS_OPT_RECEIVEPACK "receivepack"
  51
  52 /* Transfer the data as a thin pack if not null */
  53 #define TRANS_OPT_THIN "thin"
  54
  55 /* Keep the pack that was transferred if not null */
  56 #define TRANS_OPT_KEEP "keep"
  57
  58 /* Unpack the objects if fewer than this number of objects are fetched */
  59 #define TRANS_OPT_UNPACKLIMIT "unpacklimit"
  60
  61 /* Limit the depth of the fetch if not null */
  62 #define TRANS_OPT_DEPTH "depth"
  63
  64 /**
  65  * Returns 0 if the option was used, non-zero otherwise. Prints a
  66  * message to stderr if the option is not used.
  67  **/
  68 int transport_set_option(struct transport *transport, const char *name,
  69                          const char *value);
  70
  71 int transport_push(struct transport *connection,
  72                    int refspec_nr, const char **refspec, int flags);
  73
  74 struct ref *transport_get_remote_refs(struct transport *transport);
  75
  76 int transport_fetch_refs(struct transport *transport, struct ref *refs);
  77 void transport_unlock_pack(struct transport *transport);
  78 int transport_disconnect(struct transport *transport);
  79
  80 #endif