EDataServer.SourceProxy

Subclasses:None

Methods

Inherited:EDataServer.SourceExtension (4), GObject.Object (37) Structs:GObject.ObjectClass (5)

	dup_autoconfig_url ()
	dup_ftp_host ()
	dup_http_auth_password ()
	dup_http_auth_user ()
	dup_http_host ()
	dup_https_host ()
	dup_ignore_hosts ()
	dup_socks_host ()
	get_autoconfig_url ()
	get_ftp_host ()
	get_ftp_port ()
	get_http_auth_password ()
	get_http_auth_user ()
	get_http_host ()
	get_http_port ()
	get_http_use_auth ()
	get_https_host ()
	get_https_port ()
	get_ignore_hosts ()
	get_method ()
	get_socks_host ()
	get_socks_port ()
	set_autoconfig_url (autoconfig_url)
	set_ftp_host (ftp_host)
	set_ftp_port (ftp_port)
	set_http_auth_password (http_auth_password)
	set_http_auth_user (http_auth_user)
	set_http_host (http_host)
	set_http_port (http_port)
	set_http_use_auth (http_use_auth)
	set_https_host (https_host)
	set_https_port (https_port)
	set_ignore_hosts (ignore_hosts)
	set_method (method)
	set_socks_host (socks_host)
	set_socks_port (socks_port)

Virtual Methods

Inherited:GObject.Object (7)

Properties

Inherited:EDataServer.SourceExtension (1)

Name	Type	Flags	Short Description
autoconfig-url	str	r/w/c/en	Proxy autoconfiguration URL
ftp-host	str	r/w/c/en	FTP proxy host name
ftp-port	int	r/w/c/en	FTP proxy port
http-auth-password	str	r/w/c/en	HTTP proxy password
http-auth-user	str	r/w/c/en	HTTP proxy username
http-host	str	r/w/c/en	HTTP proxy host name
http-port	int	r/w/c/en	HTTP proxy port
http-use-auth	bool	r/w/c/en	Whether HTTP proxy server connections require authentication
https-host	str	r/w/c/en	Secure HTTP proxy host name
https-port	int	r/w/c/en	Secure HTTP proxy port
ignore-hosts	[str]	r/w/c/en	Hosts to connect directly
method	EDataServer.ProxyMethod	r/w/c/en	Proxy configuration method
socks-host	str	r/w/c/en	SOCKS proxy host name
socks-port	int	r/w/c/en	SOCKS proxy port

Signals

Inherited:GObject.Object (1)

Fields

Inherited:GObject.Object (1)

Name	Type	Access	Description
parent	EDataServer.SourceExtension	r

Class Details

class EDataServer.SourceProxy(**kwargs)

Bases:EDataServer.SourceExtension Abstract:No Structure:EDataServer.SourceProxyClass

Contains only private data that should be read and manipulated using the functions below.

New in version 3.12.

dup_autoconfig_url()

Returns:a newly-allocated copy of EDataServer.SourceProxy :autoconfig-url Return type:str

Thread-safe variation of EDataServer.SourceProxy.get_autoconfig_url(). Use this function when accessing self from multiple threads.

The returned string should be freed with GLib.free() when no longer needed.

New in version 3.12.

dup_ftp_host()

Returns:a newly-allocated copy of EDataServer.SourceProxy :ftp-host Return type:str

Thread-safe variation of EDataServer.SourceProxy.get_ftp_host(). Use this function when accessing self from multiple threads.

The returned string should be freed with GLib.free() when no longer needed.

New in version 3.12.

dup_http_auth_password()

Returns:a newly-allocated copy of EDataServer.SourceProxy :http-auth-password Return type:str

Thread-safe variation of EDataServer.SourceProxy.get_http_auth_password(). Use this function when accessing self from multiple threads.

The returned string should be freed with GLib.free() when no longer needed.

New in version 3.12.

dup_http_auth_user()

Returns:a newly-allocated copy of EDataServer.SourceProxy :http-auth-user Return type:str

Thread-safe variation of EDataServer.SourceProxy.get_http_auth_user(). Use this function when accessing self from multiple threads.

The returned string should be freed with GLib.free() when no longer needed.

New in version 3.12.

dup_http_host()

Returns:a newly-allocated copy of EDataServer.SourceProxy :http-host Return type:str

Thread-safe variation of EDataServer.SourceProxy.get_http_host(). Use this function when accessing self from multiple threads.

The returned string should be freed with GLib.free() when no longer needed.

New in version 3.12.

dup_https_host()

Returns:a newly-allocated copy of EDataServer.SourceProxy :https-host Return type:str

Threads-safe variation of EDataServer.SourceProxy.get_https_host(). Use this function when accessing self from multiple threads.

The returned string should be freed with GLib.free() when no longer needed.

New in version 3.12.

dup_ignore_hosts()

Returns:a newly-allocated copy of EDataServer.SourceProxy :ignore-hosts Return type:[str]

Thread-safe variation of EDataServer.SourceProxy.get_ignore_hosts(). Use this function when accessing self from multiple threads.

The returned string array should be freed with GLib.strfreev() when no longer needed.

New in version 3.12.

dup_socks_host()

Returns:a newly-allocated copy of EDataServer.SourceProxy :socks-host Return type:str

Thread-safe variation of EDataServer.SourceProxy.get_socks_host(). Use this function when accessing self from multiple threads.

The returned string should be freed with GLib.free() when no longer needed.

New in version 3.12.

get_autoconfig_url()

Returns:the autoconfiguration URL Return type:str

Returns the URL that provides proxy configuration values. When the self’s EDataServer.SourceProxy :method is EDataServer.ProxyMethod.AUTO, this URL is used to look up proxy information for all protocols.

New in version 3.12.

get_ftp_host()

Returns:FTP proxy host name Return type:str

Returns the machine name to proxy FTP through when self’s EDataServer.SourceProxy :method is EDataServer.ProxyMethod.MANUAL.

New in version 3.12.

get_ftp_port()

Returns:FTP proxy port Return type:int

Returns the port on the machine defined by EDataServer.SourceProxy :ftp-host to proxy through when self’s EDataServer.SourceProxy :method is EDataServer.ProxyMethod.MANUAL.

New in version 3.12.

get_http_auth_password()

Returns:HTTP proxy password Return type:str

Returns the password to pass as authentication when doing HTTP proxying and EDataServer.SourceProxy :http-use-auth is True.

New in version 3.12.

get_http_auth_user()

Returns:HTTP proxy username Return type:str

Returns the user name to pass as authentication when doing HTTP proxying and EDataServer.SourceProxy :http-use-auth is True.

New in version 3.12.

get_http_host()

Returns:HTTP proxy host name Return type:str

Returns the machine name to proxy HTTP through when self’s EDataServer.SourceProxy :method is EDataServer.ProxyMethod.MANUAL.

New in version 3.12.

get_http_port()

Returns:HTTP proxy port Return type:int

Returns the port on the machine defined by EDataServer.SourceProxy :http-host to proxy through when self’s EDataServer.SourceProxy :method is EDataServer.ProxyMethod.MANUAL.

New in version 3.12.

get_http_use_auth()

Returns:whether to authenticate HTTP proxy connections Return type:bool

Returns whether the HTTP proxy server at EDataServer.SourceProxy :http-host and EDataServer.SourceProxy :http-port requires authentication.

The username/password combo is defined by EDataServer.SourceProxy :http-auth-user and EDataServer.SourceProxy :http-auth-password, but only applies when self’s EDataServer.SourceProxy :method is EDataServer.ProxyMethod.MANUAL.

New in version 3.12.

get_https_host()

Returns:secure HTTP proxy host name Return type:str

Returns the machine name to proxy secure HTTP through when self’s EDataServer.SourceProxy :method is EDataServer.ProxyMethod.MANUAL.

New in version 3.12.

get_https_port()

Returns:secure HTTP proxy port Return type:int

Returns the port on the machine defined by EDataServer.SourceProxy :https-host to proxy through when self’s EDataServer.SourceProxy :method is EDataServer.ProxyMethod.MANUAL.

New in version 3.12.

get_ignore_hosts()

Returns:a None-terminated string array of hosts Return type:[str]

Returns a None-terminated string array of hosts which are connected to directly, rather than via the proxy (if it is active). The array elements can be hostnames, domains (using an initial wildcard like *.foo.com), IP host addresses (both IPv4 and IPv6) and network addresses with a netmask (something like 192.168.0.0/24).

The returned array is owned by self and should not be modified or freed.

New in version 3.12.

get_method()

Returns:the proxy configuration method Return type:EDataServer.ProxyMethod

Returns the proxy configuration method for self.

The proxy configuration method determines the behavior of EDataServer.Source.proxy_lookup().

New in version 3.12.

get_socks_host()

Returns:SOCKS proxy host name Return type:str

Returns the machine name to use as a SOCKS proxy when self’s EDataServer.SourceProxy :method is EDataServer.ProxyMethod.MANUAL.

New in version 3.12.

get_socks_port()

Returns:SOCKS proxy port Return type:int

Returns the port on the machine defined by EDataServer.SourceProxy :socks-host to proxy through when self’s EDataServer.SourceProxy :method is EDataServer.ProxyMethod.MANUAL.

New in version 3.12.

set_autoconfig_url(autoconfig_url)

Parameters:autoconfig_url (str) – an autoconfiguration URL

Sets the URL that provides proxy configuration values. When the self’s EDataServer.SourceProxy :method is EDataServer.ProxyMethod.AUTO, this URL is used to look up proxy information for all protocols.

New in version 3.12.

set_ftp_host(ftp_host)

Parameters:ftp_host (str) – FTP proxy host name

Sets the machine name to proxy FTP through when self’s EDataServer.SourceProxy :method is EDataServer.ProxyMethod.MANUAL.

New in version 3.12.

set_ftp_port(ftp_port)

Parameters:ftp_port (int) – FTP proxy port

Sets the port on the machine defined by EDataServer.SourceProxy :ftp-host to proxy through when self’s EDataServer.SourceProxy :method is EDataServer.ProxyMethod.MANUAL.

New in version 3.12.

set_http_auth_password(http_auth_password)

Parameters:http_auth_password (str) – HTTP proxy password

Sets the password to pass as authentication when doing HTTP proxying and EDataServer.SourceProxy :http-use-auth is True.

New in version 3.12.

set_http_auth_user(http_auth_user)

Parameters:http_auth_user (str) – HTTP proxy username

Sets the user name to pass as authentication when doing HTTP proxying and EDataServer.SourceProxy :http-use-auth is True.

New in version 3.12.

set_http_host(http_host)

Parameters:http_host (str) – HTTP proxy host name

Sets the machine name to proxy HTTP through when self’s EDataServer.SourceProxy :method is EDataServer.ProxyMethod.MANUAL.

New in version 3.12.

set_http_port(http_port)

Parameters:http_port (int) – HTTP proxy port

Sets the port on the machine defined by EDataServer.SourceProxy :http-host to proxy through when self’s EDataServer.SourceProxy :method is EDataServer.ProxyMethod.MANUAL.

New in version 3.12.

set_http_use_auth(http_use_auth)

Parameters:http_use_auth (bool) – whether to authenticate HTTP proxy connections

Sets whether the HTTP proxy server at EDataServer.SourceProxy :http-host and EDataServer.SourceProxy :http-port requires authentication.

The username/password combo is defined by EDataServer.SourceProxy :http-auth-user and EDataServer.SourceProxy :http-auth-password, but only applies when self’s EDataServer.SourceProxy :method is EDataServer.ProxyMethod.MANUAL.

New in version 3.12.

set_https_host(https_host)

Parameters:https_host (str) – secure HTTP proxy host name

Sets the machine name to proxy secure HTTP through when self’s EDataServer.SourceProxy :method is EDataServer.ProxyMethod.MANUAL.

New in version 3.12.

set_https_port(https_port)

Parameters:https_port (int) – secure HTTP proxy port

Sets the port on the machine defined by EDataServer.SourceProxy :https-host to proxy through when self’s EDataServer.SourceProxy :method is EDataServer.ProxyMethod.MANUAL.

New in version 3.12.

set_ignore_hosts(ignore_hosts)

Parameters:ignore_hosts (str) – a None-terminated string array of hosts

Sets the hosts which are connected to directly, rather than via the proxy (if it is active). The array elements can be hostnames, domains (using an initial wildcard like *.foo.com), IP host addresses (both IPv4 and IPv6) and network addresses with a netmask (something like 192.168.0.0/24).

New in version 3.12.

set_method(method)

Parameters:method (EDataServer.ProxyMethod) – the proxy configuration method

Sets the proxy configuration method for self.

The proxy configuration method determines the behavior of EDataServer.Source.proxy_lookup().

New in version 3.12.

set_socks_host(socks_host)

Parameters:socks_host (str) – SOCKS proxy host name

Sets the machine name to use as a SOCKS proxy when self’s EDataServer.SourceProxy :method is EDataServer.ProxyMethod.MANUAL.

New in version 3.12.

set_socks_port(socks_port)

Parameters:socks_port (int) – SOCKS proxy port

Sets the port on the machine defined by EDataServer.SourceProxy :socks-host to proxy through when self’s EDataServer.SourceProxy :method is EDataServer.ProxyMethod.MANUAL.

New in version 3.12.

Property Details

EDataServer.SourceProxy.props.autoconfig_url

Name:autoconfig-url Type:str Default Value:None Flags:READABLE, WRITABLE, CONSTRUCT, EXPLICIT_NOTIFY

Proxy autoconfiguration URL

EDataServer.SourceProxy.props.ftp_host

Name:ftp-host Type:str Default Value:None Flags:READABLE, WRITABLE, CONSTRUCT, EXPLICIT_NOTIFY

FTP proxy host name

EDataServer.SourceProxy.props.ftp_port

Name:ftp-port Type:int Default Value:0 Flags:READABLE, WRITABLE, CONSTRUCT, EXPLICIT_NOTIFY

FTP proxy port

EDataServer.SourceProxy.props.http_auth_password

Name:http-auth-password Type:str Default Value:None Flags:READABLE, WRITABLE, CONSTRUCT, EXPLICIT_NOTIFY

HTTP proxy password

EDataServer.SourceProxy.props.http_auth_user

Name:http-auth-user Type:str Default Value:None Flags:READABLE, WRITABLE, CONSTRUCT, EXPLICIT_NOTIFY

HTTP proxy username

EDataServer.SourceProxy.props.http_host

Name:http-host Type:str Default Value:None Flags:READABLE, WRITABLE, CONSTRUCT, EXPLICIT_NOTIFY

HTTP proxy host name

EDataServer.SourceProxy.props.http_port

Name:http-port Type:int Default Value:8080 Flags:READABLE, WRITABLE, CONSTRUCT, EXPLICIT_NOTIFY

HTTP proxy port

EDataServer.SourceProxy.props.http_use_auth

Name:http-use-auth Type:bool Default Value:False Flags:READABLE, WRITABLE, CONSTRUCT, EXPLICIT_NOTIFY

Whether HTTP proxy server connections require authentication

EDataServer.SourceProxy.props.https_host

Name:https-host Type:str Default Value:None Flags:READABLE, WRITABLE, CONSTRUCT, EXPLICIT_NOTIFY

Secure HTTP proxy host name

EDataServer.SourceProxy.props.https_port

Name:https-port Type:int Default Value:0 Flags:READABLE, WRITABLE, CONSTRUCT, EXPLICIT_NOTIFY

Secure HTTP proxy port

EDataServer.SourceProxy.props.ignore_hosts

Name:ignore-hosts Type:[str] Default Value:[] Flags:READABLE, WRITABLE, CONSTRUCT, EXPLICIT_NOTIFY

Hosts to connect directly

EDataServer.SourceProxy.props.method

Name:method Type:EDataServer.ProxyMethod Default Value:EDataServer.ProxyMethod.DEFAULT Flags:READABLE, WRITABLE, CONSTRUCT, EXPLICIT_NOTIFY

Proxy configuration method

EDataServer.SourceProxy.props.socks_host

Name:socks-host Type:str Default Value:None Flags:READABLE, WRITABLE, CONSTRUCT, EXPLICIT_NOTIFY

SOCKS proxy host name

EDataServer.SourceProxy.props.socks_port

Name:socks-port Type:int Default Value:0 Flags:READABLE, WRITABLE, CONSTRUCT, EXPLICIT_NOTIFY

SOCKS proxy port