1 /*
2  * This file is part of gtkD.
3  *
4  * gtkD is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU Lesser General Public License
6  * as published by the Free Software Foundation; either version 3
7  * of the License, or (at your option) any later version, with
8  * some exceptions, please read the COPYING file.
9  *
10  * gtkD is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public License
16  * along with gtkD; if not, write to the Free Software
17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA
18  */
19 
20 // generated automatically - do not change
21 // find conversion definition on APILookup.txt
22 // implement new conversion functionalities on the wrap.utils pakage
23 
24 
25 module gio.InetSocketAddress;
26 
27 private import gio.InetAddress;
28 private import gio.SocketAddress;
29 private import gio.c.functions;
30 public  import gio.c.types;
31 private import glib.ConstructionException;
32 private import glib.Str;
33 private import gobject.ObjectG;
34 
35 
36 /**
37  * An IPv4 or IPv6 socket address; that is, the combination of a
38  * #GInetAddress and a port number.
39  */
40 public class InetSocketAddress : SocketAddress
41 {
42 	/** the main Gtk struct */
43 	protected GInetSocketAddress* gInetSocketAddress;
44 
45 	/** Get the main Gtk struct */
46 	public GInetSocketAddress* getInetSocketAddressStruct(bool transferOwnership = false)
47 	{
48 		if (transferOwnership)
49 			ownedRef = false;
50 		return gInetSocketAddress;
51 	}
52 
53 	/** the main Gtk struct as a void* */
54 	protected override void* getStruct()
55 	{
56 		return cast(void*)gInetSocketAddress;
57 	}
58 
59 	/**
60 	 * Sets our main struct and passes it to the parent class.
61 	 */
62 	public this (GInetSocketAddress* gInetSocketAddress, bool ownedRef = false)
63 	{
64 		this.gInetSocketAddress = gInetSocketAddress;
65 		super(cast(GSocketAddress*)gInetSocketAddress, ownedRef);
66 	}
67 
68 
69 	/** */
70 	public static GType getType()
71 	{
72 		return g_inet_socket_address_get_type();
73 	}
74 
75 	/**
76 	 * Creates a new #GInetSocketAddress for @address and @port.
77 	 *
78 	 * Params:
79 	 *     address = a #GInetAddress
80 	 *     port = a port number
81 	 *
82 	 * Returns: a new #GInetSocketAddress
83 	 *
84 	 * Since: 2.22
85 	 *
86 	 * Throws: ConstructionException GTK+ fails to create the object.
87 	 */
88 	public this(InetAddress address, ushort port)
89 	{
90 		auto __p = g_inet_socket_address_new((address is null) ? null : address.getInetAddressStruct(), port);
91 
92 		if(__p is null)
93 		{
94 			throw new ConstructionException("null returned by new");
95 		}
96 
97 		this(cast(GInetSocketAddress*) __p, true);
98 	}
99 
100 	/**
101 	 * Creates a new #GInetSocketAddress for @address and @port.
102 	 *
103 	 * If @address is an IPv6 address, it can also contain a scope ID
104 	 * (separated from the address by a `%`).
105 	 *
106 	 * Params:
107 	 *     address = the string form of an IP address
108 	 *     port = a port number
109 	 *
110 	 * Returns: a new #GInetSocketAddress,
111 	 *     or %NULL if @address cannot be parsed.
112 	 *
113 	 * Since: 2.40
114 	 *
115 	 * Throws: ConstructionException GTK+ fails to create the object.
116 	 */
117 	public this(string address, uint port)
118 	{
119 		auto __p = g_inet_socket_address_new_from_string(Str.toStringz(address), port);
120 
121 		if(__p is null)
122 		{
123 			throw new ConstructionException("null returned by new_from_string");
124 		}
125 
126 		this(cast(GInetSocketAddress*) __p, true);
127 	}
128 
129 	/**
130 	 * Gets @address's #GInetAddress.
131 	 *
132 	 * Returns: the #GInetAddress for @address, which must be
133 	 *     g_object_ref()'d if it will be stored
134 	 *
135 	 * Since: 2.22
136 	 */
137 	public InetAddress getAddress()
138 	{
139 		auto __p = g_inet_socket_address_get_address(gInetSocketAddress);
140 
141 		if(__p is null)
142 		{
143 			return null;
144 		}
145 
146 		return ObjectG.getDObject!(InetAddress)(cast(GInetAddress*) __p);
147 	}
148 
149 	/**
150 	 * Gets the `sin6_flowinfo` field from @address,
151 	 * which must be an IPv6 address.
152 	 *
153 	 * Returns: the flowinfo field
154 	 *
155 	 * Since: 2.32
156 	 */
157 	public uint getFlowinfo()
158 	{
159 		return g_inet_socket_address_get_flowinfo(gInetSocketAddress);
160 	}
161 
162 	/**
163 	 * Gets @address's port.
164 	 *
165 	 * Returns: the port for @address
166 	 *
167 	 * Since: 2.22
168 	 */
169 	public ushort getPort()
170 	{
171 		return g_inet_socket_address_get_port(gInetSocketAddress);
172 	}
173 
174 	/**
175 	 * Gets the `sin6_scope_id` field from @address,
176 	 * which must be an IPv6 address.
177 	 *
178 	 * Returns: the scope id field
179 	 *
180 	 * Since: 2.32
181 	 */
182 	public uint getScopeId()
183 	{
184 		return g_inet_socket_address_get_scope_id(gInetSocketAddress);
185 	}
186 }