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

ProxyAddress - An internet address with proxy information. More...

#include <giomm/proxyaddress.h>

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

Public Member Functions

virtual ~ProxyAddress ()
 
GProxyAddress* gobj ()
 Provides access to the underlying C GObject. More...
 
const GProxyAddress* gobj () const
 Provides access to the underlying C GObject. More...
 
GProxyAddress* gobj_copy ()
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More...
 
Glib::ustring get_protocol () const
 Gets proxy's protocol. More...
 
Glib::ustring get_destination_protocol () const
 Gets the protocol that is being spoken to the destination server; eg, "http" or "ftp". More...
 
Glib::ustring get_destination_hostname () const
 Gets proxy's destination hostname; that is, the name of the host that will be connected to via the proxy, not the name of the proxy itself. More...
 
guint16 get_destination_port () const
 Gets proxy's destination port; that is, the port on the destination host that will be connected to via the proxy, not the port number of the proxy itself. More...
 
Glib::ustring get_username () const
 Gets proxy's username. More...
 
Glib::ustring get_password () const
 Gets proxy's password. More...
 
Glib::ustring get_uri () const
 Gets the proxy URI that proxy was constructed from. More...
 
Glib::PropertyProxy_ReadOnly
< Glib::ustring
property_protocol () const
 The proxy protocol. More...
 
Glib::PropertyProxy_ReadOnly
< Glib::ustring
property_destination_protocol () const
 The proxy destination protocol. More...
 
Glib::PropertyProxy_ReadOnly
< Glib::ustring
property_destination_hostname () const
 The proxy destination hostname. More...
 
Glib::PropertyProxy_ReadOnly
< Glib::ustring
property_destination_port () const
 The proxy destination port. More...
 
Glib::PropertyProxy_ReadOnly
< Glib::ustring
property_username () const
 The proxy username. More...
 
Glib::PropertyProxy_ReadOnly
< Glib::ustring
property_password () const
 The proxy password. More...
 
Glib::PropertyProxy_ReadOnly
< Glib::ustring
property_uri () const
 The proxy's URI. More...
 
- Public Member Functions inherited from Gio::InetSocketAddress
virtual ~InetSocketAddress ()
 
GInetSocketAddress* gobj ()
 Provides access to the underlying C GObject. More...
 
const GInetSocketAddress* gobj () const
 Provides access to the underlying C GObject. More...
 
GInetSocketAddress* gobj_copy ()
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More...
 
Glib::RefPtr< InetAddressget_address ()
 Gets address's InetAddress. More...
 
Glib::RefPtr< const InetAddressget_address () const
 Gets address's InetAddress. More...
 
guint16 get_port () const
 Gets address's port. More...
 
guint32 get_flowinfo () const
 Gets the sin6_flowinfo field from address, which must be an IPv6 address. More...
 
guint32 get_scope_id () const
 Gets the sin6_scope_id field from address, which must be an IPv6 address. More...
 
Glib::PropertyProxy_ReadOnly
< Glib::RefPtr< InetAddress > > 
property_address () const
 The address. More...
 
Glib::PropertyProxy_ReadOnly
< guint16 > 
property_port () const
 The port. More...
 
Glib::PropertyProxy_ReadOnly
< guint32 > 
property_flowinfo () const
 IPv6 flow info. More...
 
Glib::PropertyProxy_ReadOnly
< guint32 > 
property_scope_id () const
 IPv6 scope ID. More...
 
- Public Member Functions inherited from Gio::SocketAddress
virtual ~SocketAddress ()
 
GSocketAddress* gobj ()
 Provides access to the underlying C GObject. More...
 
const GSocketAddress* gobj () const
 Provides access to the underlying C GObject. More...
 
GSocketAddress* gobj_copy ()
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More...
 
SocketFamily get_family () const
 Gets the socket family type of address. More...
 
bool to_native (gpointer dest, gsize destlen)
 Converts a SocketAddress to a native struct sockaddr, which can be passed to low-level functions like connect() or bind(). More...
 
gssize get_native_size () const
 Gets the size of address's native struct sockaddr. More...
 
Glib::PropertyProxy_ReadOnly
< Glib::RefPtr< SocketFamily > > 
property_family () const
 The family of the socket address. 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< ProxyAddresscreate (const Glib::RefPtr< InetAddress >& address, guint16 port, const Glib::ustring& protocol, const Glib::ustring& destination_hostname, guint16 destination_port, const Glib::ustring& username=Glib::ustring(), const Glib::ustring& password=Glib::ustring())
 
- Static Public Member Functions inherited from Gio::InetSocketAddress
static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system. More...
 
static Glib::RefPtr
< InetSocketAddress
create (const Glib::RefPtr< InetAddress >& address, guint16 port)
 
- Static Public Member Functions inherited from Gio::SocketAddress
static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system. More...
 
static Glib::RefPtr
< SocketAddress
create (gpointer native, gsize len)
 
- 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...
 

Protected Member Functions

 ProxyAddress (const Glib::RefPtr< InetAddress >& address, guint16 port, const Glib::ustring& protocol, const Glib::ustring& destination_hostname, guint16 destination_port, const Glib::ustring& username=Glib::ustring(), const Glib::ustring& password=Glib::ustring())
 
- Protected Member Functions inherited from Gio::InetSocketAddress
 InetSocketAddress (const Glib::RefPtr< InetAddress >& address, guint16 port)
 
- 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...
 

Related Functions

(Note that these are not member functions.)

Glib::RefPtr< Gio::ProxyAddresswrap (GProxyAddress* 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)
 

Detailed Description

ProxyAddress - An internet address with proxy information.

Support for proxied InetSocketAddress.

Since glibmm 2.28:

Constructor & Destructor Documentation

virtual Gio::ProxyAddress::~ProxyAddress ( )
virtual
Gio::ProxyAddress::ProxyAddress ( const Glib::RefPtr< InetAddress >&  address,
guint16  port,
const Glib::ustring protocol,
const Glib::ustring destination_hostname,
guint16  destination_port,
const Glib::ustring username = Glib::ustring(),
const Glib::ustring password = Glib::ustring() 
)
explicitprotected

Member Function Documentation

static Glib::RefPtr<ProxyAddress> Gio::ProxyAddress::create ( const Glib::RefPtr< InetAddress >&  address,
guint16  port,
const Glib::ustring protocol,
const Glib::ustring destination_hostname,
guint16  destination_port,
const Glib::ustring username = Glib::ustring(),
const Glib::ustring password = Glib::ustring() 
)
static
Glib::ustring Gio::ProxyAddress::get_destination_hostname ( ) const

Gets proxy's destination hostname; that is, the name of the host that will be connected to via the proxy, not the name of the proxy itself.

Since glibmm 2.26:
Returns
The proxy's destination hostname.
guint16 Gio::ProxyAddress::get_destination_port ( ) const

Gets proxy's destination port; that is, the port on the destination host that will be connected to via the proxy, not the port number of the proxy itself.

Since glibmm 2.26:
Returns
The proxy's destination port.
Glib::ustring Gio::ProxyAddress::get_destination_protocol ( ) const

Gets the protocol that is being spoken to the destination server; eg, "http" or "ftp".

Since glibmm 2.34:
Returns
The proxy's destination protocol.
Glib::ustring Gio::ProxyAddress::get_password ( ) const

Gets proxy's password.

Since glibmm 2.26:
Returns
The proxy's password.
Glib::ustring Gio::ProxyAddress::get_protocol ( ) const

Gets proxy's protocol.

eg, "socks" or "http"

Since glibmm 2.26:
Returns
The proxy's protocol.
static GType Gio::ProxyAddress::get_type ( )
static

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

Glib::ustring Gio::ProxyAddress::get_uri ( ) const

Gets the proxy URI that proxy was constructed from.

Since glibmm 2.34:
Returns
The proxy's URI, or 0 if unknown.
Glib::ustring Gio::ProxyAddress::get_username ( ) const

Gets proxy's username.

Since glibmm 2.26:
Returns
The proxy's username.
GProxyAddress* Gio::ProxyAddress::gobj ( )
inline

Provides access to the underlying C GObject.

const GProxyAddress* Gio::ProxyAddress::gobj ( ) const
inline

Provides access to the underlying C GObject.

GProxyAddress* Gio::ProxyAddress::gobj_copy ( )

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

Glib::PropertyProxy_ReadOnly< Glib::ustring > Gio::ProxyAddress::property_destination_hostname ( ) const

The proxy destination hostname.

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< Glib::ustring > Gio::ProxyAddress::property_destination_port ( ) const

The proxy destination 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< Glib::ustring > Gio::ProxyAddress::property_destination_protocol ( ) const

The proxy destination protocol.

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< Glib::ustring > Gio::ProxyAddress::property_password ( ) const

The proxy password.

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< Glib::ustring > Gio::ProxyAddress::property_protocol ( ) const

The proxy protocol.

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< Glib::ustring > Gio::ProxyAddress::property_uri ( ) const

The proxy's URI.

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< Glib::ustring > Gio::ProxyAddress::property_username ( ) const

The proxy username.

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::ProxyAddress > wrap ( GProxyAddress *  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.