PHP Class Basho\Riak\Node\Config

Show file Open project: basho/riak-php-client Class Usage Examples

Protected Properties

Property Type Description
$auth boolean If true, client will use HTTPS (TLS1.2) to connect to Riak node
$ca_directory string [short description]
$ca_file
$certificate string Certificate to authenticate to Riak with
$certificate_password string Certificate to authenticate to Riak with
$connection_timeout integer Client side connection timeout
$host string Host address
$pass string User password
$port integer Port number
$private_key string [short description]
$private_key_password string [short description]
$stream_timeout integer Client side stream (socket read/write) timeout. Default is 60 seconds as that is the default operation timeout in Riak
$user string User name

Public Methods

Method Description
getCaDirectory ( ) : string
getCaFile ( ) : string
getCertificate ( ) : string
getCertificatePassword ( ) : string
getConnectionTimeout ( ) : integer
getHost ( ) : string
getPass ( ) : string
getPort ( ) : integer
getPrivateKey ( ) : string
getPrivateKeyPassword ( ) : string
getStreamTimeout ( ) : integer
getUser ( ) : string
isAuth ( ) : boolean
setAuth ( boolean $auth )
setCaDirectory ( string $ca_directory )
setCaFile ( string $ca_file )
setCertificate ( string $certificate )
setCertificatePassword ( string $certificate_password )
setConnectionTimeout ( integer $connection_timeout )
setHost ( string $host )
setPass ( string $pass )
setPort ( integer $port )
setPrivateKey ( string $private_key )
setPrivateKeyPassword ( string $private_key_password )
setStreamTimeout ( integer $stream_timeout )
setUser ( string $user )

Method Details

getCaDirectory() public method

public getCaDirectory ( ) : string
return string

getCaFile() public method

public getCaFile ( ) : string
return string

getCertificate() public method

public getCertificate ( ) : string
return string

getCertificatePassword() public method

public getCertificatePassword ( ) : string
return string

getConnectionTimeout() public method

public getConnectionTimeout ( ) : integer
return integer

getHost() public method

public getHost ( ) : string
return string

getPass() public method

public getPass ( ) : string
return string

getPort() public method

public getPort ( ) : integer
return integer

getPrivateKey() public method

public getPrivateKey ( ) : string
return string

getPrivateKeyPassword() public method

public getPrivateKeyPassword ( ) : string
return string

getStreamTimeout() public method

public getStreamTimeout ( ) : integer
return integer

getUser() public method

public getUser ( ) : string
return string

isAuth() public method

public isAuth ( ) : boolean
return boolean

setAuth() public method

public setAuth ( boolean $auth )
$auth boolean

setCaDirectory() public method

public setCaDirectory ( string $ca_directory )
$ca_directory string

setCaFile() public method

public setCaFile ( string $ca_file )
$ca_file string

setCertificate() public method

public setCertificate ( string $certificate )
$certificate string

setCertificatePassword() public method

public setCertificatePassword ( string $certificate_password )
$certificate_password string

setConnectionTimeout() public method

public setConnectionTimeout ( integer $connection_timeout )
$connection_timeout integer

setHost() public method

public setHost ( string $host )
$host string

setPass() public method

public setPass ( string $pass )
$pass string

setPort() public method

public setPort ( integer $port )
$port integer

setPrivateKey() public method

public setPrivateKey ( string $private_key )
$private_key string

setPrivateKeyPassword() public method

public setPrivateKeyPassword ( string $private_key_password )
$private_key_password string

setStreamTimeout() public method

public setStreamTimeout ( integer $stream_timeout )
$stream_timeout integer

setUser() public method

public setUser ( string $user )
$user string

Property Details

$auth protected property

If true, client will use HTTPS (TLS1.2) to connect to Riak node
protected bool $auth
return boolean

$ca_directory protected property

[short description]
protected string $ca_directory
return string

$ca_file protected property

protected $ca_file

$certificate protected property

Certificate to authenticate to Riak with
protected string $certificate
return string

$certificate_password protected property

Certificate to authenticate to Riak with
protected string $certificate_password
return string

$connection_timeout protected property

Client side connection timeout
protected int $connection_timeout
return integer

$host protected property

Host address
protected string $host
return string

$pass protected property

User password
protected string $pass
return string

$port protected property

Port number
protected int $port
return integer

$private_key protected property

[short description]
protected string $private_key
return string

$private_key_password protected property

[short description]
protected string $private_key_password
return string

$stream_timeout protected property

Client side stream (socket read/write) timeout. Default is 60 seconds as that is the default operation timeout in Riak
protected int $stream_timeout
return integer

$user protected property

User name
protected string $user
return string