Sentinel
class Sentinel (View source)
Relay Sentinel client.
Constants
| OPT_THROW_ON_ERR |
Whether to throw an exception on |
| OPT_AUTO_DISCOVER |
Whether \Relay\Sentinel should automatically discover other sentinels in the
cluster, so it may use them if we fail to communicate with the first one. |
Methods
Establishes a new connection to a Sentinel instance.
Check if the current Sentinel configuration is able to reach the quorum needed to failover a master, and the majority needed to authorize the failover.
Force a failover as if the master was not reachable, and without asking for agreement to other Sentinels.
Force Sentinel to rewrite its configuration on disk, including the current Sentinel state.
Returns the ip and port number of the master with that name.
Returns the state and info of the specified master.
Returns a list of monitored masters and their state.
Returns the ID of the Sentinel instance.
Returns PONG if no message is provided, otherwise returns the message.
Will reset all the masters with matching name.
Returns a list of sentinel instances for this master, and their state.
Show a list of replicas for this master, and their state.
Returns the last error message, if any.
Sets a client option.
Returns a client option.
Details
__construct(array|string|null $host = null, int $port = 26379, float $timeout = 0, mixed $persistent = null, int $retry_interval = 0, float $read_timeout = 0, mixed $auth = null)
Establishes a new connection to a Sentinel instance.
For backwards compatibility with PhpRedis 6.x, the constructor may be called with a single options array.
bool
ckquorum(string $master)
Check if the current Sentinel configuration is able to reach the quorum needed to failover a master, and the majority needed to authorize the failover.
bool
failover(string $master)
Force a failover as if the master was not reachable, and without asking for agreement to other Sentinels.
bool
flushconfig()
Force Sentinel to rewrite its configuration on disk, including the current Sentinel state.
array|false
getMasterAddrByName(string $master)
Returns the ip and port number of the master with that name.
array|false
master(string $master)
Returns the state and info of the specified master.
array|false
masters()
Returns a list of monitored masters and their state.
string
myid()
Returns the ID of the Sentinel instance.
string|bool
ping(string|null $message = null)
Returns PONG if no message is provided, otherwise returns the message.
int
reset(string $pattern)
Will reset all the masters with matching name.
array|false
sentinels(string $master)
Returns a list of sentinel instances for this master, and their state.
array|false
slaves(string $master)
Show a list of replicas for this master, and their state.
string|null
getLastError()
Returns the last error message, if any.
bool
setOption(int $option, mixed $value)
Sets a client option.
mixed
getOption(int $option)
Returns a client option.