SlGit::FetchCallbacks Class Reference

Callbacks invoked from Repo::clone() or Remote::fetchRefspecs(). More...

#include <FetchCallbacks.h>

Inheritance diagram for SlGit::FetchCallbacks:

Public Member Functions
	FetchCallbacks ()
	Construct FetchCallbacks.
virtual void	checkoutProgress (std::string_view path, size_t completedSteps, size_t totalSteps)
	Called for each path in the tree.
virtual int	credentials (git_credential **cred, std::string_view url, std::optional< std::string_view > usernameFromUrl, unsigned int allowedTypes)
	Fill in credentials.
virtual int	packProgress (int stage, uint32_t current, uint32_t total)
	Called many times when packing objects.
virtual int	sidebandProgress (std::string_view str)
	Callback for messages received by the transport.
virtual int	transferProgress (const git_indexer_progress &stats)
	Called many times during download and indexing.
virtual int	updateRefs (std::string_view refname, const git_oid &a, const git_oid &b, git_refspec &ref)
	Called for each updated reference.

Detailed Description

Callbacks invoked from Repo::clone() or Remote::fetchRefspecs().

See also DefaultFetchCallbacks for the default implementation.

Member Function Documentation

checkoutProgress()

virtual void SlGit::FetchCallbacks::checkoutProgress ( std::string_view path, size_t completedSteps, size_t totalSteps )

inlinevirtual

Called for each path in the tree.

Parameters

path	Path being checked out
completedSteps	Count of steps done
totalSteps	Count of all steps

Reimplemented in SlGit::DefaultFetchCallbacks.

credentials()

virtual int SlGit::FetchCallbacks::credentials ( git_credential ** cred, std::string_view url, std::optional< std::string_view > usernameFromUrl, unsigned int allowedTypes )

inlinevirtual

Fill in credentials.

Parameters

cred	Output
url	For which URL
usernameFromUrl	Username detected in url
allowedTypes	GIT_CREDENTIAL_USERNAME, GIT_CREDENTIAL_SSH_KEY, ...

Returns

Zero for success.

Reimplemented in SlGit::DefaultFetchCallbacks.

packProgress()

virtual int SlGit::FetchCallbacks::packProgress ( int stage, uint32_t current, uint32_t total )

inlinevirtual

Called many times when packing objects.

Parameters

stage	At what stage the packing is (GIT_PACKBUILDER_ADDING_OBJECTS, ...)
current	Currently packed object
total	Total number of objects

Returns

Zero for success.

Reimplemented in SlGit::DefaultFetchCallbacks.

sidebandProgress()

virtual int SlGit::FetchCallbacks::sidebandProgress ( std::string_view str )

inlinevirtual

Callback for messages received by the transport.

Parameters

str	The message from the transport

Returns

Zero for success.

Reimplemented in SlGit::DefaultFetchCallbacks.

transferProgress()

virtual int SlGit::FetchCallbacks::transferProgress ( const git_indexer_progress & stats )

inlinevirtual

Called many times during download and indexing.

Parameters

stats

The statistics

Returns

Zero for success.

Reimplemented in SlGit::DefaultFetchCallbacks.

updateRefs()

virtual int SlGit::FetchCallbacks::updateRefs ( std::string_view refname, const git_oid & a, const git_oid & b, git_refspec & ref )

inlinevirtual

Called for each updated reference.

Parameters

refname	The name of the reference
a	The original OID
b	The new OID
ref	The reference structure

Returns

Zero for success.

Reimplemented in SlGit::DefaultFetchCallbacks.

---

The documentation for this class was generated from the following file:

• /home/abuild/rpmbuild/BUILD/slhelpers-20260428.f233ce9-build/slhelpers-20260428.f233ce9/include/git/FetchCallbacks.h