gi-gio-2.0.12: Gio bindings

CopyrightWill Thompson, Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria (garetxe@gmail.com)
Safe HaskellNone
LanguageHaskell2010

GI.Gio.Objects.ProxyAddress

Contents

Description

Support for proxied InetSocketAddress.

Synopsis

Exported types

Methods

getDestinationHostname

proxyAddressGetDestinationHostname Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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

data ProxyAddressDestinationHostnamePropertyInfo Source #

Instances

AttrInfo ProxyAddressDestinationHostnamePropertyInfo Source # 
type AttrOrigin ProxyAddressDestinationHostnamePropertyInfo Source # 
type AttrLabel ProxyAddressDestinationHostnamePropertyInfo Source # 
type AttrGetType ProxyAddressDestinationHostnamePropertyInfo Source # 
type AttrBaseTypeConstraint ProxyAddressDestinationHostnamePropertyInfo Source # 
type AttrSetTypeConstraint ProxyAddressDestinationHostnamePropertyInfo Source # 
type AttrAllowedOps ProxyAddressDestinationHostnamePropertyInfo Source # 

destinationPort

data ProxyAddressDestinationPortPropertyInfo Source #

Instances

AttrInfo ProxyAddressDestinationPortPropertyInfo Source # 
type AttrOrigin ProxyAddressDestinationPortPropertyInfo Source # 
type AttrLabel ProxyAddressDestinationPortPropertyInfo Source # 
type AttrGetType ProxyAddressDestinationPortPropertyInfo Source # 
type AttrBaseTypeConstraint ProxyAddressDestinationPortPropertyInfo Source # 
type AttrSetTypeConstraint ProxyAddressDestinationPortPropertyInfo Source # 
type AttrAllowedOps ProxyAddressDestinationPortPropertyInfo Source # 

destinationProtocol

data ProxyAddressDestinationProtocolPropertyInfo Source #

Instances

AttrInfo ProxyAddressDestinationProtocolPropertyInfo Source # 
type AttrOrigin ProxyAddressDestinationProtocolPropertyInfo Source # 
type AttrLabel ProxyAddressDestinationProtocolPropertyInfo Source # 
type AttrGetType ProxyAddressDestinationProtocolPropertyInfo Source # 
type AttrBaseTypeConstraint ProxyAddressDestinationProtocolPropertyInfo Source # 
type AttrSetTypeConstraint ProxyAddressDestinationProtocolPropertyInfo Source # 
type AttrAllowedOps ProxyAddressDestinationProtocolPropertyInfo Source # 

password

data ProxyAddressPasswordPropertyInfo Source #

Instances

AttrInfo ProxyAddressPasswordPropertyInfo Source # 
type AttrOrigin ProxyAddressPasswordPropertyInfo Source # 
type AttrLabel ProxyAddressPasswordPropertyInfo Source # 
type AttrGetType ProxyAddressPasswordPropertyInfo Source # 
type AttrBaseTypeConstraint ProxyAddressPasswordPropertyInfo Source # 
type AttrSetTypeConstraint ProxyAddressPasswordPropertyInfo Source # 
type AttrAllowedOps ProxyAddressPasswordPropertyInfo Source # 

protocol

data ProxyAddressProtocolPropertyInfo Source #

Instances

AttrInfo ProxyAddressProtocolPropertyInfo Source # 
type AttrOrigin ProxyAddressProtocolPropertyInfo Source # 
type AttrLabel ProxyAddressProtocolPropertyInfo Source # 
type AttrGetType ProxyAddressProtocolPropertyInfo Source # 
type AttrBaseTypeConstraint ProxyAddressProtocolPropertyInfo Source # 
type AttrSetTypeConstraint ProxyAddressProtocolPropertyInfo Source # 
type AttrAllowedOps ProxyAddressProtocolPropertyInfo Source # 

uri

data ProxyAddressUriPropertyInfo Source #

Instances

AttrInfo ProxyAddressUriPropertyInfo Source # 
type AttrOrigin ProxyAddressUriPropertyInfo Source # 
type AttrLabel ProxyAddressUriPropertyInfo Source # 
type AttrGetType ProxyAddressUriPropertyInfo Source # 
type AttrBaseTypeConstraint ProxyAddressUriPropertyInfo Source # 
type AttrSetTypeConstraint ProxyAddressUriPropertyInfo Source # 
type AttrAllowedOps ProxyAddressUriPropertyInfo Source # 

username

data ProxyAddressUsernamePropertyInfo Source #

Instances

AttrInfo ProxyAddressUsernamePropertyInfo Source # 
type AttrOrigin ProxyAddressUsernamePropertyInfo Source # 
type AttrLabel ProxyAddressUsernamePropertyInfo Source # 
type AttrGetType ProxyAddressUsernamePropertyInfo Source # 
type AttrBaseTypeConstraint ProxyAddressUsernamePropertyInfo Source # 
type AttrSetTypeConstraint ProxyAddressUsernamePropertyInfo Source # 
type AttrAllowedOps ProxyAddressUsernamePropertyInfo Source #