/usr/include/giomm-2.4/giomm/resolver.h is in libglibmm-2.4-dev 2.42.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 | // -*- c++ -*-
// Generated by gmmproc 2.42.0 -- DO NOT MODIFY!
#ifndef _GIOMM_RESOLVER_H
#define _GIOMM_RESOLVER_H
#include <glibmm/ustring.h>
#include <sigc++/sigc++.h>
// -*- Mode: C++; indent-tabs-mode: nil; c-basic-offset: 2 -*-
/* Copyright (C) 2009 jonathon jongsma
*
* 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 2.1 of the License, or (at your option) any later version.
*
* This library 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, write to the Free
* Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
#include <glibmm/object.h>
#include <giomm/inetaddress.h>
#include <giomm/cancellable.h>
#include <giomm/srvtarget.h>
#include <giomm/asyncresult.h>
// Forward declarations for classes in the Glib namespace.
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef struct _GResolver GResolver;
typedef struct _GResolverClass GResolverClass;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
namespace Gio
{ class Resolver_Class; } // namespace Gio
namespace Glib
{
class VariantContainerBase;
}
namespace Gio
{
/** @addtogroup giommEnums giomm Enums and Flags */
/**
* @var ResolverRecordType RESOLVER_RECORD_SRV
* Lookup DNS SRV records for a domain.
*
* @var ResolverRecordType RESOLVER_RECORD_MX
* Lookup DNS MX records for a domain.
*
* @var ResolverRecordType RESOLVER_RECORD_TXT
* Lookup DNS TXT records for a name.
*
* @var ResolverRecordType RESOLVER_RECORD_SOA
* Lookup DNS SOA records for a zone.
*
* @var ResolverRecordType RESOLVER_RECORD_NS
* Lookup DNS NS records for a domain.
*
* @enum ResolverRecordType
*
* The type of record that g_resolver_lookup_records() or
* g_resolver_lookup_records_async() should retrieve. The records are returned
* as lists of Variant tuples. Each record type has different values in
* the variant tuples returned.
*
* RESOLVER_RECORD_SRV records are returned as variants with the signature
* '(qqqs)', containing a guint16 with the priority, a guint16 with the
* weight, a guint16 with the port, and a string of the hostname.
*
* RESOLVER_RECORD_MX records are returned as variants with the signature
* '(qs)', representing a guint16 with the preference, and a string containing
* the mail exchanger hostname.
*
* RESOLVER_RECORD_TXT records are returned as variants with the signature
* '(as)', representing an array of the strings in the text record.
*
* RESOLVER_RECORD_SOA records are returned as variants with the signature
* '(ssuuuuu)', representing a string containing the primary name server, a
* string containing the administrator, the serial as a guint32, the refresh
* interval as guint32, the retry interval as a guint32, the expire timeout
* as a guint32, and the ttl as a guint32.
*
* RESOLVER_RECORD_NS records are returned as variants with the signature
* '(s)', representing a string of the hostname of the name server.
*
* @newin{2,34}
* @ingroup giommEnums
*/
enum ResolverRecordType
{
RESOLVER_RECORD_SRV = 1,
RESOLVER_RECORD_MX,
RESOLVER_RECORD_TXT,
RESOLVER_RECORD_SOA,
RESOLVER_RECORD_NS
};
} // namespace Gio
#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace Glib
{
template <>
class Value<Gio::ResolverRecordType> : public Glib::Value_Enum<Gio::ResolverRecordType>
{
public:
static GType value_type() G_GNUC_CONST;
};
} // namespace Glib
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
namespace Gio
{
/** 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.
*
* @newin{2,24}
* @ingroup NetworkIO
*/
class Resolver
: public Glib::Object
{
#ifndef DOXYGEN_SHOULD_SKIP_THIS
public:
typedef Resolver CppObjectType;
typedef Resolver_Class CppClassType;
typedef GResolver BaseObjectType;
typedef GResolverClass BaseClassType;
private: friend class Resolver_Class;
static CppClassType resolver_class_;
private:
// noncopyable
Resolver(const Resolver&);
Resolver& operator=(const Resolver&);
protected:
explicit Resolver(const Glib::ConstructParams& construct_params);
explicit Resolver(GResolver* castitem);
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
public:
virtual ~Resolver();
/** Get the GType for this class, for use with the underlying GObject type system.
*/
static GType get_type() G_GNUC_CONST;
#ifndef DOXYGEN_SHOULD_SKIP_THIS
static GType get_base_type() G_GNUC_CONST;
#endif
///Provides access to the underlying C GObject.
GResolver* gobj() { return reinterpret_cast<GResolver*>(gobject_); }
///Provides access to the underlying C GObject.
const GResolver* gobj() const { return reinterpret_cast<GResolver*>(gobject_); }
///Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
GResolver* gobj_copy();
private:
protected:
public:
static Glib::RefPtr<Resolver> get_default();
static void set_default(const Glib::RefPtr<Resolver>& resolver);
// g_resolver_free_addresses is just a C convenience function
// g_resolver_get_serial() is private API.
/** Synchronously resolves @a hostname to determine its associated IP
* address(es). @a 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
* @a 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, @a error (if non-<tt>0</tt>) will be set to a
* value from ResolverError and <tt>0</tt> will be returned.
*
* If @a cancellable is non-<tt>0</tt>, it can be used to cancel the
* operation, in which case @a error (if non-<tt>0</tt>) 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.
*
* @newin{2,22}
*
* @param hostname The hostname to look up.
* @param cancellable A Cancellable, or <tt>0</tt>.
* @return A non-empty List
* of InetAddress, or <tt>0</tt> 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> > lookup_by_name(const Glib::ustring& hostname, const Glib::RefPtr<Cancellable>& cancellable);
/// A lookup_by_name() convenience overload.
Glib::ListHandle< Glib::RefPtr<InetAddress> > lookup_by_name(const Glib::ustring& hostname);
/** Begins asynchronously resolving hostname to determine its associated IP address(es), and eventually calls @a slot, which must call
* lookup_by_name_finish() to get the result. See lookup_by_name() for more details.
*
* @param 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 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 @a slot, which must call
* lookup_by_name_finish() to get the result. See lookup_by_name() for more details.
*
* @param hostname The hostname to look up.
* @param slot A callback slot to call after the resolution completes.
*/
void lookup_by_name_async(const Glib::ustring& hostname, const SlotAsyncReady& slot);
/** Retrieves the result of a call to
* g_resolver_lookup_by_name_async().
*
* If the DNS resolution failed, @a error (if non-<tt>0</tt>) will be set to
* a value from ResolverError. If the operation was cancelled,
* @a error will be set to IO_ERROR_CANCELLED.
*
* @newin{2,22}
*
* @param result The result passed to your SlotAsyncReady.
* @return A List
* of InetAddress, or <tt>0</tt> on error. See g_resolver_lookup_by_name()
* for more details.
*/
Glib::ListHandle< Glib::RefPtr<InetAddress> > lookup_by_name_finish(const Glib::RefPtr<AsyncResult>& result);
/** Synchronously reverse-resolves @a address to determine its
* associated hostname.
*
* If the DNS resolution fails, @a error (if non-<tt>0</tt>) will be set to
* a value from ResolverError.
*
* If @a cancellable is non-<tt>0</tt>, it can be used to cancel the
* operation, in which case @a error (if non-<tt>0</tt>) will be set to
* IO_ERROR_CANCELLED.
*
* @newin{2,22}
*
* @param address The address to reverse-resolve.
* @param cancellable A Cancellable, or <tt>0</tt>.
* @return A hostname (either ASCII-only, or in ASCII-encoded
* form), or <tt>0</tt> on error.
*/
Glib::ustring lookup_by_address(const Glib::RefPtr<InetAddress>& address, const Glib::RefPtr<Cancellable>& cancellable);
/// A lookup_by_address() convenience overload.
Glib::ustring lookup_by_address(const Glib::RefPtr<InetAddress>& address);
/** 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.
*
* @param address The address to reverse-resolve.
* @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 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.
*
* @param address The address to reverse-resolve.
* @param slot A callback slot to call after the resolution completes.
*/
void lookup_by_address_async(const Glib::RefPtr<InetAddress>& address, const SlotAsyncReady& slot);
/** Retrieves the result of a previous call to
* g_resolver_lookup_by_address_async().
*
* If the DNS resolution failed, @a error (if non-<tt>0</tt>) will be set to
* a value from ResolverError. If the operation was cancelled,
* @a error will be set to IO_ERROR_CANCELLED.
*
* @newin{2,22}
*
* @param result The result passed to your SlotAsyncReady.
* @return A hostname (either ASCII-only, or in ASCII-encoded
* form), or <tt>0</tt> on error.
*/
Glib::ustring lookup_by_address_finish(const Glib::RefPtr<AsyncResult>& result);
/** Synchronously performs a DNS SRV lookup for the given @a service and
* @a protocol in the given @a domain and returns an array of SrvTarget.
* @a domain may be an ASCII-only or UTF-8 hostname. Note also that the
* @a service and @a 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, @a error (if non-<tt>0</tt>) will be set to
* a value from ResolverError and <tt>0</tt> will be returned.
*
* If @a cancellable is non-<tt>0</tt>, it can be used to cancel the
* operation, in which case @a error (if non-<tt>0</tt>) 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.
*
* @newin{2,22}
*
* @param service The service type to look up (eg, "ldap").
* @param protocol The networking protocol to use for @a service (eg, "tcp").
* @param domain The DNS domain to look up the service in.
* @param cancellable A Cancellable, or <tt>0</tt>.
* @return A non-empty List of
* SrvTarget, or <tt>0</tt> 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 lookup_service(const Glib::ustring& service, const Glib::ustring& protocol, const Glib::ustring& domain, const Glib::RefPtr<Cancellable>& cancellable);
/// A lookup_service() convenience overload.
ListHandle_SrvTarget lookup_service(const Glib::ustring& service, const Glib::ustring& protocol, const Glib::ustring& domain);
/** 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 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.
*/
void lookup_service_async(const Glib::ustring& service, const Glib::ustring& protocol, const Glib::ustring& domain, const SlotAsyncReady& slot);
/** Retrieves the result of a previous call to
* g_resolver_lookup_service_async().
*
* If the DNS resolution failed, @a error (if non-<tt>0</tt>) will be set to
* a value from ResolverError. If the operation was cancelled,
* @a error will be set to IO_ERROR_CANCELLED.
*
* @newin{2,22}
*
* @param result The result passed to your SlotAsyncReady.
* @return A non-empty List of
* SrvTarget, or <tt>0</tt> on error. See g_resolver_lookup_service() for more
* details.
*/
ListHandle_SrvTarget lookup_service_finish(const Glib::RefPtr<AsyncResult>& result);
/** Synchronously performs a DNS record lookup for the given @a rrname and returns
* a list of records as Variant tuples. See ResolverRecordType for
* information on what the records contain for each @a record_type.
*
* If the DNS resolution fails, @a error (if non-<tt>0</tt>) will be set to
* a value from ResolverError and <tt>0</tt> will be returned.
*
* If @a cancellable is non-<tt>0</tt>, it can be used to cancel the
* operation, in which case @a error (if non-<tt>0</tt>) will be set to
* IO_ERROR_CANCELLED.
*
* @newin{2,34}
*
* @param rrname The DNS name to lookup the record for.
* @param record_type The type of DNS record to lookup.
* @param cancellable A Cancellable, or <tt>0</tt>.
* @return A non-empty List of
* Variant, or <tt>0</tt> 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.).
*/
std::vector<Glib::VariantContainerBase> lookup_records(const Glib::ustring& rrname, ResolverRecordType record_type, const Glib::RefPtr<Cancellable>& cancellable);
/// A lookup_records() convenience overload.
std::vector<Glib::VariantContainerBase> lookup_records(const Glib::ustring& rrname, ResolverRecordType record_type);
/** Begins asynchronously performing a DNS lookup for the given @a rrname,
* and eventually calls @a slot, which must call lookup_records_finish() to
* get the final result. See lookup_records() for more details.
*
* @param rrname The DNS name to lookup the record for.
* @param record_type The type of DNS record to lookup.
* @param cancellable A Cancellable.
* @param slot The slot to call after the resolution completes.
* @newin{2,36}
*/
void lookup_records_async(const Glib::ustring& rrname,
ResolverRecordType record_type, const SlotAsyncReady& slot,
const Glib::RefPtr<Cancellable>& cancellable);
/// A non-cancellable version of lookup_records_async().
void lookup_records_async(const Glib::ustring& rrname,
ResolverRecordType record_type, const SlotAsyncReady& slot);
/** Retrieves the result of a previous call to
* g_resolver_lookup_records_async(). Returns a non-empty list of records as
* Variant tuples. See ResolverRecordType for information on what the
* records contain.
*
* If the DNS resolution failed, @a error (if non-<tt>0</tt>) will be set to
* a value from ResolverError. If the operation was cancelled,
* @a error will be set to IO_ERROR_CANCELLED.
*
* @newin{2,34}
*
* @param result The result passed to your SlotAsyncReady.
* @return A non-empty List of
* Variant, or <tt>0</tt> 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.).
*/
std::vector<Glib::VariantContainerBase> lookup_records_finish(const Glib::RefPtr<AsyncResult>& result);
//TODO: Remove no_default_handler when we can break ABI:
/**
* @par Slot Prototype:
* <tt>void on_my_%reload()</tt>
*
* Emitted when the resolver notices that the system resolver
* configuration has changed.
*
*/
Glib::SignalProxy0< void > signal_reload();
public:
public:
//C++ methods used to invoke GTK+ virtual functions:
protected:
//GTK+ Virtual Functions (override these to change behaviour):
//Default Signal Handlers::
};
std::string hostname_to_ascii (const Glib::ustring& hostname);
Glib::ustring hostname_to_unicode (const Glib::ustring& hostname);
bool hostname_is_non_ascii (const Glib::ustring& hostname);
bool hostname_is_ascii_encoded (const Glib::ustring& hostname);
bool hostname_is_ip_address (const Glib::ustring& hostname);
} // namespace Gio
namespace Glib
{
/** A Glib::wrap() method for this object.
*
* @param object The C instance.
* @param take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref.
* @result A C++ instance that wraps this C instance.
*
* @relates Gio::Resolver
*/
Glib::RefPtr<Gio::Resolver> wrap(GResolver* object, bool take_copy = false);
}
#endif /* _GIOMM_RESOLVER_H */
|