Sentinel
class Sentinel
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 ip and port number of the primary with that name.
Returns the state and info of the specified master.
Returns the state and info of the specified primary.
Returns a list of monitored masters and their state.
Returns a list of monitored primaries 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
at line 4147
__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, array|null $context = 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.
at line 4167
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.
at line 4177
bool
failover(string $master)
Force a failover as if the master was not reachable, and without asking for agreement to other Sentinels.
at line 4186
bool
flushconfig()
Force Sentinel to rewrite its configuration on disk, including the current Sentinel state.
at line 4195
array|false
getMasterAddrByName(string $master)
Returns the ip and port number of the master with that name.
at line 4206
array|false
getPrimaryAddrByName(string $master)
Returns the ip and port number of the primary with that name.
at line 4215
array|false
master(string $master)
Returns the state and info of the specified master.
at line 4226
array|false
primary(string $master)
Returns the state and info of the specified primary.
at line 4234
array|false
masters()
Returns a list of monitored masters and their state.
at line 4244
array|false
primaries()
Returns a list of monitored primaries and their state.
at line 4252
string
myid()
Returns the ID of the Sentinel instance.
at line 4261
string|bool
ping(string|null $message = null)
Returns PONG if no message is provided, otherwise returns the message.
at line 4270
int
reset(string $pattern)
Will reset all the masters with matching name.
at line 4279
array|false
sentinels(string $master)
Returns a list of sentinel instances for this master, and their state.
at line 4288
array|false
slaves(string $master)
Show a list of replicas for this master, and their state.
at line 4296
string|null
getLastError()
Returns the last error message, if any.
at line 4306
bool
setOption(int $option, mixed $value)
Sets a client option.
at line 4315
mixed
getOption(int $option)
Returns a client option.