transmission/libtransmission/port-forwarding-upnp.h

// This file Copyright © 2007-2022 Mnemosyne LLC.
// It may be used under GPLv2 (SPDX: GPL-2.0-only), GPLv3 (SPDX: GPL-3.0-only),
// or any future license endorsed by Mnemosyne LLC.
// License text can be found in the licenses/ folder.

#pragma once

#ifndef LIBTRANSMISSION_PORT_FORWARDING_MODULE
#error only the libtransmission port forwarding module should #include this header.
#endif

/**
 * @addtogroup port_forwarding Port Forwarding
 * @{
 */

#include <string>

#include "transmission.h"

#include "net.h" // tr_port

struct tr_upnp;

tr_upnp* tr_upnpInit(void);

void tr_upnpClose(tr_upnp*);

tr_port_forwarding_state tr_upnpPulse(tr_upnp*, tr_port port, bool is_enabled, bool do_port_check, std::string);

/* @} */
chore: update copyright years, make notices consistent (#2463) 2022-01-20 18:27:56 +00:00			`// This file Copyright © 2007-2022 Mnemosyne LLC.`
chore: fix spdx abbreviations (#3602) 2022-08-08 18:05:39 +00:00			`// It may be used under GPLv2 (SPDX: GPL-2.0-only), GPLv3 (SPDX: GPL-3.0-only),`
chore: update copyright years, make notices consistent (#2463) 2022-01-20 18:27:56 +00:00			`// or any future license endorsed by Mnemosyne LLC.`
			`// License text can be found in the licenses/ folder.`
Merge nat-traversal branch to trunk. 2006-09-25 18:37:45 +00:00
Ensure include guard is the first non-comment line 2017-11-14 20:21:28 +00:00			`#pragma once`

refactor: port forwarding (#3850) * refactor: rename state enum type as tr_port_forwarding_state * chore: use snake_case for tr_shared struct fields * refactor: replace tr_shared with tr_port_forwarding * refactor: make tr_natpmp_state an enum class * refactor: uniform naming for port-forwarding module * refactor: move output-only parameters in tr_natpmp::pulse() to return struct * fix: use a nullptr multicastif if bindaddr is empty * chore: use PascalCase for enum class values * chore: clean up port-forwarding #includes * chore: remove unused tr_port_forwarding::peerPort() 2022-09-30 13:59:10 +00:00			`#ifndef LIBTRANSMISSION_PORT_FORWARDING_MODULE`
			`#error only the libtransmission port forwarding module 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`

(trunk) all this commit does is remove trailing whitespace from some c, c++, and javascript source 2009-08-12 14:40:32 +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			`* @addtogroup port_forwarding Port Forwarding`
			`* @{`
			`*/`

refactor: remove tr_address_to_string() (#3427) 2022-07-10 01:03:40 +00:00			`#include <string>`

chore: iwyu cleanup (#2981) 2022-04-25 01:49:52 +00:00			`#include "transmission.h"`

			`#include "net.h" // tr_port`

refactor: prefer "using" over "typedef" (#1883) * refactor: prefer "using" over "typedef" 2021-10-06 14:26:07 +00:00			`struct tr_upnp;`
Merge nat-traversal branch to trunk. 2006-09-25 18:37:45 +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			`tr_upnp* tr_upnpInit(void);`
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_upnpClose(tr_upnp*);`

refactor: port forwarding (#3850) * refactor: rename state enum type as tr_port_forwarding_state * chore: use snake_case for tr_shared struct fields * refactor: replace tr_shared with tr_port_forwarding * refactor: make tr_natpmp_state an enum class * refactor: uniform naming for port-forwarding module * refactor: move output-only parameters in tr_natpmp::pulse() to return struct * fix: use a nullptr multicastif if bindaddr is empty * chore: use PascalCase for enum class values * chore: clean up port-forwarding #includes * chore: remove unused tr_port_forwarding::peerPort() 2022-09-30 13:59:10 +00:00			`tr_port_forwarding_state tr_upnpPulse(tr_upnp*, tr_port port, bool is_enabled, bool do_port_check, std::string);`
run libT, cli, daemon, gtk through the source-code formatter "uncrustify" as promised/threatened 2008-09-23 19:11:04 +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			`/* @} */`