glibmm: Gio::Proxy Class Reference

Proxy - Interface for proxy handling. More...

#include <giomm/proxy.h>

Inheritance diagram for Gio::Proxy:

Public Member Functions
virtual	~Proxy ()

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

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

Glib::RefPtr< IOStream >	connect (const Glib::RefPtr< IOStream >& connection, const Glib::RefPtr< const ProxyAddress >& proxy_address, const Glib::RefPtr< Cancellable >& cancellable)
	Given connection to communicate with a proxy (eg, a SocketConnection that is connected to the proxy server), this does the necessary handshake to connect to proxy_address, and if required, wraps the IOStream to handle proxy payload. More...

void	connect_async (const Glib::RefPtr< IOStream >& connection, const Glib::RefPtr< const ProxyAddress >& proxy_address, const SlotAsyncReady& slot, const Glib::RefPtr< Cancellable >& cancellable)
	An Asynchronous version of connect(). More...

void	connect_async (const Glib::RefPtr< IOStream >& connection, const Glib::RefPtr< const ProxyAddress >& proxy_address, const SlotAsyncReady& slot)
	An Asynchronous version of connect(). More...

Glib::RefPtr< IOStream >	connect_finish (const Glib::RefPtr< AsyncResult >& result)
	See g_proxy_connect(). More...

bool	supports_hostname () const
	Some proxy protocols expect to be passed a hostname, which they will resolve to an IP address themselves. More...

Public Member Functions inherited from Glib::Interface
	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

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

Static Public Member Functions
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...

static Glib::RefPtr< Proxy >	get_default_for_protocol (const Glib::ustring& protocol)
	Lookup "gio-proxy" extension point for a proxy implementation that supports specified protocol. More...

Protected Member Functions
	Proxy ()
	You should derive from this class to use it. More...

Related Functions
(Note that these are not member functions.)
Glib::RefPtr< Gio::Proxy >	wrap (GProxy* object, bool take_copy=false)
	A Glib::wrap() method for this object. More...

Detailed Description

Proxy - Interface for proxy handling.

A Proxy handles connecting to a remote host via a given type of proxy server. It is implemented by the 'gio-proxy' extension point. The extensions are named after their proxy protocol name. As an example, a SOCKS5 proxy implementation can be retrieved with the name 'socks5' using the C API's function g_io_extension_point_get_extension_by_name().

Since glibmm 2.28:

Constructor & Destructor Documentation

Gio::Proxy::Proxy ( )

protected

You should derive from this class to use it.

virtual Gio::Proxy::~Proxy ( )

virtual

Member Function Documentation

static void Gio::Proxy::add_interface ( GType gtype_implementer )

static

Glib::RefPtr<IOStream> Gio::Proxy::connect	(	const Glib::RefPtr< IOStream >&	connection,
		const Glib::RefPtr< const ProxyAddress >&	proxy_address,
		const Glib::RefPtr< Cancellable >&	cancellable
	)

Given connection to communicate with a proxy (eg, a SocketConnection that is connected to the proxy server), this does the necessary handshake to connect to proxy_address, and if required, wraps the IOStream to handle proxy payload.

Since glibmm 2.26:

Parameters

connection	A IOStream.
proxy_address	A ProxyAddress.
cancellable	A Cancellable.

Returns: A IOStream that will replace connection. This might be the same as connection, in which case a reference will be added.

void Gio::Proxy::connect_async	(	const Glib::RefPtr< IOStream >&	connection,
		const Glib::RefPtr< const ProxyAddress >&	proxy_address,
		const SlotAsyncReady&	slot,
		const Glib::RefPtr< Cancellable >&	cancellable
	)

An Asynchronous version of connect().

void Gio::Proxy::connect_async	(	const Glib::RefPtr< IOStream >&	connection,
		const Glib::RefPtr< const ProxyAddress >&	proxy_address,
		const SlotAsyncReady&	slot
	)

An Asynchronous version of connect().

Glib::RefPtr<IOStream> Gio::Proxy::connect_finish ( const Glib::RefPtr< AsyncResult >& result )

See g_proxy_connect().

Since glibmm 2.26:

Parameters

result A AsyncResult.

Returns: A IOStream.

static Glib::RefPtr<Proxy> Gio::Proxy::get_default_for_protocol ( const Glib::ustring& protocol )

static

Lookup "gio-proxy" extension point for a proxy implementation that supports specified protocol.

Since glibmm 2.26:

Parameters

protocol The proxy protocol name (e.g. http, socks, etc).

Returns: Return a Proxy or 0 if protocol is not supported.

static GType Gio::Proxy::get_type ( )

static

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

GProxy* Gio::Proxy::gobj ( )

inline

Provides access to the underlying C GObject.

const GProxy* Gio::Proxy::gobj ( ) const

inline

Provides access to the underlying C GObject.

bool Gio::Proxy::supports_hostname ( ) const

Some proxy protocols expect to be passed a hostname, which they will resolve to an IP address themselves.

Others, like SOCKS4, do not allow this. This function will return false if proxy is implementing such a protocol. When false is returned, the caller should resolve the destination hostname first, and then pass a ProxyAddress containing the stringified IP address to g_proxy_connect() or g_proxy_connect_async().

Since glibmm 2.26:

Returns: true if hostname resolution is supported.

Friends And Related Function Documentation

Glib::RefPtr< Gio::Proxy > wrap	(	GProxy *	object,
		bool	take_copy = `false`
	)

A Glib::wrap() method for this object.

Parameters

object	The C instance.
take_copy	False 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.

glibmm: Gio::Proxy Class Reference

Public Member Functions

Static Public Member Functions

Protected Member Functions

Related Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation