GI.Gio.Objects.ProxyAddress

Support for proxied InetSocketAddress.

Exported types

newtype ProxyAddress

Constructors

ProxyAddress (ManagedPtr ProxyAddress)

Instances

GObject ProxyAddress

Methods

gobjectType :: ProxyAddress -> IO GType

IsObject ProxyAddress

IsSocketAddress ProxyAddress

IsProxyAddress ProxyAddress

IsInetSocketAddress ProxyAddress

IsSocketConnectable ProxyAddress

class GObject o => IsProxyAddress o

Instances

(GObject a, UnknownAncestorError Constraint ProxyAddress a) => IsProxyAddress a

IsProxyAddress ProxyAddress

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

noProxyAddress :: Maybe ProxyAddress

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

constructProxyAddressDestinationHostname :: IsProxyAddress o => Text -> IO (GValueConstruct o)

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

destinationPort

constructProxyAddressDestinationPort :: IsProxyAddress o => Word32 -> IO (GValueConstruct o)

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

destinationProtocol

constructProxyAddressDestinationProtocol :: IsProxyAddress o => Text -> IO (GValueConstruct o)

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

password

constructProxyAddressPassword :: IsProxyAddress o => Text -> IO (GValueConstruct o)

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

protocol

constructProxyAddressProtocol :: IsProxyAddress o => Text -> IO (GValueConstruct o)

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

uri

constructProxyAddressUri :: IsProxyAddress o => Text -> IO (GValueConstruct o)

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

username

constructProxyAddressUsername :: IsProxyAddress o => Text -> IO (GValueConstruct o)

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