GI.Gio.Objects.ProxyAddress

Support for proxied InetSocketAddress.

Since: 2.26

Exported types

newtype ProxyAddress

Memory-managed wrapper type.

Constructors

ProxyAddress (ManagedPtr ProxyAddress)

Instances

Eq ProxyAddress

Defined in GI.Gio.Objects.ProxyAddress

Methods

(==) :: ProxyAddress -> ProxyAddress -> Bool

(/=) :: ProxyAddress -> ProxyAddress -> Bool

GObject ProxyAddress

Defined in GI.Gio.Objects.ProxyAddress

Methods

gobjectType :: IO GType

IsGValue ProxyAddress

Convert ProxyAddress to and from GValue with toGValue and fromGValue.

Defined in GI.Gio.Objects.ProxyAddress

Methods

toGValue :: ProxyAddress -> IO GValue

fromGValue :: GValue -> IO ProxyAddress

HasParentTypes ProxyAddress

Defined in GI.Gio.Objects.ProxyAddress

type ParentTypes ProxyAddress

Defined in GI.Gio.Objects.ProxyAddress

type ParentTypes ProxyAddress = '[InetSocketAddress, SocketAddress, Object, SocketConnectable]

class (GObject o, IsDescendantOf ProxyAddress o) => IsProxyAddress o

Type class for types which can be safely cast to ProxyAddress, for instance with toProxyAddress.

Instances

(GObject o, IsDescendantOf ProxyAddress o) => IsProxyAddress o

Defined in GI.Gio.Objects.ProxyAddress

toProxyAddress :: (MonadIO m, IsProxyAddress o) => o -> m ProxyAddress

Cast to ProxyAddress, for types for which this is known to be safe. For general casts, use castTo.

noProxyAddress :: Maybe ProxyAddress

A convenience alias for Nothing :: Maybe ProxyAddress.

Methods

Overloaded methods

getDestinationHostname

proxyAddressGetDestinationHostname

Arguments

:: (HasCallStack, MonadIO m, IsProxyAddress a)

=> a

proxy: a ProxyAddress

-> m Text

Returns: the proxy's destination hostname

Gets proxy'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.

Since: 2.26

getDestinationPort

proxyAddressGetDestinationPort

Arguments

:: (HasCallStack, MonadIO m, IsProxyAddress a)

=> a

proxy: a ProxyAddress

-> m Word16

Returns: the proxy's destination port

Gets proxy'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.

Since: 2.26

getDestinationProtocol

proxyAddressGetDestinationProtocol

Arguments

:: (HasCallStack, MonadIO m, IsProxyAddress a)

=> a

proxy: a ProxyAddress

-> m Text

Returns: the proxy's destination protocol

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

Since: 2.34

getPassword

proxyAddressGetPassword

Arguments

:: (HasCallStack, MonadIO m, IsProxyAddress a)

=> a

proxy: a ProxyAddress

-> m Text

Returns: the proxy's password

Gets proxy's password.

Since: 2.26

getProtocol

proxyAddressGetProtocol

Arguments

:: (HasCallStack, MonadIO m, IsProxyAddress a)

=> a

proxy: a ProxyAddress

-> m Text

Returns: the proxy's protocol

Gets proxy's protocol. eg, "socks" or "http"

Since: 2.26

getUri

proxyAddressGetUri

Arguments

:: (HasCallStack, MonadIO m, IsProxyAddress a)

=> a

proxy: a ProxyAddress

-> m Text

Returns: the proxy's URI, or Nothing if unknown

Gets the proxy URI that proxy was constructed from.

Since: 2.34

getUsername

proxyAddressGetUsername

Arguments

:: (HasCallStack, MonadIO m, IsProxyAddress a)

=> a

proxy: a ProxyAddress

-> m Text

Returns: the proxy's username

Gets proxy's username.

Since: 2.26

new

proxyAddressNew

Arguments

:: (HasCallStack, MonadIO m, IsInetAddress a)

=> a

inetaddr: The proxy server InetAddress.

-> Word16

port: The proxy server port.

-> Text

protocol: The proxy protocol to support, in lower case (e.g. socks, http).

-> Text

destHostname: The destination hostname the proxy should tunnel to.

-> Word16

destPort: The destination port to tunnel to.

-> Maybe Text

username: The username to authenticate to the proxy server (or Nothing).

-> Maybe Text

password: The password to authenticate to the proxy server (or Nothing).

-> m ProxyAddress

Returns: a new ProxyAddress

Creates a new ProxyAddress for inetaddr with protocol that should tunnel through destHostname and destPort.

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

Since: 2.26

Properties

destinationHostname

No description available in the introspection data.

constructProxyAddressDestinationHostname :: (IsProxyAddress o, MonadIO m) => Text -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “destination-hostname” property. This is rarely needed directly, but it is used by new.

getProxyAddressDestinationHostname :: (MonadIO m, IsProxyAddress o) => o -> m Text

Get the value of the “destination-hostname” property. When overloading is enabled, this is equivalent to

get proxyAddress #destinationHostname

destinationPort

No description available in the introspection data.

constructProxyAddressDestinationPort :: (IsProxyAddress o, MonadIO m) => Word32 -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “destination-port” property. This is rarely needed directly, but it is used by new.

getProxyAddressDestinationPort :: (MonadIO m, IsProxyAddress o) => o -> m Word32

Get the value of the “destination-port” property. When overloading is enabled, this is equivalent to

get proxyAddress #destinationPort

destinationProtocol

The protocol being spoke to the destination host, or Nothing if the ProxyAddress doesn't know.

Since: 2.34

constructProxyAddressDestinationProtocol :: (IsProxyAddress o, MonadIO m) => Text -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “destination-protocol” property. This is rarely needed directly, but it is used by new.

getProxyAddressDestinationProtocol :: (MonadIO m, IsProxyAddress o) => o -> m Text

Get the value of the “destination-protocol” property. When overloading is enabled, this is equivalent to

get proxyAddress #destinationProtocol

password

No description available in the introspection data.

constructProxyAddressPassword :: (IsProxyAddress o, MonadIO m) => Text -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “password” property. This is rarely needed directly, but it is used by new.

getProxyAddressPassword :: (MonadIO m, IsProxyAddress o) => o -> m Text

Get the value of the “password” property. When overloading is enabled, this is equivalent to

get proxyAddress #password

protocol

No description available in the introspection data.

constructProxyAddressProtocol :: (IsProxyAddress o, MonadIO m) => Text -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “protocol” property. This is rarely needed directly, but it is used by new.

getProxyAddressProtocol :: (MonadIO m, IsProxyAddress o) => o -> m Text

Get the value of the “protocol” property. When overloading is enabled, this is equivalent to

get proxyAddress #protocol

uri

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

Since: 2.34

constructProxyAddressUri :: (IsProxyAddress o, MonadIO m) => Text -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “uri” property. This is rarely needed directly, but it is used by new.

getProxyAddressUri :: (MonadIO m, IsProxyAddress o) => o -> m Text

Get the value of the “uri” property. When overloading is enabled, this is equivalent to

get proxyAddress #uri

username

No description available in the introspection data.

constructProxyAddressUsername :: (IsProxyAddress o, MonadIO m) => Text -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “username” property. This is rarely needed directly, but it is used by new.

getProxyAddressUsername :: (MonadIO m, IsProxyAddress o) => o -> m Text

Get the value of the “username” property. When overloading is enabled, this is equivalent to

get proxyAddress #username