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