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