class Gio::SimpleProxyResolver

Overview

GSimpleProxyResolver is a simple Gio::ProxyResolver implementation that handles a single default proxy, multiple URI-scheme-specific proxies, and a list of hosts that proxies should not be used for.

GSimpleProxyResolver is never the default proxy resolver, but it can be used as the base class for another proxy resolver implementation, or it can be created and used manually, such as with Gio::SocketClient#proxy_resolver=.

Included Modules

Defined in:

lib/gi-crystal/src/auto/gio-2.0/simple_proxy_resolver.cr

Constructors

Class Method Summary

Instance Method Summary

Instance methods inherited from module Gio::ProxyResolver

is_supported : Bool is_supported, lookup(uri : String, cancellable : Gio::Cancellable | Nil) : Enumerable(String) lookup, lookup_async(uri : String, cancellable : Gio::Cancellable | Nil, &callback : Gio::AsyncReadyCallback) : Nil lookup_async, lookup_finish(result : Gio::AsyncResult) : Enumerable(String) lookup_finish, to_unsafe to_unsafe

Constructor methods inherited from module Gio::ProxyResolver

cast(obj : GObject::Object) : self cast

Class methods inherited from module Gio::ProxyResolver

cast?(obj : GObject::Object) : self | Nil cast?, default : Gio::ProxyResolver default, g_type : UInt64 g_type

Instance methods inherited from class GObject::Object

==(other : self) ==, bind_property(source_property : String, target : GObject::Object, target_property : String, flags : GObject::BindingFlags) : GObject::Binding bind_property, bind_property_full(source_property : String, target : GObject::Object, target_property : String, flags : GObject::BindingFlags, transform_to : GObject::Closure, transform_from : GObject::Closure) : GObject::Binding bind_property_full, data(key : String) : Pointer(Void) | Nil data, finalize finalize, freeze_notify : Nil freeze_notify, getv(names : Enumerable(String), values : Enumerable(_)) : Nil getv, hash(hasher) hash, notify(property_name : String) : Nil notify, notify_by_pspec(pspec : GObject::ParamSpec) : Nil notify_by_pspec, notify_signal notify_signal, property(property_name : String, value : _) : Nil property, qdata(quark : UInt32) : Pointer(Void) | Nil qdata, ref_count : UInt32 ref_count, run_dispose : Nil run_dispose, set_data(key : String, data : Pointer(Void) | Nil) : Nil set_data, set_property(property_name : String, value : _) : Nil set_property, steal_data(key : String) : Pointer(Void) | Nil steal_data, steal_qdata(quark : UInt32) : Pointer(Void) | Nil steal_qdata, thaw_notify : Nil thaw_notify, to_unsafe : Pointer(Void) to_unsafe, watch_closure(closure : GObject::Closure) : Nil watch_closure

Constructor methods inherited from class GObject::Object

cast(obj : GObject::Object) : self cast, new(pointer : Pointer(Void), transfer : GICrystal::Transfer)
new new, newv(object_type : UInt64, parameters : Enumerable(GObject::Parameter)) : self newv

Class methods inherited from class GObject::Object

cast?(obj : GObject::Object) : self | Nil cast?, compat_control(what : UInt64, data : Pointer(Void) | Nil) : UInt64 compat_control, g_type : UInt64 g_type, interface_find_property(g_iface : GObject::TypeInterface, property_name : String) : GObject::ParamSpec interface_find_property, interface_list_properties(g_iface : GObject::TypeInterface) : Enumerable(GObject::ParamSpec) interface_list_properties

Macros inherited from class GObject::Object

previous_vfunc(*args) previous_vfunc, previous_vfunc!(*args) previous_vfunc!, signal(signature) signal

Constructor Detail

def self.new(default_proxy : String | Nil, ignore_hosts : Enumerable(String) | Nil) : Gio::ProxyResolver #

Creates a new #GSimpleProxyResolver. See #GSimpleProxyResolver:default-proxy and #GSimpleProxyResolver:ignore-hosts for more details on how the arguments are interpreted.


def self.new #

Initialize a new SimpleProxyResolver.


def self.new(*, default_proxy : String | Nil = nil, ignore_hosts : Enumerable(String) | Nil = nil) #

Class Method Detail

def self.g_type : UInt64 #

Returns the type id (GType) registered in GLib type system.


Instance Method Detail

def ==(other : self) #
Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.


def default_proxy : String #

def default_proxy=(value : String) : String #

def default_proxy=(value : Nil) : Nil #

Set #default_proxy property to nil.


def default_proxy=(default_proxy : String | Nil) : Nil #

Sets the default proxy on resolver, to be used for any URIs that don't match #GSimpleProxyResolver:ignore-hosts or a proxy set via g_simple_proxy_resolver_set_uri_proxy().

If default_proxy starts with "socks://", #GSimpleProxyResolver will treat it as referring to all three of the socks5, socks4a, and socks4 proxy types.


def default_proxy? : String | Nil #

Same as #default_proxy, but can return nil.


def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def ignore_hosts : Enumerable(String) #

def ignore_hosts=(ignore_hosts : Enumerable(String)) : Nil #

Sets the list of ignored hosts.

See #GSimpleProxyResolver:ignore-hosts for more details on how the ignore_hosts argument is interpreted.


def set_uri_proxy(uri_scheme : String, proxy : String) : Nil #

Adds a URI-scheme-specific proxy to resolver; URIs whose scheme matches uri_scheme (and which don't match #GSimpleProxyResolver:ignore-hosts) will be proxied via proxy.

As with #GSimpleProxyResolver:default-proxy, if proxy starts with "socks://", #GSimpleProxyResolver will treat it as referring to all three of the socks5, socks4a, and socks4 proxy types.