transmission/libtransmission/blocklist.h

/*
 * This file Copyright (C) 2008-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

struct tr_address;

typedef struct tr_blocklistFile tr_blocklistFile;

tr_blocklistFile* tr_blocklistFileNew(char const* filename, bool isEnabled);

bool tr_blocklistFileExists(tr_blocklistFile const* b);

char const* tr_blocklistFileGetFilename(tr_blocklistFile const* b);

int tr_blocklistFileGetRuleCount(tr_blocklistFile const* b);

void tr_blocklistFileFree(tr_blocklistFile* b);

bool tr_blocklistFileIsEnabled(tr_blocklistFile* b);

void tr_blocklistFileSetEnabled(tr_blocklistFile* b, bool isEnabled);

bool tr_blocklistFileHasAddress(tr_blocklistFile* b, struct tr_address const* addr);

int tr_blocklistFileSetContent(tr_blocklistFile* b, char const* filename);
first (and incomplete) pass at peer blocking. this commit is to get the API into SVN so the mac client can access them 2008-03-29 18:37:07 +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) 2008-2014 Mnemosyne LLC`
first (and incomplete) pass at peer blocking. this commit is to get the API into SVN so the mac client can access them 2008-03-29 18:37:07 +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.`
first (and incomplete) pass at peer blocking. this commit is to get the API into SVN so the mac client can access them 2008-03-29 18:37:07 +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`

(libT) re-apply jhujhiti's IPv6 patch. This merges in my tr_port cleanup, so any new bugs are mine :/ 2008-12-02 03:41:58 +00:00			`struct tr_address;`
first (and incomplete) pass at peer blocking. this commit is to get the API into SVN so the mac client can access them 2008-03-29 18:37:07 +00:00
(libT) copyediting: rename the internal tr_blocklist class 'tr_blocklistFile' to distinguish the private per-file API from the public, global API in libtransmission.h 2013-01-21 17:48:36 +00:00			`typedef struct tr_blocklistFile tr_blocklistFile;`
run libT, cli, daemon, gtk through the source-code formatter "uncrustify" as promised/threatened 2008-09-23 19:11:04 +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			`tr_blocklistFile* tr_blocklistFileNew(char const* filename, bool isEnabled);`
run libT, cli, daemon, gtk through the source-code formatter "uncrustify" as promised/threatened 2008-09-23 19:11:04 +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_blocklistFileExists(tr_blocklistFile const* b);`
run libT, cli, daemon, gtk through the source-code formatter "uncrustify" as promised/threatened 2008-09-23 19:11:04 +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			`char const* tr_blocklistFileGetFilename(tr_blocklistFile const* b);`
run libT, cli, daemon, gtk through the source-code formatter "uncrustify" as promised/threatened 2008-09-23 19:11:04 +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			`int tr_blocklistFileGetRuleCount(tr_blocklistFile const* b);`
run libT, cli, daemon, gtk through the source-code formatter "uncrustify" as promised/threatened 2008-09-23 19:11:04 +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_blocklistFileFree(tr_blocklistFile* b);`
run libT, cli, daemon, gtk through the source-code formatter "uncrustify" as promised/threatened 2008-09-23 19:11:04 +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			`bool tr_blocklistFileIsEnabled(tr_blocklistFile* b);`
run libT, cli, daemon, gtk through the source-code formatter "uncrustify" as promised/threatened 2008-09-23 19:11:04 +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_blocklistFileSetEnabled(tr_blocklistFile* b, bool isEnabled);`
run libT, cli, daemon, gtk through the source-code formatter "uncrustify" as promised/threatened 2008-09-23 19:11:04 +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_blocklistFileHasAddress(tr_blocklistFile* b, struct tr_address const* addr);`
first (and incomplete) pass at peer blocking. this commit is to get the API into SVN so the mac client can access them 2008-03-29 18:37:07 +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			`int tr_blocklistFileSetContent(tr_blocklistFile* b, char const* filename);`