glibmm 2.90.0
Gio::NetworkAddress Class Reference

A SocketConnectable for resolving hostnames. More...

#include <giomm/networkaddress.h>

Inheritance diagram for Gio::NetworkAddress:

Public Member Functions

 NetworkAddress (NetworkAddress&& src) noexcept
NetworkAddress& operator= (NetworkAddress&& src) noexcept
 ~NetworkAddress () noexcept override
GNetworkAddress* gobj ()
 Provides access to the underlying C GObject.
const GNetworkAddress* gobj () const
 Provides access to the underlying C GObject.
GNetworkAddress* gobj_copy ()
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
std::string get_hostname () const
 Gets addr's hostname.
guint16 get_port () const
 Gets addr's port number.
std::string get_scheme () const
 Gets addr's scheme.
Glib::PropertyProxy_ReadOnly< std::string > property_hostname () const
 Hostname to resolve.
Glib::PropertyProxy_ReadOnly< guint > property_port () const
 Network port.
Glib::PropertyProxy_ReadOnly< std::string > property_scheme () const
 URI scheme.
Public Member Functions inherited from Glib::Object
 Object (const Object&)=delete
Object& operator= (const Object&)=delete
 Object (Object&& src) noexcept
Object& operator= (Object&& src) noexcept
void* get_data (const QueryQuark& key)
void set_data (const Quark& key, void*data)
void set_data_with_c_callback (const Quark& key, void*data, GDestroyNotify notify)
void set_data (const Quark& key, void*data, DestroyNotify notify)
 Prefer set_data_with_c_callback() with a callback with C linkage.
void remove_data (const QueryQuark& quark)
void* steal_data (const QueryQuark& quark)
Public Member Functions inherited from Glib::ObjectBase
 ObjectBase (const ObjectBase&)=delete
ObjectBase& operator= (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.
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.
template<class PropertyType>
PropertyType get_property (const Glib::ustring& property_name) const
 You probably want to use a specific property_*() accessor method instead.
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.
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.
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 ()
 Provides access to the underlying C GObject.
const GObject* gobj () const
 Provides access to the underlying C GObject.
GObject* gobj_copy () const
 Give a ref-ed copy to someone. Use for direct struct access.
Public Member Functions inherited from Gio::SocketConnectable
 SocketConnectable (SocketConnectable&& src) noexcept
SocketConnectable& operator= (SocketConnectable&& src) noexcept
 ~SocketConnectable () noexcept override
GSocketConnectable* gobj ()
 Provides access to the underlying C GObject.
const GSocketConnectable* gobj () const
 Provides access to the underlying C GObject.
Glib::RefPtr< SocketAddressEnumerator > enumerate ()
 Creates a SocketAddressEnumerator for connectable.
Glib::RefPtr< const SocketAddressEnumerator > enumerate () const
 Creates a SocketAddressEnumerator for connectable.
Glib::RefPtr< SocketAddressEnumerator > proxy_enumerate ()
 Creates a SocketAddressEnumerator for connectable that will return a ProxyAddress for each of its addresses that you must connect to via a proxy.
Glib::RefPtr< const SocketAddressEnumerator > proxy_enumerate () const
 Creates a SocketAddressEnumerator for connectable that will return a ProxyAddress for each of its addresses that you must connect to via a proxy.
Glib::ustring to_string () const
 Format a SocketConnectable as a string.
Public Member Functions inherited from Glib::Interface
 Interface ()
 A Default constructor.
 Interface (Interface&& src) noexcept
Interface& operator= (Interface&& src) noexcept
 Interface (const Glib::Interface_Class& interface_class)
 Called by constructors of derived classes.
 Interface (GObject* castitem)
 Called by constructors of derived classes.
 ~Interface () noexcept override
 Interface (const Interface&)=delete
Interface& operator= (const Interface&)=delete
GObject* gobj ()
const GObject* gobj () const

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< NetworkAddress > create (const std::string& hostname, guint16 port)
static Glib::RefPtr< NetworkAddress > parse (const std::string& host_and_port, guint16 default_port)
Static Public Member Functions inherited from Gio::SocketConnectable
static void add_interface (GType gtype_implementer)
static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system.

(Note that these are not member symbols.)

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

Additional Inherited Members

Public Types inherited from Glib::Object
using DestroyNotify = void (*)(gpointer data)
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.
 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.
 ObjectBase (ObjectBase&& src) noexcept
ObjectBase& operator= (ObjectBase&& src) noexcept
virtual ~ObjectBase () noexcept=0
void initialize (GObject* castitem)
void initialize_move (GObject* castitem, Glib::ObjectBase* previous_wrapper)
Protected Member Functions inherited from Gio::SocketConnectable
 SocketConnectable ()
 You should derive from this class to use it.

Detailed Description

A SocketConnectable for resolving hostnames.

NetworkAddress provides an easy way to resolve a hostname and then attempt to connect to that host, handling the possibility of multiple IP addresses and multiple address families.

Since glibmm 2.24

Constructor & Destructor Documentation

◆ NetworkAddress()

Gio::NetworkAddress::NetworkAddress ( NetworkAddress&& src)
noexcept

◆ ~NetworkAddress()

Gio::NetworkAddress::~NetworkAddress ( )
overridenoexcept

Member Function Documentation

◆ create()

Glib::RefPtr< NetworkAddress > Gio::NetworkAddress::create ( const std::string & hostname,
guint16 port )
static

◆ get_hostname()

std::string Gio::NetworkAddress::get_hostname ( ) const

Gets addr's hostname.

This might be either UTF-8 or ASCII-encoded, depending on what addr was created with.

Since glibmm 2.22
Returns
addr's hostname.

◆ get_port()

guint16 Gio::NetworkAddress::get_port ( ) const

Gets addr's port number.

Since glibmm 2.22
Returns
addr's port (which may be 0).

◆ get_scheme()

std::string Gio::NetworkAddress::get_scheme ( ) const

Gets addr's scheme.

Since glibmm 2.26
Returns
addr's scheme (nullptr if not built from URI).

◆ get_type()

GType Gio::NetworkAddress::get_type ( )
static

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

◆ gobj() [1/2]

GNetworkAddress * Gio::NetworkAddress::gobj ( )
inline

Provides access to the underlying C GObject.

◆ gobj() [2/2]

const GNetworkAddress * Gio::NetworkAddress::gobj ( ) const
inline

Provides access to the underlying C GObject.

◆ gobj_copy()

GNetworkAddress * Gio::NetworkAddress::gobj_copy ( )

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

◆ operator=()

NetworkAddress& Gio::NetworkAddress::operator= ( NetworkAddress&& src)
noexcept

◆ parse()

Glib::RefPtr< NetworkAddress > Gio::NetworkAddress::parse ( const std::string & host_and_port,
guint16 default_port )
static

◆ property_hostname()

Glib::PropertyProxy_ReadOnly< std::string > Gio::NetworkAddress::property_hostname ( ) const

Hostname to resolve.

Since glibmm 2.22

Default value: ""

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ property_port()

Glib::PropertyProxy_ReadOnly< guint > Gio::NetworkAddress::property_port ( ) const

Network port.

Since glibmm 2.22

Default value: 0

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ property_scheme()

Glib::PropertyProxy_ReadOnly< std::string > Gio::NetworkAddress::property_scheme ( ) const

URI scheme.

Since glibmm 2.22

Default value: ""

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ wrap()

Glib::RefPtr< Gio::NetworkAddress > wrap ( GNetworkAddress * 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.