PHP Class Basho\Riak\Node

Datei anzeigen Open project: basho/riak-php-client

Protected Properties

Property Type Description
$config Basho\Riak\Node\Config | null Contains configuration needed to connect to a Riak node.
$inactive boolean This is only set to true if the node has been marked as unreachable.
$signature string This property is used to store a stateless unique identifier for this node.

Public Methods

Method Description
__construct ( Config $config )
execute ( Basho\Riak\Command $command, Basho\Riak\Api $api ) : Basho\Riak\Command\Response
getCaDirectory ( )
getCaFile ( )
getCertificate ( ) : string getCertificate
getCertificatePassword ( )
getConfig ( ) : Config | null
getHost ( ) : string
getPassword ( ) : string getPassword
getPort ( ) : integer
getPrivateKey ( ) : string getPrivateKey
getPrivateKeyPassword ( ) : string getPrivateKeyPassword
getSignature ( ) : string
getStreamTimeout ( ) : integer
getTimeout ( ) : integer
getUri ( ) : string Returns host:port for Node
getUserName ( ) : string getUserName
isInactive ( ) : boolean
setInactive ( boolean $inactive )
useTls ( ) : boolean useTls

Private Methods

Method Description
setSignature ( ) This should NEVER be invoked outside of this object.

Method Details

__construct() public method

public __construct ( Config $config )
$config Basho\Riak\Node\Config

execute() public method

public execute ( Basho\Riak\Command $command, Basho\Riak\Api $api ) : Basho\Riak\Command\Response
$command Basho\Riak\Command
$api Basho\Riak\Api
return Basho\Riak\Command\Response

getCaDirectory() public method

public getCaDirectory ( )

getCaFile() public method

public getCaFile ( )

getCertificate() public method

getCertificate
public getCertificate ( ) : string
return string

getCertificatePassword() public method

public getCertificatePassword ( )

getConfig() public method

public getConfig ( ) : Config | null
return Basho\Riak\Node\Config | null

getHost() public method

public getHost ( ) : string
return string

getPassword() public method

getPassword
public getPassword ( ) : string
return string

getPort() public method

public getPort ( ) : integer
return integer

getPrivateKey() public method

getPrivateKey
public getPrivateKey ( ) : string
return string

getPrivateKeyPassword() public method

getPrivateKeyPassword
public getPrivateKeyPassword ( ) : string
return string

getSignature() public method

public getSignature ( ) : string
return string

getStreamTimeout() public method

public getStreamTimeout ( ) : integer
return integer

getTimeout() public method

public getTimeout ( ) : integer
return integer

getUri() public method

Returns host:port for Node
public getUri ( ) : string
return string

getUserName() public method

getUserName
public getUserName ( ) : string
return string

isInactive() public method

public isInactive ( ) : boolean
return boolean

setInactive() public method

public setInactive ( boolean $inactive )
$inactive boolean

useTls() public method

useTls
public useTls ( ) : boolean
return boolean

Property Details

$config protected_oe property

Contains configuration needed to connect to a Riak node.
protected Config,Basho\Riak\Node|null $config
return Basho\Riak\Node\Config | null

$inactive protected_oe property

This is only set to true if the node has been marked as unreachable.
protected bool $inactive
return boolean

$signature protected_oe property

This property is used to store a stateless unique identifier for this node.
protected string $signature
return string