1/**************************************************************************/
2/* upnp_device.h */
3/**************************************************************************/
4/* This file is part of: */
5/* GODOT ENGINE */
6/* https://godotengine.org */
7/**************************************************************************/
8/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
9/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
10/* */
11/* Permission is hereby granted, free of charge, to any person obtaining */
12/* a copy of this software and associated documentation files (the */
13/* "Software"), to deal in the Software without restriction, including */
14/* without limitation the rights to use, copy, modify, merge, publish, */
15/* distribute, sublicense, and/or sell copies of the Software, and to */
16/* permit persons to whom the Software is furnished to do so, subject to */
17/* the following conditions: */
18/* */
19/* The above copyright notice and this permission notice shall be */
20/* included in all copies or substantial portions of the Software. */
21/* */
22/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
23/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
24/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
25/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
26/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
27/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
28/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
29/**************************************************************************/
30
31#ifndef UPNP_DEVICE_H
32#define UPNP_DEVICE_H
33
34#include "core/object/ref_counted.h"
35
36class UPNPDevice : public RefCounted {
37 GDCLASS(UPNPDevice, RefCounted);
38
39public:
40 enum IGDStatus {
41 IGD_STATUS_OK,
42 IGD_STATUS_HTTP_ERROR,
43 IGD_STATUS_HTTP_EMPTY,
44 IGD_STATUS_NO_URLS,
45 IGD_STATUS_NO_IGD,
46 IGD_STATUS_DISCONNECTED,
47 IGD_STATUS_UNKNOWN_DEVICE,
48 IGD_STATUS_INVALID_CONTROL,
49 IGD_STATUS_MALLOC_ERROR,
50 IGD_STATUS_UNKNOWN_ERROR,
51 };
52
53 void set_description_url(const String &url);
54 String get_description_url() const;
55
56 void set_service_type(const String &type);
57 String get_service_type() const;
58
59 void set_igd_control_url(const String &url);
60 String get_igd_control_url() const;
61
62 void set_igd_service_type(const String &type);
63 String get_igd_service_type() const;
64
65 void set_igd_our_addr(const String &addr);
66 String get_igd_our_addr() const;
67
68 void set_igd_status(IGDStatus status);
69 IGDStatus get_igd_status() const;
70
71 bool is_valid_gateway() const;
72 String query_external_address() const;
73 int add_port_mapping(int port, int port_internal = 0, String desc = "", String proto = "UDP", int duration = 0) const;
74 int delete_port_mapping(int port, String proto = "UDP") const;
75
76 UPNPDevice();
77 ~UPNPDevice();
78
79protected:
80 static void _bind_methods();
81
82private:
83 String description_url;
84 String service_type;
85 String igd_control_url;
86 String igd_service_type;
87 String igd_our_addr;
88 IGDStatus igd_status;
89};
90
91VARIANT_ENUM_CAST(UPNPDevice::IGDStatus)
92
93#endif // UPNP_DEVICE_H
94