Gio.ProxyAddress

g GObject.GInterface GObject.GInterface Gio.SocketConnectable Gio.SocketConnectable GObject.GInterface->Gio.SocketConnectable GObject.Object GObject.Object Gio.SocketAddress Gio.SocketAddress GObject.Object->Gio.SocketAddress Gio.InetSocketAddress Gio.InetSocketAddress Gio.ProxyAddress Gio.ProxyAddress Gio.InetSocketAddress->Gio.ProxyAddress Gio.SocketAddress->Gio.InetSocketAddress Gio.SocketConnectable->Gio.SocketAddress

Subclasses:None

Methods

Inherited:Gio.InetSocketAddress (6), Gio.SocketAddress (4), GObject.Object (37), Gio.SocketConnectable (3)
Structs:GObject.ObjectClass (5)
class new (inetaddr, port, protocol, dest_hostname, dest_port, username, password)
  get_destination_hostname ()
  get_destination_port ()
  get_destination_protocol ()
  get_password ()
  get_protocol ()
  get_uri ()
  get_username ()

Properties

Inherited:Gio.InetSocketAddress (4), Gio.SocketAddress (1)
Name Type Flags Short Description
destination-hostname str r/w/co The proxy destination hostname
destination-port int r/w/co The proxy destination port
destination-protocol str r/w/co The proxy destination protocol
password str r/w/co The proxy password
protocol str r/w/co The proxy protocol
uri str r/w/co The proxy’s URI
username str r/w/co The proxy username

Signals

Inherited:GObject.Object (1)

Fields

Inherited:GObject.Object (1)
Name Type Access Description
parent_instance Gio.InetSocketAddress r  

Class Details

class Gio.ProxyAddress(**kwargs)
Bases:Gio.InetSocketAddress
Abstract:No
Structure:Gio.ProxyAddressClass

Support for proxied Gio.InetSocketAddress.

New in version 2.26.

classmethod new(inetaddr, port, protocol, dest_hostname, dest_port, username, password)[source]
Parameters:
  • inetaddr (Gio.InetAddress) – The proxy server Gio.InetAddress.
  • port (int) – The proxy server port.
  • protocol (str) – The proxy protocol to support, in lower case (e.g. socks, http).
  • dest_hostname (str) – The destination hostname the proxy should tunnel to.
  • dest_port (int) – The destination port to tunnel to.
  • username (str or None) – The username to authenticate to the proxy server (or None).
  • password (str or None) – The password to authenticate to the proxy server (or None).
Returns:

a new Gio.ProxyAddress

Return type:

Gio.SocketAddress

Creates a new Gio.ProxyAddress for inetaddr with protocol that should tunnel through dest_hostname and dest_port.

(Note that this method doesn’t set the Gio.ProxyAddress :uri or Gio.ProxyAddress :destination-protocol fields; use g_object_new() directly if you want to set those.)

New in version 2.26.

get_destination_hostname()[source]
Returns:the self’s destination hostname
Return type:str

Gets self’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.

New in version 2.26.

get_destination_port()[source]
Returns:the self’s destination port
Return type:int

Gets self’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.

New in version 2.26.

get_destination_protocol()[source]
Returns:the self’s destination protocol
Return type:str

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

New in version 2.34.

get_password()[source]
Returns:the self’s password
Return type:str

Gets self’s password.

New in version 2.26.

get_protocol()[source]
Returns:the self’s protocol
Return type:str

Gets self’s protocol. eg, “socks” or “http”

New in version 2.26.

get_uri()[source]
Returns:the self’s URI, or None if unknown
Return type:str

Gets the proxy URI that self was constructed from.

New in version 2.34.

get_username()[source]
Returns:the self’s username
Return type:str

Gets self’s username.

New in version 2.26.

Property Details

Gio.ProxyAddress.props.destination_hostname
Name:destination-hostname
Type:str
Default Value:None
Flags:READABLE, WRITABLE, CONSTRUCT_ONLY

The proxy destination hostname

Gio.ProxyAddress.props.destination_port
Name:destination-port
Type:int
Default Value:0
Flags:READABLE, WRITABLE, CONSTRUCT_ONLY

The proxy destination port

Gio.ProxyAddress.props.destination_protocol
Name:destination-protocol
Type:str
Default Value:None
Flags:READABLE, WRITABLE, CONSTRUCT_ONLY

The protocol being spoke to the destination host, or None if the Gio.ProxyAddress doesn’t know.

New in version 2.34.

Gio.ProxyAddress.props.password
Name:password
Type:str
Default Value:None
Flags:READABLE, WRITABLE, CONSTRUCT_ONLY

The proxy password

Gio.ProxyAddress.props.protocol
Name:protocol
Type:str
Default Value:None
Flags:READABLE, WRITABLE, CONSTRUCT_ONLY

The proxy protocol

Gio.ProxyAddress.props.uri
Name:uri
Type:str
Default Value:None
Flags:READABLE, WRITABLE, CONSTRUCT_ONLY

The URI string that the proxy was constructed from (or None if the creator didn’t specify this).

New in version 2.34.

Gio.ProxyAddress.props.username
Name:username
Type:str
Default Value:None
Flags:READABLE, WRITABLE, CONSTRUCT_ONLY

The proxy username