transport-internal.h

   1 #ifndef TRANSPORT_INTERNAL_H
   2 #define TRANSPORT_INTERNAL_H
   3
   4 struct ref;
   5 struct transport;
   6 struct argv_array;
   7
   8 struct transport_vtable {
   9         /**
  10          * Returns 0 if successful, positive if the option is not
  11          * recognized or is inapplicable, and negative if the option
  12          * is applicable but the value is invalid.
  13          **/
  14         int (*set_option)(struct transport *connection, const char *name,
  15                           const char *value);
  16         /**
  17          * Returns a list of the remote side's refs. In order to allow
  18          * the transport to try to share connections, for_push is a
  19          * hint as to whether the ultimate operation is a push or a fetch.
  20          *
  21          * If communicating using protocol v2 a list of prefixes can be
  22          * provided to be sent to the server to enable it to limit the ref
  23          * advertisement.  Since ref filtering is done on the server's end, and
  24          * only when using protocol v2, this list will be ignored when not
  25          * using protocol v2 meaning this function can return refs which don't
  26          * match the provided ref_prefixes.
  27          *
  28          * If the transport is able to determine the remote hash for
  29          * the ref without a huge amount of effort, it should store it
  30          * in the ref's old_sha1 field; otherwise it should be all 0.
  31          **/
  32         struct ref *(*get_refs_list)(struct transport *transport, int for_push,
  33                                      const struct argv_array *ref_prefixes);
  34
  35         /**
  36          * Fetch the objects for the given refs. Note that this gets
  37          * an array, and should ignore the list structure.
  38          *
  39          * The transport *may* provide, in fetched_refs, the list of refs that
  40          * it fetched.  If the transport knows anything about the fetched refs
  41          * that the caller does not know (for example, shallow status), it
  42          * should provide that list of refs and include that information in the
  43          * list.
  44          *
  45          * If the transport did not get hashes for refs in
  46          * get_refs_list(), it should set the old_sha1 fields in the
  47          * provided refs now.
  48          **/
  49         int (*fetch)(struct transport *transport, int refs_nr, struct ref **refs,
  50                      struct ref **fetched_refs);
  51
  52         /**
  53          * Push the objects and refs. Send the necessary objects, and
  54          * then, for any refs where peer_ref is set and
  55          * peer_ref->new_oid is different from old_oid, tell the
  56          * remote side to update each ref in the list from old_oid to
  57          * peer_ref->new_oid.
  58          *
  59          * Where possible, set the status for each ref appropriately.
  60          *
  61          * The transport must modify new_sha1 in the ref to the new
  62          * value if the remote accepted the change. Note that this
  63          * could be a different value from peer_ref->new_oid if the
  64          * process involved generating new commits.
  65          **/
  66         int (*push_refs)(struct transport *transport, struct ref *refs, int flags);
  67         int (*connect)(struct transport *connection, const char *name,
  68                        const char *executable, int fd[2]);
  69
  70         /** get_refs_list(), fetch(), and push_refs() can keep
  71          * resources (such as a connection) reserved for further
  72          * use. disconnect() releases these resources.
  73          **/
  74         int (*disconnect)(struct transport *connection);
  75 };
  76
  77 #endif