diff options
author | Jameson Miller <jamill@microsoft.com> | 2013-09-19 14:52:57 -0400 |
---|---|---|
committer | Jameson Miller <jamill@microsoft.com> | 2013-09-30 13:22:28 -0400 |
commit | b176ededb7d226ac85809b3ec594d185e7e3e866 (patch) | |
tree | f0ee8577697aa284cc98ab6ff6ad05b485c87c69 /include/git2/pack.h | |
parent | 5b09db15d1041032c446f6141a9b41265fb253bc (diff) | |
download | libgit2-b176ededb7d226ac85809b3ec594d185e7e3e866.tar.gz |
Initial Implementation of progress reports during push
This adds the basics of progress reporting during push. While progress
for all aspects of a push operation are not reported with this change,
it lays the foundation to add these later. Push progress reporting
can be improved in the future - and consumers of the API should
just get more accurate information at that point.
The main areas where this is lacking are:
1) packbuilding progress: does not report progress during deltafication,
as this involves coordinating progress from multiple threads.
2) network progress: reports progress as objects and bytes are going
to be written to the subtransport (instead of as client gets
confirmation that they have been received by the server) and leaves
out some of the bytes that are transfered as part of the push protocol.
Basically, this reports the pack bytes that are written to the
subtransport. It does not report the bytes sent on the wire that
are received by the server. This should be a good estimate of
progress (and an improvement over no progress).
Diffstat (limited to 'include/git2/pack.h')
-rw-r--r-- | include/git2/pack.h | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/include/git2/pack.h b/include/git2/pack.h index 976e39cb4..7ebdd5cf3 100644 --- a/include/git2/pack.h +++ b/include/git2/pack.h @@ -46,6 +46,14 @@ GIT_BEGIN_DECL /** + * Stages that are reported by the packbuilder progress callback. + */ +typedef enum { + GIT_PACKBUILDER_ADDING_OBJECTS = 0, + GIT_PACKBUILDER_DELTAFICATION = 1, +} git_packbuilder_stage_t; + +/** * Initialize a new packbuilder * * @param out The new packbuilder object @@ -149,6 +157,28 @@ GIT_EXTERN(uint32_t) git_packbuilder_object_count(git_packbuilder *pb); */ GIT_EXTERN(uint32_t) git_packbuilder_written(git_packbuilder *pb); +/** Packbuilder progress notification function */ +typedef void (*git_packbuilder_progress)( + int stage, + unsigned int current, + unsigned int total, + void *payload); + +/** + * Set the callbacks for a packbuilder + * + * @param pb The packbuilder object + * @param progress_cb Function to call with progress information during + * pack building. Be aware that this is called inline with pack building + * operations, so performance may be affected. + * @param progress_cb_payload Payload for progress callback. + * @return 0 or an error code + */ +GIT_EXTERN(int) git_packbuilder_set_callbacks( + git_packbuilder *pb, + git_packbuilder_progress progress_cb, + void *progress_cb_payload); + /** * Free the packbuilder and all associated data * |