ClusterOptions
in package
Table of Contents
- $analyticsTimeoutMilliseconds : int|null
- $authenticator : Authenticator|null
- $bootstrapTimeoutMilliseconds : int|null
- $configIdleRedialTimeoutMilliseconds : int|null
- $configPollFloorMilliseconds : int|null
- $configPollIntervalMilliseconds : int|null
- $connectTimeoutMilliseconds : int|null
- $dnsSrvTimeoutMilliseconds : int|null
- $enableClustermapNotification : bool|null
- $enableCompression : bool|null
- $enableDnsSrv : bool|null
- $enableMetrics : bool|null
- $enableMutationTokens : bool|null
- $enableTcpKeepAlive : bool|null
- $enableTls : bool|null
- $enableTracing : bool|null
- $enableUnorderedExecution : bool|null
- $idleHttpConnectionTimeoutMilliseconds : int|null
- $keyValueDurableTimeoutMilliseconds : int|null
- $keyValueTimeoutMilliseconds : int|null
- $loggingMeterOptions : LoggingMeterOptions|null
- $managementTimeoutMilliseconds : int|null
- $maxHttpConnections : int|null
- $network : string|null
- $queryTimeoutMilliseconds : int|null
- $resolveTimeoutMilliseconds : int|null
- $searchTimeoutMilliseconds : int|null
- $showQueries : bool|null
- $tcpKeepAliveIntervalMilliseconds : int|null
- $thresholdLoggingTracerOptions : ThresholdLoggingOptions|null
- $tlsVerifyMode : string|null
- $transactionsConfiguration : TransactionsConfiguration|null
- $trustCertificate : string|null
- $useIpProtocol : string|null
- $userAgentExtra : string|null
- $viewTimeoutMilliseconds : int|null
- analyticsTimeout() : ClusterOptions
- applyProfile() : void
- Applies configuration profile to ClusterOptions associating string to range of options
- authenticator() : ClusterOptions
- bootstrapTimeout() : ClusterOptions
- configIdleRedialTimeout() : ClusterOptions
- configPollFloor() : ClusterOptions
- configPollInterval() : ClusterOptions
- connectTimeout() : ClusterOptions
- credentials() : ClusterOptions
- dnsSrvTimeout() : ClusterOptions
- enableClustermapNotification() : ClusterOptions
- enableCompression() : ClusterOptions
- enableDnsSrv() : ClusterOptions
- enableMetrics() : ClusterOptions
- enableMutationTokens() : ClusterOptions
- enableTcpKeepAlive() : ClusterOptions
- enableTls() : ClusterOptions
- enableTracing() : ClusterOptions
- enableUnorderedExecution() : ClusterOptions
- getTransactionsConfiguration() : TransactionsConfiguration|null
- keyValueDurableTimeout() : ClusterOptions
- keyValueTimeout() : ClusterOptions
- managementTimeout() : ClusterOptions
- maxHttpConnections() : ClusterOptions
- network() : ClusterOptions
- queryTimeout() : ClusterOptions
- resolveTimeout() : ClusterOptions
- searchTimeout() : ClusterOptions
- showQueries() : ClusterOptions
- tcpKeepAliveInterval() : ClusterOptions
- thresholdLoggingTracerOptions() : ClusterOptions
- tlsVerify() : ClusterOptions
- transactionsConfiguration() : ClusterOptions
- trustCertificate() : ClusterOptions
- useIpProtocol() : ClusterOptions
- userAgentExtra() : ClusterOptions
- viewTimeout() : ClusterOptions
Properties
$analyticsTimeoutMilliseconds
private
int|null
$analyticsTimeoutMilliseconds
= null
$authenticator
private
Authenticator|null
$authenticator
$bootstrapTimeoutMilliseconds
private
int|null
$bootstrapTimeoutMilliseconds
= null
$configIdleRedialTimeoutMilliseconds
private
int|null
$configIdleRedialTimeoutMilliseconds
= null
$configPollFloorMilliseconds
private
int|null
$configPollFloorMilliseconds
= null
$configPollIntervalMilliseconds
private
int|null
$configPollIntervalMilliseconds
= null
$connectTimeoutMilliseconds
private
int|null
$connectTimeoutMilliseconds
= null
$dnsSrvTimeoutMilliseconds
private
int|null
$dnsSrvTimeoutMilliseconds
= null
$enableClustermapNotification
private
bool|null
$enableClustermapNotification
= null
$enableCompression
private
bool|null
$enableCompression
= null
$enableDnsSrv
private
bool|null
$enableDnsSrv
= null
$enableMetrics
private
bool|null
$enableMetrics
= null
$enableMutationTokens
private
bool|null
$enableMutationTokens
= null
$enableTcpKeepAlive
private
bool|null
$enableTcpKeepAlive
= null
$enableTls
private
bool|null
$enableTls
= null
$enableTracing
private
bool|null
$enableTracing
= null
$enableUnorderedExecution
private
bool|null
$enableUnorderedExecution
= null
$idleHttpConnectionTimeoutMilliseconds
private
int|null
$idleHttpConnectionTimeoutMilliseconds
= null
$keyValueDurableTimeoutMilliseconds
private
int|null
$keyValueDurableTimeoutMilliseconds
= null
$keyValueTimeoutMilliseconds
private
int|null
$keyValueTimeoutMilliseconds
= null
$loggingMeterOptions
private
LoggingMeterOptions|null
$loggingMeterOptions
= null
$managementTimeoutMilliseconds
private
int|null
$managementTimeoutMilliseconds
= null
$maxHttpConnections
private
int|null
$maxHttpConnections
= null
$network
private
string|null
$network
= null
$queryTimeoutMilliseconds
private
int|null
$queryTimeoutMilliseconds
= null
$resolveTimeoutMilliseconds
private
int|null
$resolveTimeoutMilliseconds
= null
$searchTimeoutMilliseconds
private
int|null
$searchTimeoutMilliseconds
= null
$showQueries
private
bool|null
$showQueries
= null
$tcpKeepAliveIntervalMilliseconds
private
int|null
$tcpKeepAliveIntervalMilliseconds
= null
$thresholdLoggingTracerOptions
private
ThresholdLoggingOptions|null
$thresholdLoggingTracerOptions
= null
$tlsVerifyMode
private
string|null
$tlsVerifyMode
= null
$transactionsConfiguration
private
TransactionsConfiguration|null
$transactionsConfiguration
= null
$trustCertificate
private
string|null
$trustCertificate
= null
$useIpProtocol
private
string|null
$useIpProtocol
= null
$userAgentExtra
private
string|null
$userAgentExtra
= null
$viewTimeoutMilliseconds
private
int|null
$viewTimeoutMilliseconds
= null
Methods
analyticsTimeout()
public
analyticsTimeout(int $milliseconds) : ClusterOptions
Parameters
- $milliseconds : int
Tags
Return values
ClusterOptions —applyProfile()
Applies configuration profile to ClusterOptions associating string to range of options
public
applyProfile(string $profile) : void
Parameters
- $profile : string
-
name of config profile to apply (e.g. wan_development)
Tags
Return values
void —authenticator()
public
authenticator(Authenticator $authenticator) : ClusterOptions
Parameters
- $authenticator : Authenticator
Tags
Return values
ClusterOptions —bootstrapTimeout()
public
bootstrapTimeout(int $milliseconds) : ClusterOptions
Parameters
- $milliseconds : int
Tags
Return values
ClusterOptions —configIdleRedialTimeout()
public
configIdleRedialTimeout(int $milliseconds) : ClusterOptions
Parameters
- $milliseconds : int
Tags
Return values
ClusterOptions —configPollFloor()
public
configPollFloor(int $milliseconds) : ClusterOptions
Parameters
- $milliseconds : int
Tags
Return values
ClusterOptions —configPollInterval()
public
configPollInterval(int $milliseconds) : ClusterOptions
Parameters
- $milliseconds : int
Tags
Return values
ClusterOptions —connectTimeout()
public
connectTimeout(int $milliseconds) : ClusterOptions
Parameters
- $milliseconds : int
Tags
Return values
ClusterOptions —credentials()
public
credentials(string $username, string $password) : ClusterOptions
Parameters
- $username : string
- $password : string
Tags
Return values
ClusterOptions —dnsSrvTimeout()
public
dnsSrvTimeout(int $milliseconds) : ClusterOptions
Parameters
- $milliseconds : int
Tags
Return values
ClusterOptions —enableClustermapNotification()
public
enableClustermapNotification(bool $enable) : ClusterOptions
Parameters
- $enable : bool
Tags
Return values
ClusterOptions —enableCompression()
public
enableCompression(bool $enable) : ClusterOptions
Parameters
- $enable : bool
Tags
Return values
ClusterOptions —enableDnsSrv()
public
enableDnsSrv(bool $enable) : ClusterOptions
Parameters
- $enable : bool
Tags
Return values
ClusterOptions —enableMetrics()
public
enableMetrics(bool $enable) : ClusterOptions
Parameters
- $enable : bool
Tags
Return values
ClusterOptions —enableMutationTokens()
public
enableMutationTokens(bool $enable) : ClusterOptions
Parameters
- $enable : bool
Tags
Return values
ClusterOptions —enableTcpKeepAlive()
public
enableTcpKeepAlive(bool $enable) : ClusterOptions
Parameters
- $enable : bool
Tags
Return values
ClusterOptions —enableTls()
public
enableTls(bool $enable) : ClusterOptions
Parameters
- $enable : bool
Tags
Return values
ClusterOptions —enableTracing()
public
enableTracing(bool $enable) : ClusterOptions
Parameters
- $enable : bool
Tags
Return values
ClusterOptions —enableUnorderedExecution()
public
enableUnorderedExecution(bool $enable) : ClusterOptions
Parameters
- $enable : bool
Tags
Return values
ClusterOptions —getTransactionsConfiguration()
public
getTransactionsConfiguration() : TransactionsConfiguration|null
Tags
Return values
TransactionsConfiguration|null —keyValueDurableTimeout()
public
keyValueDurableTimeout(int $milliseconds) : ClusterOptions
Parameters
- $milliseconds : int
Tags
Return values
ClusterOptions —keyValueTimeout()
public
keyValueTimeout(int $milliseconds) : ClusterOptions
Parameters
- $milliseconds : int
Tags
Return values
ClusterOptions —managementTimeout()
public
managementTimeout(int $milliseconds) : ClusterOptions
Parameters
- $milliseconds : int
Tags
Return values
ClusterOptions —maxHttpConnections()
public
maxHttpConnections(int $numberOfConnections) : ClusterOptions
Parameters
- $numberOfConnections : int
Tags
Return values
ClusterOptions —network()
public
network(string $networkSelector) : ClusterOptions
Parameters
- $networkSelector : string
Tags
Return values
ClusterOptions —queryTimeout()
public
queryTimeout(int $milliseconds) : ClusterOptions
Parameters
- $milliseconds : int
Tags
Return values
ClusterOptions —resolveTimeout()
public
resolveTimeout(int $milliseconds) : ClusterOptions
Parameters
- $milliseconds : int
Tags
Return values
ClusterOptions —searchTimeout()
public
searchTimeout(int $milliseconds) : ClusterOptions
Parameters
- $milliseconds : int
Tags
Return values
ClusterOptions —showQueries()
public
showQueries(bool $enable) : ClusterOptions
Parameters
- $enable : bool
Tags
Return values
ClusterOptions —tcpKeepAliveInterval()
public
tcpKeepAliveInterval(int $milliseconds) : ClusterOptions
Parameters
- $milliseconds : int
Tags
Return values
ClusterOptions —thresholdLoggingTracerOptions()
public
thresholdLoggingTracerOptions(ThresholdLoggingOptions $options) : ClusterOptions
Parameters
- $options : ThresholdLoggingOptions
Tags
Return values
ClusterOptions —tlsVerify()
public
tlsVerify(string $mode) : ClusterOptions
Parameters
- $mode : string
Tags
Return values
ClusterOptions —transactionsConfiguration()
public
transactionsConfiguration(TransactionsConfiguration $options) : ClusterOptions
Parameters
- $options : TransactionsConfiguration
Tags
Return values
ClusterOptions —trustCertificate()
public
trustCertificate(string $certificatePath) : ClusterOptions
Parameters
- $certificatePath : string
Tags
Return values
ClusterOptions —useIpProtocol()
public
useIpProtocol(string $mode) : ClusterOptions
Parameters
- $mode : string
-
"any", "forceIpv4" or "forceIpv6"
Tags
Return values
ClusterOptions —userAgentExtra()
public
userAgentExtra(string $userAgentExtraString) : ClusterOptions
Parameters
- $userAgentExtraString : string
Tags
Return values
ClusterOptions —viewTimeout()
public
viewTimeout(int $milliseconds) : ClusterOptions
Parameters
- $milliseconds : int