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 public  import gtkc.giotypes;
35 
36 
37 /**
38  * An IPv4 or IPv6 socket address; that is, the combination of a
39  * #GInetAddress and a port number.
40  */
41 public class InetSocketAddress : SocketAddress
42 {
43 	/** the main Gtk struct */
44 	protected GInetSocketAddress* gInetSocketAddress;
45 
46 	/** Get the main Gtk struct */
47 	public GInetSocketAddress* getInetSocketAddressStruct(bool transferOwnership = false)
48 	{
49 		if (transferOwnership)
50 			ownedRef = false;
51 		return gInetSocketAddress;
52 	}
53 
54 	/** the main Gtk struct as a void* */
55 	protected override void* getStruct()
56 	{
57 		return cast(void*)gInetSocketAddress;
58 	}
59 
60 	/**
61 	 * Sets our main struct and passes it to the parent class.
62 	 */
63 	public this (GInetSocketAddress* gInetSocketAddress, bool ownedRef = false)
64 	{
65 		this.gInetSocketAddress = gInetSocketAddress;
66 		super(cast(GSocketAddress*)gInetSocketAddress, ownedRef);
67 	}
68 
69 
70 	/** */
71 	public static GType getType()
72 	{
73 		return g_inet_socket_address_get_type();
74 	}
75 
76 	/**
77 	 * Creates a new #GInetSocketAddress for @address and @port.
78 	 *
79 	 * Params:
80 	 *     address = a #GInetAddress
81 	 *     port = a port number
82 	 *
83 	 * Returns: a new #GInetSocketAddress
84 	 *
85 	 * Since: 2.22
86 	 *
87 	 * Throws: ConstructionException GTK+ fails to create the object.
88 	 */
89 	public this(InetAddress address, ushort port)
90 	{
91 		auto p = g_inet_socket_address_new((address is null) ? null : address.getInetAddressStruct(), port);
92 
93 		if(p is null)
94 		{
95 			throw new ConstructionException("null returned by new");
96 		}
97 
98 		this(cast(GInetSocketAddress*) p, true);
99 	}
100 
101 	/**
102 	 * Creates a new #GInetSocketAddress for @address and @port.
103 	 *
104 	 * If @address is an IPv6 address, it can also contain a scope ID
105 	 * (separated from the address by a `%`).
106 	 *
107 	 * Params:
108 	 *     address = the string form of an IP address
109 	 *     port = a port number
110 	 *
111 	 * Returns: a new #GInetSocketAddress, or %NULL if @address cannot be
112 	 *     parsed.
113 	 *
114 	 * Since: 2.40
115 	 *
116 	 * Throws: ConstructionException GTK+ fails to create the object.
117 	 */
118 	public this(string address, uint port)
119 	{
120 		auto p = g_inet_socket_address_new_from_string(Str.toStringz(address), port);
121 
122 		if(p is null)
123 		{
124 			throw new ConstructionException("null returned by new_from_string");
125 		}
126 
127 		this(cast(GInetSocketAddress*) p, true);
128 	}
129 
130 	/**
131 	 * Gets @address's #GInetAddress.
132 	 *
133 	 * Returns: the #GInetAddress for @address, which must be
134 	 *     g_object_ref()'d if it will be stored
135 	 *
136 	 * Since: 2.22
137 	 */
138 	public InetAddress getAddress()
139 	{
140 		auto p = g_inet_socket_address_get_address(gInetSocketAddress);
141 
142 		if(p is null)
143 		{
144 			return null;
145 		}
146 
147 		return ObjectG.getDObject!(InetAddress)(cast(GInetAddress*) p);
148 	}
149 
150 	/**
151 	 * Gets the `sin6_flowinfo` field from @address,
152 	 * which must be an IPv6 address.
153 	 *
154 	 * Returns: the flowinfo field
155 	 *
156 	 * Since: 2.32
157 	 */
158 	public uint getFlowinfo()
159 	{
160 		return g_inet_socket_address_get_flowinfo(gInetSocketAddress);
161 	}
162 
163 	/**
164 	 * Gets @address's port.
165 	 *
166 	 * Returns: the port for @address
167 	 *
168 	 * Since: 2.22
169 	 */
170 	public ushort getPort()
171 	{
172 		return g_inet_socket_address_get_port(gInetSocketAddress);
173 	}
174 
175 	/**
176 	 * Gets the `sin6_scope_id` field from @address,
177 	 * which must be an IPv6 address.
178 	 *
179 	 * Returns: the scope id field
180 	 *
181 	 * Since: 2.32
182 	 */
183 	public uint getScopeId()
184 	{
185 		return g_inet_socket_address_get_scope_id(gInetSocketAddress);
186 	}
187 }