/*
 * Licensed under the GNU Lesser General Public License Version 3
 *
 * This library is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the license, or
 * (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library.  If not, see <http://www.gnu.org/licenses/>.
 */

// generated automatically - do not change


module gio.SrvTarget;

private import gio.c.functions;
public  import gio.c.types;
private import glib.ConstructionException;
private import glib.ListG;
private import glib.Str;
private import gobject.ObjectG;


/**
 * SRV (service) records are used by some network protocols to provide
 * service-specific aliasing and load-balancing. For example, XMPP
 * (Jabber) uses SRV records to locate the XMPP server for a domain;
 * rather than connecting directly to "example.com" or assuming a
 * specific server hostname like "xmpp.example.com", an XMPP client
 * would look up the "xmpp-client" SRV record for "example.com", and
 * then connect to whatever host was pointed to by that record.
 * 
 * You can use g_resolver_lookup_service() or
 * g_resolver_lookup_service_async() to find the #GSrvTargets
 * for a given service. However, if you are simply planning to connect
 * to the remote service, you can use #GNetworkService's
 * #GSocketConnectable interface and not need to worry about
 * #GSrvTarget at all.
 */
public class SrvTarget
{
	/** the main Gtk struct */
	protected GSrvTarget* gSrvTarget;
	protected bool ownedRef;

	/** Get the main Gtk struct */
	public GSrvTarget* getSrvTargetStruct(bool transferOwnership = false)
	{
		if (transferOwnership)
			ownedRef = false;
		return gSrvTarget;
	}

	/** the main Gtk struct as a void* */
	protected void* getStruct()
	{
		return cast(void*)gSrvTarget;
	}

	/**
	 * Sets our main struct and passes it to the parent class.
	 */
	public this (GSrvTarget* gSrvTarget, bool ownedRef = false)
	{
		this.gSrvTarget = gSrvTarget;
		this.ownedRef = ownedRef;
	}

	~this ()
	{
		if (  ownedRef )
			g_srv_target_free(gSrvTarget);
	}


	/** */
	public static GType getType()
	{
		return g_srv_target_get_type();
	}

	/**
	 * Creates a new #GSrvTarget with the given parameters.
	 *
	 * You should not need to use this; normally #GSrvTargets are
	 * created by #GResolver.
	 *
	 * Params:
	 *     hostname = the host that the service is running on
	 *     port = the port that the service is running on
	 *     priority = the target's priority
	 *     weight = the target's weight
	 *
	 * Returns: a new #GSrvTarget.
	 *
	 * Since: 2.22
	 *
	 * Throws: ConstructionException GTK+ fails to create the object.
	 */
	public this(string hostname, ushort port, ushort priority, ushort weight)
	{
		auto p = g_srv_target_new(Str.toStringz(hostname), port, priority, weight);

		if(p is null)
		{
			throw new ConstructionException("null returned by new");
		}

		this(cast(GSrvTarget*) p);
	}

	/**
	 * Copies @target
	 *
	 * Returns: a copy of @target
	 *
	 * Since: 2.22
	 */
	public SrvTarget copy()
	{
		auto p = g_srv_target_copy(gSrvTarget);

		if(p is null)
		{
			return null;
		}

		return ObjectG.getDObject!(SrvTarget)(cast(GSrvTarget*) p, true);
	}

	/**
	 * Frees @target
	 *
	 * Since: 2.22
	 */
	public void free()
	{
		g_srv_target_free(gSrvTarget);
		ownedRef = false;
	}

	/**
	 * Gets @target's hostname (in ASCII form; if you are going to present
	 * this to the user, you should use g_hostname_is_ascii_encoded() to
	 * check if it contains encoded Unicode segments, and use
	 * g_hostname_to_unicode() to convert it if it does.)
	 *
	 * Returns: @target's hostname
	 *
	 * Since: 2.22
	 */
	public string getHostname()
	{
		return Str.toString(g_srv_target_get_hostname(gSrvTarget));
	}

	/**
	 * Gets @target's port
	 *
	 * Returns: @target's port
	 *
	 * Since: 2.22
	 */
	public ushort getPort()
	{
		return g_srv_target_get_port(gSrvTarget);
	}

	/**
	 * Gets @target's priority. You should not need to look at this;
	 * #GResolver already sorts the targets according to the algorithm in
	 * RFC 2782.
	 *
	 * Returns: @target's priority
	 *
	 * Since: 2.22
	 */
	public ushort getPriority()
	{
		return g_srv_target_get_priority(gSrvTarget);
	}

	/**
	 * Gets @target's weight. You should not need to look at this;
	 * #GResolver already sorts the targets according to the algorithm in
	 * RFC 2782.
	 *
	 * Returns: @target's weight
	 *
	 * Since: 2.22
	 */
	public ushort getWeight()
	{
		return g_srv_target_get_weight(gSrvTarget);
	}

	/**
	 * Sorts @targets in place according to the algorithm in RFC 2782.
	 *
	 * Params:
	 *     targets = a #GList of #GSrvTarget
	 *
	 * Returns: the head of the sorted list.
	 *
	 * Since: 2.22
	 */
	public static ListG listSort(ListG targets)
	{
		auto p = g_srv_target_list_sort((targets is null) ? null : targets.getListGStruct());

		if(p is null)
		{
			return null;
		}

		return new ListG(cast(GList*) p, true);
	}
}