transmission/libtransmission/verify.h

/*
 * This file Copyright (C) 2007-2014 Mnemosyne LLC
 *
 * It may be used under the GNU GPL versions 2 or 3
 * or any future license endorsed by Mnemosyne LLC.
 *
 */

#pragma once

#ifndef __TRANSMISSION__
#error only libtransmission should #include this header.
#endif

/**
 * @addtogroup file_io File IO
 * @{
 */

void tr_verifyAdd(tr_torrent* tor, tr_verify_done_func callback_func, void* callback_user_data);

void tr_verifyRemove(tr_torrent* tor);

void tr_verifyClose(tr_session*);

/* @} */
modify "verify local data" to not lose the blocks in incomplete pieces 2008-02-15 16:00:46 +00:00			`/*`
Licensing changes: 1. add the option the code to be used under GPLv2 or GPLv3; previously only GPLv2 was allowed 2. add the "proxy option" as described in GPLv3 so we can add future licenses without having to bulk-edit everything again :) 3. remove the awkward "exception for MIT code in Mac client" clause; it was unnecessary and confusing. 2014-01-19 01:09:44 +00:00			`* This file Copyright (C) 2007-2014 Mnemosyne LLC`
modify "verify local data" to not lose the blocks in incomplete pieces 2008-02-15 16:00:46 +00:00			`*`
Copyedit the license's revised text: (1) remove unnecessary repitition use of the word 'license' from the top of the header and source files (2) add the standard 'we hope it's useful, but no warranty' clause to COPYING (3) make explicit that linking OpenSSL is allowed (see https://people.gnome.org/~markmc/openssl-and-the-gpl.html for background) (4) sync the Qt and GTK+ clients' license popups with COPYING's revised text 2014-01-21 03:10:30 +00:00			`* It may be used under the GNU GPL versions 2 or 3`
Licensing changes: 1. add the option the code to be used under GPLv2 or GPLv3; previously only GPLv2 was allowed 2. add the "proxy option" as described in GPLv3 so we can add future licenses without having to bulk-edit everything again :) 3. remove the awkward "exception for MIT code in Mac client" clause; it was unnecessary and confusing. 2014-01-19 01:09:44 +00:00			`* or any future license endorsed by Mnemosyne LLC.`
modify "verify local data" to not lose the blocks in incomplete pieces 2008-02-15 16:00:46 +00:00			`*`
			`*/`

Ensure include guard is the first non-comment line 2017-11-14 20:21:28 +00:00			`#pragma once`

(libT) add #ifdefs to ensure that client apps don't #include private libtransmission headers. 2008-11-24 20:17:36 +00:00			`#ifndef __TRANSMISSION__`
			`#error only libtransmission should #include this header.`
			`#endif`

(trunk libT) re-start work on making libT doxygen friendly. still a long ways to go on this. 2009-05-29 19:17:12 +00:00			`/**`
			`* @addtogroup file_io File IO`
			`* @{`
			`*/`

Adjust uncrustify config, reformat all but Mac client There're places where manual intervention is still required as uncrustify is not ideal (unfortunately), but at least one may rely on it to do the right thing most of the time (e.g. when sending in a patch). The style itself is quite different from what we had before but making it uniform across all the codebase is the key. I also hope that it'll make the code more readable (YMMV) and less sensitive to further changes. 2017-04-19 12:04:45 +00:00			`void tr_verifyAdd(tr_torrent* tor, tr_verify_done_func callback_func, void* callback_user_data);`
modify "verify local data" to not lose the blocks in incomplete pieces 2008-02-15 16:00:46 +00:00
Adjust uncrustify config, reformat all but Mac client There're places where manual intervention is still required as uncrustify is not ideal (unfortunately), but at least one may rely on it to do the right thing most of the time (e.g. when sending in a patch). The style itself is quite different from what we had before but making it uniform across all the codebase is the key. I also hope that it'll make the code more readable (YMMV) and less sensitive to further changes. 2017-04-19 12:04:45 +00:00			`void tr_verifyRemove(tr_torrent* tor);`
modify "verify local data" to not lose the blocks in incomplete pieces 2008-02-15 16:00:46 +00:00
Adjust uncrustify config, reformat all but Mac client There're places where manual intervention is still required as uncrustify is not ideal (unfortunately), but at least one may rely on it to do the right thing most of the time (e.g. when sending in a patch). The style itself is quite different from what we had before but making it uniform across all the codebase is the key. I also hope that it'll make the code more readable (YMMV) and less sensitive to further changes. 2017-04-19 12:04:45 +00:00			`void tr_verifyClose(tr_session*);`
#1308: Transmission forgets it's verifying data 2008-10-28 15:13:07 +00:00
(trunk libT) re-start work on making libT doxygen friendly. still a long ways to go on this. 2009-05-29 19:17:12 +00:00			`/* @} */`