glibmm  2.42.0
Public Member Functions | Static Public Member Functions | Related Functions | List of all members
Gio::NetworkAddress Class Reference

A SocketConnectable for resolving hostnames. More...

#include <giomm/networkaddress.h>

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

Public Member Functions

virtual ~NetworkAddress ()
 
GNetworkAddress* gobj ()
 Provides access to the underlying C GObject. More...
 
const GNetworkAddress* gobj () const
 Provides access to the underlying C GObject. More...
 
GNetworkAddress* 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::string get_hostname () const
 Gets addr's hostname. More...
 
guint16 get_port () const
 Gets addr's port number. More...
 
std::string get_scheme () const
 Gets addr's scheme. More...
 
Glib::PropertyProxy_ReadOnly
< std::string
property_hostname () const
 Hostname to resolve. More...
 
Glib::PropertyProxy_ReadOnly
< guint > 
property_port () const
 Network port. More...
 
Glib::PropertyProxy_ReadOnly
< std::string
property_scheme () const
 URI Scheme. More...
 
- 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. 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...
 
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. More...
 
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. 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 Gio::SocketConnectable
virtual ~SocketConnectable ()
 
GSocketConnectable* gobj ()
 Provides access to the underlying C GObject. More...
 
const GSocketConnectable* gobj () const
 Provides access to the underlying C GObject. More...
 
Glib::RefPtr
< SocketAddressEnumerator
enumerate ()
 Creates a SocketAddressEnumerator for connectable. More...
 
Glib::RefPtr< const
SocketAddressEnumerator
enumerate () const
 Creates a SocketAddressEnumerator for connectable. More...
 
Glib::RefPtr
< SocketAddressEnumerator
proxy_enumerate ()
 Creates a SocketAddressEnumerator for connectable that will return ProxyAddresses for addresses that you must connect to via a proxy. More...
 
Glib::RefPtr< const
SocketAddressEnumerator
proxy_enumerate () const
 Creates a SocketAddressEnumerator for connectable that will return ProxyAddresses for addresses that you must connect to via a proxy. More...
 
- Public Member Functions inherited from Glib::Interface
 Interface ()
 A Default constructor. More...
 
 Interface (const Glib::Interface_Class& interface_class)
 Called by constructors of derived classes. More...
 
 Interface (GObject* castitem)
 Called by constructors of derived classes. More...
 
virtual ~Interface ()
 
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. More...
 
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. More...
 

Related Functions

(Note that these are not member functions.)

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

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. 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...
 
virtual ~ObjectBase ()=0
 
void initialize (GObject* castitem)
 
- Protected Member Functions inherited from Gio::SocketConnectable
 SocketConnectable ()
 You should derive from this class to use it. More...
 

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

virtual Gio::NetworkAddress::~NetworkAddress ( )
virtual

Member Function Documentation

static Glib::RefPtr<NetworkAddress> Gio::NetworkAddress::create ( const std::string hostname,
guint16  port 
)
static
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.
guint16 Gio::NetworkAddress::get_port ( ) const

Gets addr's port number.

Since glibmm 2.22:
Returns
addr's port (which may be 0).
std::string Gio::NetworkAddress::get_scheme ( ) const

Gets addr's scheme.

Since glibmm 2.26:
Returns
addr's scheme (0 if not built from URI).
static GType Gio::NetworkAddress::get_type ( )
static

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

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

Provides access to the underlying C GObject.

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

Provides access to the underlying C GObject.

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.

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

Hostname to resolve.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< guint > Gio::NetworkAddress::property_port ( ) const

Network port.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< std::string > Gio::NetworkAddress::property_scheme ( ) const

URI Scheme.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

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

Friends And Related Function Documentation

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.