transmission/libtransmission/trevent.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

#include "tr-macros.h"

TR_BEGIN_DECLS

void tr_eventInit(tr_session*);

void tr_eventClose(tr_session*);

bool tr_amInEventThread(tr_session const*);

void tr_runInEventThread(tr_session*, void (*func)(void*), void* user_data);

TR_END_DECLS
do all the libevent enqueuing from a single thread. 2007-08-18 03:02:32 +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`
do all the libevent enqueuing from a single thread. 2007-08-18 03:02:32 +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.`
update version.sh to exclude third-party. add $Id:$ to the new files s.t. version.sh will find them. 2007-08-18 17:05:51 +00:00			`*`
do all the libevent enqueuing from a single thread. 2007-08-18 03:02:32 +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__`
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			`#error only libtransmission should #include this header.`
(libT) add #ifdefs to ensure that client apps don't #include private libtransmission headers. 2008-11-24 20:17:36 +00:00			`#endif`

refactor: use GTest for running tests (#1383) * refactor: use google-test on libtransmission tests 2020-08-11 18:11:55 +00:00			`#include "tr-macros.h"`

			`TR_BEGIN_DECLS`
do all the libevent enqueuing from a single thread. 2007-08-18 03:02:32 +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_eventInit(tr_session*);`
do all the libevent enqueuing from a single thread. 2007-08-18 03:02:32 +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_eventClose(tr_session*);`
do all the libevent enqueuing from a single thread. 2007-08-18 03:02:32 +00:00
Align type qualifiers to the right (code style) This way all the qualifiers (`const`, `volatile`, `mutable`) are grouped together, e.g. `T const* const x` vs. `const T* const x`. Also helps reading types right-to-left, e.g. "constant pointer to constant T" vs. "constant pointer to T which is constant". 2017-04-20 16:02:19 +00:00			`bool tr_amInEventThread(tr_session const*);`
merge encryption branch to trunk (xcode project is still out of date) 2007-09-20 16:32:01 +00:00
Switch to clang-format for code formatting, include Mac client 2021-08-15 09:41:48 +00:00			`void tr_runInEventThread(tr_session, void (func)(void), void user_data);`
refactor: use GTest for running tests (#1383) * refactor: use google-test on libtransmission tests 2020-08-11 18:11:55 +00:00
			`TR_END_DECLS`