glibmm: Gio::Resolver Class Reference

Asynchronous and cancellable DNS resolver. More...

#include </home/kjell/checkout/gnome/glibmm/gio/giomm/resolver.h>

Inheritance diagram for Gio::Resolver:

Public Types

- Public Types inherited from Glib::Object
using DestroyNotify = void(*)(gpointer data)
 
- Public Types inherited from sigc::trackable
typedef internal::func_destroy_notify func_destroy_notify
 
- Public Types inherited from sigc::notifiable
typedef internal::func_destroy_notify func_destroy_notify
 

Public Member Functions

 Resolver (Resolver&& src) noexcept
 
Resolveroperator= (Resolver&& src) noexcept
 
 ~Resolver () noexcept override
 
GResolver* gobj ()
 Provides access to the underlying C GObject. More...

 
const GResolver* gobj () const
 Provides access to the underlying C GObject. More...

 
GResolver* gobj_copy ()
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More...

 
std::vector< 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). More...

 
std::vector< Glib::RefPtr< InetAddress > > lookup_by_name (const Glib::ustring& hostname)
 A lookup_by_name() convenience overload. More...

 
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. More...

 
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. More...

 
std::vector< 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(). More...

 
Glib::ustring lookup_by_address (const Glib::RefPtr< InetAddress >& address, const Glib::RefPtr< Cancellable >& cancellable)
 Synchronously reverse-resolves address to determine its associated hostname. More...

 
Glib::ustring lookup_by_address (const Glib::RefPtr< InetAddress >& address)
 A lookup_by_address() convenience overload. More...

 
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. More...

 
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. More...

 
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(). More...

 
std::vector< SrvTargetlookup_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. More...

 
std::vector< SrvTargetlookup_service (const Glib::ustring& service, const Glib::ustring& protocol, const Glib::ustring& domain)
 A lookup_service() convenience overload. More...

 
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. More...

 
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. More...

 
std::vector< SrvTargetlookup_service_finish (const Glib::RefPtr< AsyncResult >& result)
 Retrieves the result of a previous call to g_resolver_lookup_service_async(). More...

 
std::vector< Glib::VariantContainerBaselookup_records (const Glib::ustring& rrname, RecordType record_type, const Glib::RefPtr< Cancellable >& cancellable)
 Synchronously performs a DNS record lookup for the given rrname and returns a list of records as Variant tuples. More...

 
std::vector< Glib::VariantContainerBaselookup_records (const Glib::ustring& rrname, RecordType record_type)
 A lookup_records() convenience overload. More...

 
void lookup_records_async (const Glib::ustring& rrname, RecordType record_type, const SlotAsyncReady& slot, const Glib::RefPtr< Cancellable >& cancellable)
 Begins asynchronously performing a DNS lookup for the given rrname, and eventually calls slot, which must call lookup_records_finish() to get the final result. More...

 
void lookup_records_async (const Glib::ustring& rrname, RecordType record_type, const SlotAsyncReady& slot)
 A non-cancellable version of lookup_records_async(). More...

 
std::vector< Glib::VariantContainerBaselookup_records_finish (const Glib::RefPtr< AsyncResult >& result)
 Retrieves the result of a previous call to g_resolver_lookup_records_async(). More...

 
Glib::SignalProxy< void()> signal_reload ()
 
- Public Member Functions inherited from Glib::Object
 Object (const Object&)=delete
 
Objectoperator= (const Object&)=delete
 
 Object (Object&& src) noexcept
 
Objectoperator= (Object&& src) noexcept
 
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
 ObjectBase (const ObjectBase&)=delete
 
ObjectBaseoperator= (const ObjectBase&)=delete
 
void set_property_value (const Glib::ustring& property_name, const Glib::ValueBase& value)
 You probably want to use a specific property_*() accessor method instead. More...

 
void get_property_value (const Glib::ustring& property_name, Glib::ValueBase& value) const
 You probably want to use a specific property_*() accessor method instead. More...

 
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. More...

 
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. More...

 
template<class PropertyType >
PropertyType get_property (const Glib::ustring& property_name) const
 You probably want to use a specific property_*() accessor method instead. More...

 
sigc::connection 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. More...

 
sigc::connection connect_property_changed (const Glib::ustring& property_name, sigc::slot< void()>&& slot)
 You can use the signal_changed() signal of the property proxy instead. More...

 
void freeze_notify ()
 Increases the freeze count on object. More...

 
void thaw_notify ()
 Reverts the effect of a previous call to freeze_notify(). More...

 
virtual void reference () const
 Increment the reference count for this object. More...

 
virtual void unreference () const
 Decrement the reference count for this object. More...

 
GObject* gobj ()
 Provides access to the underlying C GObject. More...

 
const GObject* gobj () const
 Provides access to the underlying C GObject. More...

 
GObject* gobj_copy () const
 Give a ref-ed copy to someone. Use for direct struct access. More...

 
- Public Member Functions inherited from sigc::trackable
 trackable () noexcept
 
 trackable (const trackable &src) noexcept
 
 trackable (trackable &&src) noexcept
 
 ~trackable ()
 
void add_destroy_notify_callback (notifiable *data, func_destroy_notify func) const
 
void notify_callbacks ()
 
trackableoperator= (const trackable &src)
 
trackableoperator= (trackable &&src) noexcept
 
void remove_destroy_notify_callback (notifiable *data) const
 

Static Public Member Functions

static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system. More...

 
static Glib::RefPtr< Resolverget_default ()
 
static void set_default (const Glib::RefPtr< Resolver >& resolver)
 

Protected Member Functions

virtual void on_reload ()
 This is a default handler for the signal signal_reload(). More...

 
- Protected Member Functions inherited from Glib::Object
 Object ()
 
 Object (const Glib::ConstructParams& construct_params)
 
 Object (GObject* castitem)
 
 ~Object () noexcept override
 
- 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. More...

 
 ObjectBase (const char* custom_type_name)
 A derived constructor always overrides this choice. More...

 
 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. More...

 
 ObjectBase (ObjectBase&& src) noexcept
 
ObjectBaseoperator= (ObjectBase&& src) noexcept
 
virtual ~ObjectBase () noexcept=0
 
void initialize (GObject* castitem)
 
void initialize_move (GObject* castitem, Glib::ObjectBase* previous_wrapper)
 

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. More...

 

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

Gio::Resolver::Resolver ( Resolver&&  src)
noexcept
Gio::Resolver::~Resolver ( )
overridenoexcept

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.

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

Provides access to the underlying C GObject.

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-nullptr) will be set to a value from ResolverError.

If cancellable is non-nullptr, it can be used to cancel the operation, in which case error (if non-nullptr) will be set to Gio::Error::CANCELLED.

Since glibmm 2.22:
Parameters
addressThe address to reverse-resolve.
cancellableA Cancellable, or nullptr.
Returns
A hostname (either ASCII-only, or in ASCII-encoded form), or nullptr on error.
Exceptions
Glib::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.
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.
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-nullptr) will be set to a value from ResolverError. If the operation was cancelled, error will be set to Gio::Error::CANCELLED.

Since glibmm 2.22:
Parameters
resultThe result passed to your SlotAsyncReady.
Returns
A hostname (either ASCII-only, or in ASCII-encoded form), or nullptr on error.
Exceptions
Glib::Error
std::vector<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 non-empty 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-nullptr) will be set to a value from ResolverError and nullptr will be returned.

If cancellable is non-nullptr, it can be used to cancel the operation, in which case error (if non-nullptr) will be set to Gio::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 nullptr.
Returns
A non-empty List of InetAddress, or nullptr 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.).
Exceptions
Glib::Error
std::vector<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.

Parameters
hostnameThe 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_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.

Parameters
hostnameThe hostname to look up.
slotA callback slot to call after the resolution completes.
std::vector<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-nullptr) will be set to a value from ResolverError. If the operation was cancelled, error will be set to Gio::Error::CANCELLED.

Since glibmm 2.22:
Parameters
resultThe result passed to your SlotAsyncReady.
Returns
A List of InetAddress, or nullptr on error. See g_resolver_lookup_by_name() for more details.
Exceptions
Glib::Error
std::vector<Glib::VariantContainerBase> Gio::Resolver::lookup_records ( const Glib::ustring rrname,
RecordType  record_type,
const Glib::RefPtr< Cancellable >&  cancellable 
)

Synchronously performs a DNS record lookup for the given rrname and returns a list of records as Variant tuples.

See Gio::Resolver::RecordType for information on what the records contain for each record_type.

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

If cancellable is non-nullptr, it can be used to cancel the operation, in which case error (if non-nullptr) will be set to Gio::Error::CANCELLED.

Since glibmm 2.34:
Parameters
rrnameThe DNS name to lookup the record for.
record_typeThe type of DNS record to lookup.
cancellableA Cancellable, or nullptr.
Returns
A non-empty List of Variant, or nullptr on error. You must free each of the records and the list when you are done with it. (You can use Glib::list_free_full() with Glib::variant_unref() to do this.).
Exceptions
Glib::Error
std::vector<Glib::VariantContainerBase> Gio::Resolver::lookup_records ( const Glib::ustring rrname,
RecordType  record_type 
)

A lookup_records() convenience overload.

void Gio::Resolver::lookup_records_async ( const Glib::ustring rrname,
RecordType  record_type,
const SlotAsyncReady slot,
const Glib::RefPtr< Cancellable >&  cancellable 
)

Begins asynchronously performing a DNS lookup for the given rrname, and eventually calls slot, which must call lookup_records_finish() to get the final result.

See lookup_records() for more details.

Parameters
rrnameThe DNS name to lookup the record for.
record_typeThe type of DNS record to lookup.
cancellableA Cancellable.
slotThe slot to call after the resolution completes.
Since glibmm 2.36:
void Gio::Resolver::lookup_records_async ( const Glib::ustring rrname,
RecordType  record_type,
const SlotAsyncReady slot 
)

A non-cancellable version of lookup_records_async().

std::vector<Glib::VariantContainerBase> Gio::Resolver::lookup_records_finish ( const Glib::RefPtr< AsyncResult >&  result)

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

Returns a non-empty list of records as Variant tuples. See Gio::Resolver::RecordType for information on what the records contain.

If the DNS resolution failed, error (if non-nullptr) will be set to a value from ResolverError. If the operation was cancelled, error will be set to Gio::Error::CANCELLED.

Since glibmm 2.34:
Parameters
resultThe result passed to your SlotAsyncReady.
Returns
A non-empty List of Variant, or nullptr on error. You must free each of the records and the list when you are done with it. (You can use Glib::list_free_full() with Glib::variant_unref() to do this.).
Exceptions
Glib::Error
std::vector<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 non-empty 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-nullptr) will be set to a value from ResolverError and nullptr will be returned.

If cancellable is non-nullptr, it can be used to cancel the operation, in which case error (if non-nullptr) will be set to Gio::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 nullptr.
Returns
A non-empty List of SrvTarget, or nullptr 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.).
Exceptions
Glib::Error
std::vector<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.

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.
slotA callback slot to call after the resolution completes.
cancellableA 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.

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.
slotA callback slot to call after the resolution completes.
std::vector<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-nullptr) will be set to a value from ResolverError. If the operation was cancelled, error will be set to Gio::Error::CANCELLED.

Since glibmm 2.22:
Parameters
resultThe result passed to your SlotAsyncReady.
Returns
A non-empty List of SrvTarget, or nullptr on error. See g_resolver_lookup_service() for more details.
Exceptions
Glib::Error
virtual void Gio::Resolver::on_reload ( )
protectedvirtual

This is a default handler for the signal signal_reload().

Resolver& Gio::Resolver::operator= ( Resolver&&  src)
noexcept
static void Gio::Resolver::set_default ( const Glib::RefPtr< Resolver >&  resolver)
static
Glib::SignalProxy<void()> Gio::Resolver::signal_reload ( )
Slot Prototype:
void on_my_reload()

Flags: Run Last

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.