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

#include <cstddef> // size_t

#include "tr-macros.h"

/**
 * @brief parse a peer-id into a human-readable client name and version number
 * @ingroup utils
 */
char* tr_clientForId(char* buf, size_t buflen, tr_peer_id_t peer_id);
(trunk libT) update the copyrights on some files that no longer have old code in them 2009-01-07 06:53:29 +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`
Revert [619] 2006-07-16 19:39:23 +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.`
Revert [619] 2006-07-16 19:39:23 +00:00			`*`
(trunk libT) update the copyrights on some files that no longer have old code in them 2009-01-07 06:53:29 +00:00			`*/`
Revert [619] 2006-07-16 19:39:23 +00:00
Ensure include guard is the first non-comment line 2017-11-14 20:21:28 +00:00			`#pragma once`

(trunk) add #include guards to prevent non-libtransmission files from #including implementation headers 2009-12-15 00:51:39 +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.`
(trunk) add #include guards to prevent non-libtransmission files from #including implementation headers 2009-12-15 00:51:39 +00:00			`#endif`

refactor: tidy libtransmission includes (#2316) 2021-12-15 21:25:42 +00:00			`#include <cstddef> // size_t`

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"`

(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			`/**`
(trunk) No code changes here... filling in some of the blanks in the "peers" and "utils" doxygen groups' documentation. 2010-01-19 19:37:00 +00:00			`* @brief parse a peer-id into a human-readable client name and version number`
(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			`* @ingroup utils`
			`*/`
fixup! refactor: add tr_peer_id_t (#2004) (#2016) fix: array bounds read error introduced yesterday 2021-10-22 20:24:30 +00:00			`char* tr_clientForId(char* buf, size_t buflen, tr_peer_id_t peer_id);`