include/git2/global.h

0001 /*
0002  * Copyright (C) the libgit2 contributors. All rights reserved.
0003  *
0004  * This file is part of libgit2, distributed under the GNU GPL v2 with
0005  * a Linking Exception. For full terms see the included COPYING file.
0006  */
0007 #ifndef INCLUDE_git_global_h__
0008 #define INCLUDE_git_global_h__
0009
0010 #include "common.h"
0011
0012 GIT_BEGIN_DECL
0013
0014 /**
0015  * Init the global state
0016  *
0017  * This function must be called before any other libgit2 function in
0018  * order to set up global state and threading.
0019  *
0020  * This function may be called multiple times - it will return the number
0021  * of times the initialization has been called (including this one) that have
0022  * not subsequently been shutdown.
0023  *
0024  * @return the number of initializations of the library, or an error code.
0025  */
0026 GIT_EXTERN(int) git_libgit2_init(void);
0027
0028 /**
0029  * Shutdown the global state
0030  *
0031  * Clean up the global state and threading context after calling it as
0032  * many times as `git_libgit2_init()` was called - it will return the
0033  * number of remainining initializations that have not been shutdown
0034  * (after this one).
0035  *
0036  * @return the number of remaining initializations of the library, or an
0037  * error code.
0038  */
0039 GIT_EXTERN(int) git_libgit2_shutdown(void);
0040
0041 /** @} */
0042 GIT_END_DECL
0043 #endif
0044