Documentation

Settings

Settings of an implementation of the \Authlete\Api\AuthleteApi interface.

Tags
link
\Authlete\Api\AuthleteApi

Table of Contents

getConnectionTimeout()  : int
Get the connection timeout in seconds.
getProxyHost()  : string
Get the proxy host.
getProxyPort()  : int
Get the proxy port.
isHttpProxyTunnelUsed()  : bool
Get the flag which indicates whether HTTP proxy tunnel is used or not.
setConnectionTimeout()  : Settings
Set a connection timeout in seconds.
setHttpProxyTunnelUsed()  : Settings
Set the flag which indicates whether HTTP proxy tunnel is used or not.
setProxyHost()  : Settings
Set a proxy host.
setProxyPort()  : Settings
Set a proxy port.

Methods

getConnectionTimeout()

Get the connection timeout in seconds.

public getConnectionTimeout() : int
Return values
int —

Connection timeout in seconds. 0 means infinite.

getProxyHost()

Get the proxy host.

public getProxyHost() : string
Return values
string —

Proxy host.

getProxyPort()

Get the proxy port.

public getProxyPort() : int
Return values
int —

Proxy port.

isHttpProxyTunnelUsed()

Get the flag which indicates whether HTTP proxy tunnel is used or not.

public isHttpProxyTunnelUsed() : bool
Return values
bool —

true if HTTP proxy tunnel is used.

setConnectionTimeout()

Set a connection timeout in seconds.

public setConnectionTimeout(int $timeout) : Settings
Parameters
$timeout : int

Connection timeout in seconds. 0 means infinite.

Tags
throws
InvalidArgumentException

The type of the argument is not integer or its value is negative.

Return values
Settings —

$this object.

setHttpProxyTunnelUsed()

Set the flag which indicates whether HTTP proxy tunnel is used or not.

public setHttpProxyTunnelUsed(bool $used) : Settings
Parameters
$used : bool

true to use HTTP proxy tunnel.

Tags
throws
InvalidArgumentException

The type of the argument is not boolean.

Return values
Settings —

$this object.

setProxyHost()

Set a proxy host.

public setProxyHost(string $host) : Settings
Parameters
$host : string

Proxy host.

Tags
throws
InvalidArgumentException

The type of the argument is not string.

Return values
Settings —

$this object.

setProxyPort()

Set a proxy port.

public setProxyPort(int $port) : Settings
Parameters
$port : int

Proxy port.

Tags
throws
InvalidArgumentException

The type of the argument is not integer.

Return values
Settings —

$this object.

Search results