1/**************************************************************************/
2/* ip.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 IP_H
32#define IP_H
33
34#include "core/io/ip_address.h"
35#include "core/os/os.h"
36
37template <typename T>
38class TypedArray;
39
40struct _IP_ResolverPrivate;
41
42class IP : public Object {
43 GDCLASS(IP, Object);
44
45public:
46 enum ResolverStatus {
47 RESOLVER_STATUS_NONE,
48 RESOLVER_STATUS_WAITING,
49 RESOLVER_STATUS_DONE,
50 RESOLVER_STATUS_ERROR,
51 };
52
53 enum Type {
54 TYPE_NONE = 0,
55 TYPE_IPV4 = 1,
56 TYPE_IPV6 = 2,
57 TYPE_ANY = 3,
58 };
59
60 enum {
61 RESOLVER_MAX_QUERIES = 256,
62 RESOLVER_INVALID_ID = -1
63 };
64
65 typedef int ResolverID;
66
67private:
68 _IP_ResolverPrivate *resolver = nullptr;
69
70protected:
71 static IP *singleton;
72 static void _bind_methods();
73
74 PackedStringArray _get_local_addresses() const;
75 TypedArray<Dictionary> _get_local_interfaces() const;
76
77 static IP *(*_create)();
78
79public:
80 struct Interface_Info {
81 String name;
82 String name_friendly;
83 String index;
84 List<IPAddress> ip_addresses;
85 };
86
87 IPAddress resolve_hostname(const String &p_hostname, Type p_type = TYPE_ANY);
88 PackedStringArray resolve_hostname_addresses(const String &p_hostname, Type p_type = TYPE_ANY);
89 // async resolver hostname
90 ResolverID resolve_hostname_queue_item(const String &p_hostname, Type p_type = TYPE_ANY);
91 ResolverStatus get_resolve_item_status(ResolverID p_id) const;
92 IPAddress get_resolve_item_address(ResolverID p_id) const;
93 virtual void get_local_addresses(List<IPAddress> *r_addresses) const;
94
95 virtual void _resolve_hostname(List<IPAddress> &r_addresses, const String &p_hostname, Type p_type = TYPE_ANY) const = 0;
96 Array get_resolve_item_addresses(ResolverID p_id) const;
97
98 virtual void get_local_interfaces(HashMap<String, Interface_Info> *r_interfaces) const = 0;
99 void erase_resolve_item(ResolverID p_id);
100
101 void clear_cache(const String &p_hostname = "");
102
103 static IP *get_singleton();
104
105 static IP *create();
106
107 IP();
108 ~IP();
109};
110
111VARIANT_ENUM_CAST(IP::Type);
112VARIANT_ENUM_CAST(IP::ResolverStatus);
113
114#endif // IP_H
115