glibmm  2.34.0
Public Member Functions | Static Public Member Functions | Related Functions
Gio::Resolver Class Reference

Asynchronous and cancellable DNS resolver. More...

#include <giomm/resolver.h>

Inheritance diagram for Gio::Resolver:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual ~Resolver ()
GResolver* gobj ()
 Provides access to the underlying C GObject.
const GResolver* gobj () const
 Provides access to the underlying C GObject.
GResolver* gobj_copy ()
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
Glib::ListHandle< Glib::RefPtr
< InetAddress > > 
lookup_by_name (const Glib::ustring& hostname, const Glib::RefPtr< Cancellable >& cancellable)
 Synchronously resolves hostname to determine its associated IP address(es).
Glib::ListHandle< Glib::RefPtr
< InetAddress > > 
lookup_by_name (const Glib::ustring& hostname)
 A lookup_by_name() convenience overload.
void lookup_by_name_async (const Glib::ustring& hostname, const SlotAsyncReady& slot, const Glib::RefPtr< Cancellable >& cancellable)
 Begins asynchronously resolving hostname to determine its associated IP address(es), and eventually calls slot, which must call lookup_by_name_finish() to get the result.
void lookup_by_name_async (const Glib::ustring& hostname, const SlotAsyncReady& slot)
 Begins asynchronously resolving hostname to determine its associated IP address(es), and eventually calls slot, which must call lookup_by_name_finish() to get the result.
Glib::ListHandle< Glib::RefPtr
< InetAddress > > 
lookup_by_name_finish (const Glib::RefPtr< AsyncResult >& result)
 Retrieves the result of a call to g_resolver_lookup_by_name_async().
Glib::ustring lookup_by_address (const Glib::RefPtr< InetAddress >& address, const Glib::RefPtr< Cancellable >& cancellable)
 Synchronously reverse-resolves address to determine its associated hostname.
Glib::ustring lookup_by_address (const Glib::RefPtr< InetAddress >& address)
 A lookup_by_address() convenience overload.
void lookup_by_address_async (const Glib::RefPtr< InetAddress >& address, const SlotAsyncReady& slot, const Glib::RefPtr< Cancellable >& cancellable)
 Begins asynchronously reverse-resolving an address to determine its associated hostname, and eventually calls callback, which must call lookup_by_address_finish() to get the final result.
void lookup_by_address_async (const Glib::RefPtr< InetAddress >& address, const SlotAsyncReady& slot)
 Begins asynchronously reverse-resolving an address to determine its associated hostname, and eventually calls callback, which must call lookup_by_address_finish() to get the final result.
Glib::ustring lookup_by_address_finish (const Glib::RefPtr< AsyncResult >& result)
 Retrieves the result of a previous call to g_resolver_lookup_by_address_async().
ListHandle_SrvTarget lookup_service (const Glib::ustring& service, const Glib::ustring& protocol, const Glib::ustring& domain, const Glib::RefPtr< Cancellable >& cancellable)
 Synchronously performs a DNS SRV lookup for the given service and protocol in the given domain and returns an array of SrvTarget.
ListHandle_SrvTarget lookup_service (const Glib::ustring& service, const Glib::ustring& protocol, const Glib::ustring& domain)
 A lookup_service() convenience overload.
void lookup_service_async (const Glib::ustring& service, const Glib::ustring& protocol, const Glib::ustring& domain, const SlotAsyncReady& slot, const Glib::RefPtr< Cancellable >& cancellable)
 Begins asynchronously performing a DNS SRV lookup for the given service and protocol in the given domain, and eventually calls callback, which must call lookup_service_finish() to get the final result.
void lookup_service_async (const Glib::ustring& service, const Glib::ustring& protocol, const Glib::ustring& domain, const SlotAsyncReady& slot)
 Begins asynchronously performing a DNS SRV lookup for the given service and protocol in the given domain, and eventually calls callback, which must call lookup_service_finish() to get the final result.
ListHandle_SrvTarget lookup_service_finish (const Glib::RefPtr< AsyncResult >& result)
 Retrieves the result of a previous call to g_resolver_lookup_service_async().
Glib::SignalProxy0< void > signal_reload ()
- Public Member Functions inherited from Glib::Object
void* get_data (const QueryQuark& key)
void set_data (const Quark& key, void* data)
void set_data (const Quark& key, void* data, DestroyNotify notify)
void remove_data (const QueryQuark& quark)
void* steal_data (const QueryQuark& quark)
- Public Member Functions inherited from Glib::ObjectBase
void set_property_value (const Glib::ustring& property_name, const Glib::ValueBase& value)
 You probably want to use a specific property_*() accessor method instead.
void get_property_value (const Glib::ustring& property_name, Glib::ValueBase& value) const
 You probably want to use a specific property_*() accessor method instead.
template<class PropertyType >
void set_property (const Glib::ustring& property_name, const PropertyType& value)
 You probably want to use a specific property_*() accessor method instead.
template<class PropertyType >
void get_property (const Glib::ustring& property_name, PropertyType& value) const
 You probably want to use a specific property_*() accessor method instead.
void connect_property_changed (const Glib::ustring& property_name, const sigc::slot< void >& slot)
 You can use the signal_changed() signal of the property proxy instead, but this is necessary when using the reduced API.
sigc::connection connect_property_changed_with_return (const Glib::ustring& property_name, const sigc::slot< void >& slot)
 You can use the signal_changed() signal of the property proxy instead, but this is necessary when using the reduced API.
void freeze_notify ()
 Increases the freeze count on object.
void thaw_notify ()
 Reverts the effect of a previous call to freeze_notify().
virtual void reference () const
 Increment the reference count for this object.
virtual void unreference () const
 Decrement the reference count for this object.
GObject* gobj_copy () const
 Give a ref-ed copy to someone. Use for direct struct access.
- Public Member Functions inherited from sigc::trackable
 trackable (const trackable &src)
trackableoperator= (const trackable &src)
void add_destroy_notify_callback (void *data, func_destroy_notify func) const
void remove_destroy_notify_callback (void *data) const
void notify_callbacks ()

Static Public Member Functions

static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system.
static Glib::RefPtr< Resolverget_default ()
static void set_default (const Glib::RefPtr< Resolver >& resolver)

Related Functions

(Note that these are not member functions.)

Glib::RefPtr< Gio::Resolverwrap (GResolver* object, bool take_copy=false)
 A Glib::wrap() method for this object.

Additional Inherited Members

- Public Types inherited from Glib::Object
typedef void(* DestroyNotify )(gpointer data)
- Protected Member Functions inherited from Glib::Object
 Object ()
 Object (const Glib::ConstructParams& construct_params)
 Object (GObject* castitem)
virtual ~Object ()
- Protected Member Functions inherited from Glib::ObjectBase
 ObjectBase ()
 This default constructor is called implicitly from the constructor of user-derived classes, even if, for instance, Gtk::Button calls a different ObjectBase constructor.
 ObjectBase (const char* custom_type_name)
 A derived constructor always overrides this choice.
 ObjectBase (const std::type_info& custom_type_info)
 This constructor is a special feature to allow creation of derived types on the fly, without having to use g_object_new() manually.
virtual ~ObjectBase ()=0
void initialize (GObject* castitem)

Detailed Description

Asynchronous and cancellable DNS resolver.

Resolver provides cancellable synchronous and asynchronous DNS resolution, for hostnames (lookup_by_address(), lookup_by_name() and their async variants) and SRV (service) records (lookup_service()).

NetworkAddress and NetworkService provide wrappers around Resolver functionality that also implement SocketConnectable, making it easy to connect to a remote host/service.

Since glibmm 2.24:

Constructor & Destructor Documentation

virtual Gio::Resolver::~Resolver ( )
virtual

Member Function Documentation

static Glib::RefPtr<Resolver> Gio::Resolver::get_default ( )
static
static GType Gio::Resolver::get_type ( )
static

Get the GType for this class, for use with the underlying GObject type system.

GResolver* Gio::Resolver::gobj ( )
inline

Provides access to the underlying C GObject.

Reimplemented from Glib::ObjectBase.

const GResolver* Gio::Resolver::gobj ( ) const
inline

Provides access to the underlying C GObject.

Reimplemented from Glib::ObjectBase.

GResolver* Gio::Resolver::gobj_copy ( )

Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.

Glib::ustring Gio::Resolver::lookup_by_address ( const Glib::RefPtr< InetAddress >&  address,
const Glib::RefPtr< Cancellable >&  cancellable 
)

Synchronously reverse-resolves address to determine its associated hostname.

If the DNS resolution fails, error (if non-0) will be set to a value from ResolverError.

If cancellable is non-0, it can be used to cancel the operation, in which case error (if non-0) will be set to IO_ERROR_CANCELLED.

Since glibmm 2.22:
Parameters:
addressThe address to reverse-resolve.
cancellableA Cancellable, or 0.
Returns:
A hostname (either ASCII-only, or in ASCII-encoded form), or 0 on error.
Glib::ustring Gio::Resolver::lookup_by_address ( const Glib::RefPtr< InetAddress >&  address)

A lookup_by_address() convenience overload.

void Gio::Resolver::lookup_by_address_async ( const Glib::RefPtr< InetAddress >&  address,
const SlotAsyncReady slot,
const Glib::RefPtr< Cancellable >&  cancellable 
)

Begins asynchronously reverse-resolving an address to determine its associated hostname, and eventually calls callback, which must call lookup_by_address_finish() to get the final result.

Parameters:
addressThe address to reverse-resolve.
hostnamehostname The hostname to look up.
slotA callback slot to call after the resolution completes.
cancellableA Cancellable object which can be used to cancel the operation.
void Gio::Resolver::lookup_by_address_async ( const Glib::RefPtr< InetAddress >&  address,
const SlotAsyncReady slot 
)

Begins asynchronously reverse-resolving an address to determine its associated hostname, and eventually calls callback, which must call lookup_by_address_finish() to get the final result.

Parameters:
addressThe address to reverse-resolve.
hostnamehostname The hostname to look up.
slotA callback slot to call after the resolution completes.
Glib::ustring Gio::Resolver::lookup_by_address_finish ( const Glib::RefPtr< AsyncResult >&  result)

Retrieves the result of a previous call to g_resolver_lookup_by_address_async().

If the DNS resolution failed, error (if non-0) will be set to a value from ResolverError. If the operation was cancelled, error will be set to IO_ERROR_CANCELLED.

Since glibmm 2.22:
Parameters:
resultThe result passed to your AsyncReadyCallback.
Returns:
A hostname (either ASCII-only, or in ASCII-encoded form), or 0 on error.
Glib::ListHandle< Glib::RefPtr<InetAddress> > Gio::Resolver::lookup_by_name ( const Glib::ustring hostname,
const Glib::RefPtr< Cancellable >&  cancellable 
)

Synchronously resolves hostname to determine its associated IP address(es).

hostname may be an ASCII-only or UTF-8 hostname, or the textual form of an IP address (in which case this just becomes a wrapper around g_inet_address_new_from_string()).

On success, g_resolver_lookup_by_name() will return a List of InetAddress, sorted in order of preference and guaranteed to not contain duplicates. That is, if using the result to connect to hostname, you should attempt to connect to the first address first, then the second if the first fails, etc. If you are using the result to listen on a socket, it is appropriate to add each result using e.g. g_socket_listener_add_address().

If the DNS resolution fails, error (if non-0) will be set to a value from ResolverError.

If cancellable is non-0, it can be used to cancel the operation, in which case error (if non-0) will be set to IO_ERROR_CANCELLED.

If you are planning to connect to a socket on the resolved IP address, it may be easier to create a NetworkAddress and use its SocketConnectable interface.

Since glibmm 2.22:
Parameters:
hostnameThe hostname to look up.
cancellableA Cancellable, or 0.
Returns:
A List of InetAddress, or 0 on error. You must unref each of the addresses and free the list when you are done with it. (You can use g_resolver_free_addresses() to do this.).
Glib::ListHandle< Glib::RefPtr<InetAddress> > Gio::Resolver::lookup_by_name ( const Glib::ustring hostname)

A lookup_by_name() convenience overload.

void Gio::Resolver::lookup_by_name_async ( const Glib::ustring hostname,
const SlotAsyncReady slot,
const Glib::RefPtr< Cancellable >&  cancellable 
)

Begins asynchronously resolving hostname to determine its associated IP address(es), and eventually calls slot, which must call lookup_by_name_finish() to get the result.

See lookup_by_name() for more details.

@param hostname hostname The hostname to look up.
@param slot A callback slot to call after the resolution completes.
@param cancellable A Cancellable object which can be used to cancel the operation.
void Gio::Resolver::lookup_by_name_async ( const Glib::ustring hostname,
const SlotAsyncReady slot 
)

Begins asynchronously resolving hostname to determine its associated IP address(es), and eventually calls slot, which must call lookup_by_name_finish() to get the result.

See lookup_by_name() for more details.

@param hostname hostname The hostname to look up.
@param slot A callback slot to call after the resolution completes.
Glib::ListHandle< Glib::RefPtr<InetAddress> > Gio::Resolver::lookup_by_name_finish ( const Glib::RefPtr< AsyncResult >&  result)

Retrieves the result of a call to g_resolver_lookup_by_name_async().

If the DNS resolution failed, error (if non-0) will be set to a value from ResolverError. If the operation was cancelled, error will be set to IO_ERROR_CANCELLED.

Since glibmm 2.22:
Parameters:
resultThe result passed to your AsyncReadyCallback.
Returns:
A List of InetAddress, or 0 on error. See g_resolver_lookup_by_name() for more details.
ListHandle_SrvTarget Gio::Resolver::lookup_service ( const Glib::ustring service,
const Glib::ustring protocol,
const Glib::ustring domain,
const Glib::RefPtr< Cancellable >&  cancellable 
)

Synchronously performs a DNS SRV lookup for the given service and protocol in the given domain and returns an array of SrvTarget.

domain may be an ASCII-only or UTF-8 hostname. Note also that the service and protocol arguments do not include the leading underscore that appears in the actual DNS entry.

On success, g_resolver_lookup_service() will return a List of SrvTarget, sorted in order of preference. (That is, you should attempt to connect to the first target first, then the second if the first fails, etc.)

If the DNS resolution fails, error (if non-0) will be set to a value from ResolverError.

If cancellable is non-0, it can be used to cancel the operation, in which case error (if non-0) will be set to IO_ERROR_CANCELLED.

If you are planning to connect to the service, it is usually easier to create a NetworkService and use its SocketConnectable interface.

Since glibmm 2.22:
Parameters:
serviceThe service type to look up (eg, "ldap").
protocolThe networking protocol to use for service (eg, "tcp").
domainThe DNS domain to look up the service in.
cancellableA Cancellable, or 0.
Returns:
A List of SrvTarget, or 0 on error. You must free each of the targets and the list when you are done with it. (You can use g_resolver_free_targets() to do this.).
ListHandle_SrvTarget Gio::Resolver::lookup_service ( const Glib::ustring service,
const Glib::ustring protocol,
const Glib::ustring domain 
)

A lookup_service() convenience overload.

void Gio::Resolver::lookup_service_async ( const Glib::ustring service,
const Glib::ustring protocol,
const Glib::ustring domain,
const SlotAsyncReady slot,
const Glib::RefPtr< Cancellable >&  cancellable 
)

Begins asynchronously performing a DNS SRV lookup for the given service and protocol in the given domain, and eventually calls callback, which must call lookup_service_finish() to get the final result.

See glookup_service() for more details.

@param service The service type to look up (eg, "ldap").
@param protocol The networking protocol to use for service (eg, "tcp") @param domain The DNS domain to look up the service in.
@param slot A callback slot to call after the resolution completes.
@param cancellable A Cancellable object which can be used to cancel the operation.
void Gio::Resolver::lookup_service_async ( const Glib::ustring service,
const Glib::ustring protocol,
const Glib::ustring domain,
const SlotAsyncReady slot 
)

Begins asynchronously performing a DNS SRV lookup for the given service and protocol in the given domain, and eventually calls callback, which must call lookup_service_finish() to get the final result.

See glookup_service() for more details.

@param service The service type to look up (eg, "ldap").
@param protocol The networking protocol to use for service (eg, "tcp") @param domain The DNS domain to look up the service in.
@param slot A callback slot to call after the resolution completes.
ListHandle_SrvTarget Gio::Resolver::lookup_service_finish ( const Glib::RefPtr< AsyncResult >&  result)

Retrieves the result of a previous call to g_resolver_lookup_service_async().

If the DNS resolution failed, error (if non-0) will be set to a value from ResolverError. If the operation was cancelled, error will be set to IO_ERROR_CANCELLED.

Since glibmm 2.22:
Parameters:
resultThe result passed to your AsyncReadyCallback.
Returns:
A List of SrvTarget, or 0 on error. See g_resolver_lookup_service() for more details.
static void Gio::Resolver::set_default ( const Glib::RefPtr< Resolver >&  resolver)
static
Glib::SignalProxy0< void > Gio::Resolver::signal_reload ( )
Slot Prototype:
void on_my_reload()

Emitted when the resolver notices that the system resolver configuration has changed.


Friends And Related Function Documentation

Glib::RefPtr< Gio::Resolver > wrap ( GResolver *  object,
bool  take_copy = false 
)
related

A Glib::wrap() method for this object.

Parameters:
objectThe C instance.
take_copyFalse if the result should take ownership of the C instance. True if it should take a new copy or ref.
Returns:
A C++ instance that wraps this C instance.