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

Proxy - Interface for proxy handling. More...

#include <giomm/proxy.h>

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

Public Member Functions

 Proxy (Proxy && src) noexcept
 
Proxyoperator= (Proxy && src) noexcept
 
 ~Proxy () noexcept override
 
GProxy * gobj ()
 Provides access to the underlying C GObject. More...
 
const GProxy * gobj () const
 Provides access to the underlying C GObject. More...
 
Glib::RefPtr< IOStreamconnect (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< IOStreamconnect_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 ()
 A Default constructor. More...
 
 Interface (Interface && src) noexcept
 
Interfaceoperator= (Interface && src) noexcept
 
 Interface (const Glib::Interface_Class & interface_class)
 Called by constructors of derived classes. More...
 
 Interface (GObject * castitem)
 Called by constructors of derived classes. More...
 
 ~Interface () noexcept override
 
 Interface (const Interface &)=delete
 
Interfaceoperator= (const Interface &)=delete
 
GObject * gobj ()
 
const GObject * gobj () const
 
- Public Member Functions inherited from Glib::ObjectBase
 ObjectBase (const ObjectBase &)=delete
 
ObjectBaseoperator= (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. 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...
 
template<class PropertyType >
PropertyType get_property (const Glib::ustring & property_name) const
 You probably want to use a specific property_*() accessor method instead. More...
 
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. More...
 
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. 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< Proxyget_default_for_protocol (const Glib::ustring & protocol)
 Find the gio-proxy extension point for a proxy implementation that supports the specified protocol. More...
 

Protected Member Functions

 Proxy ()
 You should derive from this class to use it. More...
 
- 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...
 
 ObjectBase (ObjectBase && src) noexcept
 
ObjectBaseoperator= (ObjectBase && src) noexcept
 
virtual ~ObjectBase () noexcept=0
 
void initialize (GObject * castitem)
 
void initialize_move (GObject * castitem, Glib::ObjectBase * previous_wrapper)
 

Related Functions

(Note that these are not member functions.)

Glib::RefPtr< Gio::Proxywrap (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

◆ Proxy() [1/2]

Gio::Proxy::Proxy ( )
protected

You should derive from this class to use it.

◆ Proxy() [2/2]

Gio::Proxy::Proxy ( Proxy &&  src)
noexcept

◆ ~Proxy()

Gio::Proxy::~Proxy ( )
overridenoexcept

Member Function Documentation

◆ add_interface()

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

◆ connect()

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
connectionA IOStream.
proxy_addressA ProxyAddress.
cancellableA Cancellable.
Returns
A IOStream that will replace connection. This might be the same as connection, in which case a reference will be added.
Exceptions
Glib::Error

◆ connect_async() [1/2]

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

◆ connect_async() [2/2]

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

◆ connect_finish()

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

See g_proxy_connect().

Since glibmm 2.26:
Parameters
resultA AsyncResult.
Returns
A IOStream.
Exceptions
Glib::Error

◆ get_default_for_protocol()

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

Find the gio-proxy extension point for a proxy implementation that supports the specified protocol.

Since glibmm 2.26:
Parameters
protocolThe proxy protocol name (e.g. http, socks, etc).
Returns
Return a Proxy or nullptr if protocol is not supported.

◆ get_type()

static GType Gio::Proxy::get_type ( )
static

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

◆ gobj() [1/2]

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

Provides access to the underlying C GObject.

◆ gobj() [2/2]

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

Provides access to the underlying C GObject.

◆ operator=()

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

◆ supports_hostname()

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

◆ wrap()

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