RedisOptions

Extends \io\vertx\jphp\core\net\NetClientOptions

This object controls the connection setting to the Redis Server. There is no need to specify most of the settings since it has built the following sensible defaults: <p> * `encoding`: `UTF-8` * `host`: `localhost` * `port`: 6379 * `tcpKeepAlive`: true * `tcpNoDelay`: true * `binary`: false <p> However there are two extra properties that have no defaults since they are optional: <p> * `auth` * `select` <p> The usage of this two extra properties is to setup required authentication and optionally the selection of the active database at connection time. If you define this extra properties on every connection to Redis server this client will perform the authentication handshake and database selection, however if you don't do this and call @see \io\vertx\jphp\redis\RedisClient::auth yourself in case of connection failure the client will not be able to perform the correct authentication handshake.

package

Default

Methods

NetworkOptions constructor

__construct( $networkOptions = null) 
inherited

Arguments

$networkOptions

mixed | null

addCrlPath

addCrlPath( $crlPaths) : $this
inherited

Arguments

$crlPaths

string

Response

$this

addCrlValue

addCrlValue( $crlValues) : $this
inherited

Arguments

$crlValues

Buffer

Response

$this

addEnabledCipherSuite

addEnabledCipherSuite( $enabledCipherSuites) : $this
inherited

Arguments

$enabledCipherSuites

string

Response

$this

addEnabledSecureTransportProtocol

addEnabledSecureTransportProtocol( $enabledSecureTransportProtocols) : $this
inherited

Arguments

$enabledSecureTransportProtocols

string

Response

$this

addSentinel

addSentinel( $sentinels) : $this

Arguments

$sentinels

string

Response

$this

getAddress

getAddress() : string

Response

string

getAuth

getAuth() : string

Response

string

getConnectTimeout

getConnectTimeout() : integer
inherited

Response

integer

getCrlPaths

getCrlPaths() : array
inherited

Response

array

getCrlValues

getCrlValues() : array
inherited

Response

array

getDomainSocketAddress

getDomainSocketAddress() : string

Response

string

getEnabledCipherSuites

getEnabledCipherSuites() : array
inherited

Response

array

getEnabledSecureTransportProtocols

getEnabledSecureTransportProtocols() : array
inherited

Response

array

getEncoding

getEncoding() : string

Response

string

getHost

getHost() : string

Response

string

getHostnameVerificationAlgorithm

getHostnameVerificationAlgorithm() : string
inherited

Response

string

getIdleTimeout

getIdleTimeout() : integer
inherited

Response

integer

getIdleTimeoutUnit

getIdleTimeoutUnit() : string
inherited

Response

string

getJdkSslEngineOptions

getJdkSslEngineOptions() : \io\vertx\jphp\core\net\JdkSSLEngineOptions
inherited

getKeyStoreOptions

getKeyStoreOptions() : \io\vertx\jphp\core\net\JksOptions
inherited

getLocalAddress

getLocalAddress() : string
inherited

Response

string

getLogActivity

getLogActivity() : boolean
inherited

Response

boolean

getMasterName

getMasterName() : string

Response

string

getMetricsName

getMetricsName() : string
inherited

Response

string

getOpenSslEngineOptions

getOpenSslEngineOptions() : \io\vertx\jphp\core\net\OpenSSLEngineOptions
inherited

getPemKeyCertOptions

getPemKeyCertOptions() : \io\vertx\jphp\core\net\PemKeyCertOptions
inherited

getPemTrustOptions

getPemTrustOptions() : \io\vertx\jphp\core\net\PemTrustOptions
inherited

getPfxKeyCertOptions

getPfxKeyCertOptions() : \io\vertx\jphp\core\net\PfxOptions
inherited

getPfxTrustOptions

getPfxTrustOptions() : \io\vertx\jphp\core\net\PfxOptions
inherited

getPort

getPort() : integer

Response

integer

getProxyOptions

getProxyOptions() : \io\vertx\jphp\core\net\ProxyOptions
inherited

getReceiveBufferSize

getReceiveBufferSize() : integer
inherited

Response

integer

getReconnectAttempts

getReconnectAttempts() : integer
inherited

Response

integer

getReconnectInterval

getReconnectInterval() : integer
inherited

Response

integer

getSelect

getSelect() : integer

Response

integer

getSendBufferSize

getSendBufferSize() : integer
inherited

Response

integer

getSentinels

getSentinels() : array

Response

array

getSoLinger

getSoLinger() : integer
inherited

Response

integer

getTrafficClass

getTrafficClass() : integer
inherited

Response

integer

getTrustStoreOptions

getTrustStoreOptions() : \io\vertx\jphp\core\net\JksOptions
inherited

isBinary

isBinary() : boolean

Response

boolean

isDomainSocket

isDomainSocket() : boolean

Response

boolean

isReuseAddress

isReuseAddress() : boolean
inherited

Response

boolean

isReusePort

isReusePort() : boolean
inherited

Response

boolean

isSsl

isSsl() : boolean
inherited

Response

boolean

isTcpCork

isTcpCork() : boolean
inherited

Response

boolean

isTcpFastOpen

isTcpFastOpen() : boolean
inherited

Response

boolean

isTcpKeepAlive

isTcpKeepAlive() : boolean
inherited

Response

boolean

isTcpNoDelay

isTcpNoDelay() : boolean
inherited

Response

boolean

isTcpQuickAck

isTcpQuickAck() : boolean
inherited

Response

boolean

isTrustAll

isTrustAll() : boolean
inherited

Response

boolean

isUseAlpn

isUseAlpn() : boolean
inherited

Response

boolean

isUsePooledBuffers

isUsePooledBuffers() : boolean
inherited

Response

boolean

setAddress

setAddress( $address) : $this

Arguments

$address

string

Response

$this

setAuth

setAuth( $auth) : $this

Arguments

$auth

string

Response

$this

setBinary

setBinary( $binary) : $this

Arguments

$binary

boolean

Response

$this

setConnectTimeout

setConnectTimeout( $connectTimeout) : $this
inherited

Arguments

$connectTimeout

integer

Response

$this

setDomainSocket

setDomainSocket( $domainSocket) : $this

Arguments

$domainSocket

boolean

Response

$this

setDomainSocketAddress

setDomainSocketAddress( $domainSocketAddress) : $this

Arguments

$domainSocketAddress

string

Response

$this

setEnabledSecureTransportProtocols

setEnabledSecureTransportProtocols( $enabledSecureTransportProtocols) : $this
inherited

Arguments

$enabledSecureTransportProtocols

string

Response

$this

setEncoding

setEncoding( $encoding) : $this

Arguments

$encoding

string

Response

$this

setHost

setHost( $host) : $this

Arguments

$host

string

Response

$this

setHostnameVerificationAlgorithm

setHostnameVerificationAlgorithm( $hostnameVerificationAlgorithm) : $this
inherited

Arguments

$hostnameVerificationAlgorithm

string

Response

$this

setIdleTimeout

setIdleTimeout( $idleTimeout) : $this
inherited

Arguments

$idleTimeout

integer

Response

$this

setIdleTimeoutUnit

setIdleTimeoutUnit( $idleTimeoutUnit) : $this
inherited

Arguments

$idleTimeoutUnit

string

Response

$this

setJdkSslEngineOptions

setJdkSslEngineOptions( $jdkSslEngineOptions) : $this
inherited

Arguments

$jdkSslEngineOptions

JdkSSLEngineOptions|array

Response

$this

setKeyStoreOptions

setKeyStoreOptions( $keyStoreOptions) : $this
inherited

Arguments

$keyStoreOptions

JksOptions|array

Response

$this

setLocalAddress

setLocalAddress( $localAddress) : $this
inherited

Arguments

$localAddress

string

Response

$this

setLogActivity

setLogActivity( $logActivity) : $this
inherited

Arguments

$logActivity

boolean

Response

$this

setMasterName

setMasterName( $masterName) : $this

Arguments

$masterName

string

Response

$this

setMetricsName

setMetricsName( $metricsName) : $this
inherited

Arguments

$metricsName

string

Response

$this

setOpenSslEngineOptions

setOpenSslEngineOptions( $openSslEngineOptions) : $this
inherited

Arguments

$openSslEngineOptions

OpenSSLEngineOptions|array

Response

$this

setPemKeyCertOptions

setPemKeyCertOptions( $pemKeyCertOptions) : $this
inherited

Arguments

$pemKeyCertOptions

PemKeyCertOptions|array

Response

$this

setPemTrustOptions

setPemTrustOptions( $pemTrustOptions) : $this
inherited

Arguments

$pemTrustOptions

PemTrustOptions|array

Response

$this

setPfxKeyCertOptions

setPfxKeyCertOptions( $pfxKeyCertOptions) : $this
inherited

Arguments

$pfxKeyCertOptions

PfxOptions|array

Response

$this

setPfxTrustOptions

setPfxTrustOptions( $pfxTrustOptions) : $this
inherited

Arguments

$pfxTrustOptions

PfxOptions|array

Response

$this

setPort

setPort( $port) : $this

Arguments

$port

integer

Response

$this

setProxyOptions

setProxyOptions( $proxyOptions) : $this
inherited

Arguments

$proxyOptions

ProxyOptions|array

Response

$this

setReceiveBufferSize

setReceiveBufferSize( $receiveBufferSize) : $this
inherited

Arguments

$receiveBufferSize

integer

Response

$this

setReconnectAttempts

setReconnectAttempts( $reconnectAttempts) : $this
inherited

Arguments

$reconnectAttempts

integer

Response

$this

setReconnectInterval

setReconnectInterval( $reconnectInterval) : $this
inherited

Arguments

$reconnectInterval

integer

Response

$this

setReuseAddress

setReuseAddress( $reuseAddress) : $this
inherited

Arguments

$reuseAddress

boolean

Response

$this

setReusePort

setReusePort( $reusePort) : $this
inherited

Arguments

$reusePort

boolean

Response

$this

setSelect

setSelect( $select) : $this

Arguments

$select

integer

Response

$this

setSendBufferSize

setSendBufferSize( $sendBufferSize) : $this
inherited

Arguments

$sendBufferSize

integer

Response

$this

setSentinels

setSentinels( $sentinels) : $this

Arguments

$sentinels

string

Response

$this

setSoLinger

setSoLinger( $soLinger) : $this
inherited

Arguments

$soLinger

integer

Response

$this

setSsl

setSsl( $ssl) : $this
inherited

Arguments

$ssl

boolean

Response

$this

setTcpCork

setTcpCork( $tcpCork) : $this
inherited

Arguments

$tcpCork

boolean

Response

$this

setTcpFastOpen

setTcpFastOpen( $tcpFastOpen) : $this
inherited

Arguments

$tcpFastOpen

boolean

Response

$this

setTcpKeepAlive

setTcpKeepAlive( $tcpKeepAlive) : $this
inherited

Arguments

$tcpKeepAlive

boolean

Response

$this

setTcpNoDelay

setTcpNoDelay( $tcpNoDelay) : $this
inherited

Arguments

$tcpNoDelay

boolean

Response

$this

setTcpQuickAck

setTcpQuickAck( $tcpQuickAck) : $this
inherited

Arguments

$tcpQuickAck

boolean

Response

$this

setTrafficClass

setTrafficClass( $trafficClass) : $this
inherited

Arguments

$trafficClass

integer

Response

$this

setTrustAll

setTrustAll( $trustAll) : $this
inherited

Arguments

$trustAll

boolean

Response

$this

setTrustStoreOptions

setTrustStoreOptions( $trustStoreOptions) : $this
inherited

Arguments

$trustStoreOptions

JksOptions|array

Response

$this

setUseAlpn

setUseAlpn( $useAlpn) : $this
inherited

Arguments

$useAlpn

boolean

Response

$this

setUsePooledBuffers

setUsePooledBuffers( $usePooledBuffers) : $this
inherited

Arguments

$usePooledBuffers

boolean

Response

$this