mirror of
https://github.com/php-win-ext/phpredis.git
synced 2026-03-24 09:02:07 +01:00
749 lines
24 KiB
HTML
749 lines
24 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="UTF-8" />
|
|
<meta name="robots" content="index, follow, all" />
|
|
<title>RedisSentinel | PhpRedis API</title>
|
|
|
|
<link rel="stylesheet" type="text/css" href="css/bootstrap.min.css">
|
|
<link rel="stylesheet" type="text/css" href="css/bootstrap-theme.min.css">
|
|
<link rel="stylesheet" type="text/css" href="css/doctum.css">
|
|
<link rel="stylesheet" type="text/css" href="fonts/doctum-font.css">
|
|
<script src="js/jquery-3.5.1.slim.min.js"></script>
|
|
<script async defer src="doctum.js"></script>
|
|
<script async defer src="js/bootstrap.min.js"></script>
|
|
<script async defer src="js/autocomplete.min.js"></script>
|
|
<meta name="MobileOptimized" content="width">
|
|
<meta name="HandheldFriendly" content="true">
|
|
<meta name="viewport" content="width=device-width,initial-scale=1,maximum-scale=1">
|
|
|
|
<link rel="search"
|
|
type="application/opensearchdescription+xml"
|
|
href="https://phpredis.github.io/opensearch.xml"
|
|
title="PhpRedis API (main)" />
|
|
</head>
|
|
|
|
<body id="class" data-name="class:RedisSentinel" data-root-path="" data-search-index-url="doctum-search.json">
|
|
<div id="content">
|
|
<div id="left-column">
|
|
<div id="control-panel">
|
|
<div class="search-bar hidden" id="search-progress-bar-container">
|
|
<div class="progress">
|
|
<div class="progress-bar" role="progressbar" id="search-progress-bar"
|
|
aria-valuenow="0" aria-valuemin="0" aria-valuemax="100" style="width: 0%"></div>
|
|
</div>
|
|
</div>
|
|
<form id="search-form" action="search.html">
|
|
<span class="icon icon-search"></span>
|
|
<input name="search"
|
|
id="doctum-search-auto-complete"
|
|
class="typeahead form-control"
|
|
type="search"
|
|
placeholder="Search"
|
|
spellcheck="false"
|
|
autocorrect="off"
|
|
autocomplete="off"
|
|
autocapitalize="off">
|
|
<div class="auto-complete-results" id="auto-complete-results"></div>
|
|
</form>
|
|
</div>
|
|
|
|
<div id="api-tree"></div>
|
|
|
|
</div>
|
|
<div id="right-column">
|
|
<nav id="site-nav" class="navbar navbar-default" role="navigation">
|
|
<div class="container-fluid">
|
|
<div class="navbar-header">
|
|
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar-elements">
|
|
<span class="sr-only">Toggle navigation</span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
</button>
|
|
<a class="navbar-brand" href="index.html">PhpRedis API</a>
|
|
</div>
|
|
<div class="collapse navbar-collapse" id="navbar-elements">
|
|
<ul class="nav navbar-nav">
|
|
<li><a href="classes.html">Classes</a></li>
|
|
<li><a href="interfaces.html">Interfaces</a></li>
|
|
<li><a href="traits.html">Traits</a></li>
|
|
<li><a href="doc-index.html">Index</a></li>
|
|
<li><a href="search.html">Search</a></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<div id="page-content">
|
|
<div class="page-header">
|
|
<h1>RedisSentinel
|
|
</h1>
|
|
</div>
|
|
|
|
|
|
<p> class
|
|
<strong>RedisSentinel</strong> (<a href="https://github.com/phpredis/phpredis/blob/main/redis_sentinel.stub.php">View source</a>)
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2>Methods</h2>
|
|
|
|
<div class="container-fluid underlined">
|
|
<div class="row">
|
|
<div class="col-md-2 type">
|
|
|
|
</div>
|
|
<div class="col-md-8">
|
|
<a href="#method___construct">__construct</a>(string $host, int $port = 26379, float $timeout = 0, mixed $persistent = null, int $retry_interval = 0, float $read_timeout = 0, mixed $auth = null, array $context = null)
|
|
|
|
<p class="no-description">No description</p>
|
|
</div>
|
|
<div class="col-md-2"></div>
|
|
</div>
|
|
<div class="row">
|
|
<div class="col-md-2 type">
|
|
bool|<a href="RedisSentinel.html">RedisSentinel</a>
|
|
</div>
|
|
<div class="col-md-8">
|
|
<a href="#method_ckquorum">ckquorum</a>(string $master)
|
|
|
|
<p class="no-description">No description</p>
|
|
</div>
|
|
<div class="col-md-2"></div>
|
|
</div>
|
|
<div class="row">
|
|
<div class="col-md-2 type">
|
|
bool|<a href="RedisSentinel.html">RedisSentinel</a>
|
|
</div>
|
|
<div class="col-md-8">
|
|
<a href="#method_failover">failover</a>(string $master)
|
|
|
|
<p class="no-description">No description</p>
|
|
</div>
|
|
<div class="col-md-2"></div>
|
|
</div>
|
|
<div class="row">
|
|
<div class="col-md-2 type">
|
|
bool|<a href="RedisSentinel.html">RedisSentinel</a>
|
|
</div>
|
|
<div class="col-md-8">
|
|
<a href="#method_flushconfig">flushconfig</a>()
|
|
|
|
<p class="no-description">No description</p>
|
|
</div>
|
|
<div class="col-md-2"></div>
|
|
</div>
|
|
<div class="row">
|
|
<div class="col-md-2 type">
|
|
array|bool|<a href="RedisSentinel.html">RedisSentinel</a>
|
|
</div>
|
|
<div class="col-md-8">
|
|
<a href="#method_getMasterAddrByName">getMasterAddrByName</a>(string $master)
|
|
|
|
<p class="no-description">No description</p>
|
|
</div>
|
|
<div class="col-md-2"></div>
|
|
</div>
|
|
<div class="row">
|
|
<div class="col-md-2 type">
|
|
array|bool|<a href="RedisSentinel.html">RedisSentinel</a>
|
|
</div>
|
|
<div class="col-md-8">
|
|
<a href="#method_master">master</a>(string $master)
|
|
|
|
<p class="no-description">No description</p>
|
|
</div>
|
|
<div class="col-md-2"></div>
|
|
</div>
|
|
<div class="row">
|
|
<div class="col-md-2 type">
|
|
array|bool|<a href="RedisSentinel.html">RedisSentinel</a>
|
|
</div>
|
|
<div class="col-md-8">
|
|
<a href="#method_masters">masters</a>()
|
|
|
|
<p class="no-description">No description</p>
|
|
</div>
|
|
<div class="col-md-2"></div>
|
|
</div>
|
|
<div class="row">
|
|
<div class="col-md-2 type">
|
|
string
|
|
</div>
|
|
<div class="col-md-8">
|
|
<a href="#method_myid">myid</a>()
|
|
|
|
<p class="no-description">No description</p>
|
|
</div>
|
|
<div class="col-md-2"></div>
|
|
</div>
|
|
<div class="row">
|
|
<div class="col-md-2 type">
|
|
bool|<a href="RedisSentinel.html">RedisSentinel</a>
|
|
</div>
|
|
<div class="col-md-8">
|
|
<a href="#method_ping">ping</a>()
|
|
|
|
<p class="no-description">No description</p>
|
|
</div>
|
|
<div class="col-md-2"></div>
|
|
</div>
|
|
<div class="row">
|
|
<div class="col-md-2 type">
|
|
bool|<a href="RedisSentinel.html">RedisSentinel</a>
|
|
</div>
|
|
<div class="col-md-8">
|
|
<a href="#method_reset">reset</a>(string $pattern)
|
|
|
|
<p class="no-description">No description</p>
|
|
</div>
|
|
<div class="col-md-2"></div>
|
|
</div>
|
|
<div class="row">
|
|
<div class="col-md-2 type">
|
|
array|bool|<a href="RedisSentinel.html">RedisSentinel</a>
|
|
</div>
|
|
<div class="col-md-8">
|
|
<a href="#method_sentinels">sentinels</a>(string $master)
|
|
|
|
<p class="no-description">No description</p>
|
|
</div>
|
|
<div class="col-md-2"></div>
|
|
</div>
|
|
<div class="row">
|
|
<div class="col-md-2 type">
|
|
array|bool|<a href="RedisSentinel.html">RedisSentinel</a>
|
|
</div>
|
|
<div class="col-md-8">
|
|
<a href="#method_slaves">slaves</a>(string $master)
|
|
|
|
<p class="no-description">No description</p>
|
|
</div>
|
|
<div class="col-md-2"></div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<h2>Details</h2>
|
|
|
|
<div id="method-details">
|
|
<div class="method-item">
|
|
<h3 id="method___construct">
|
|
<div class="location"><a href="https://github.com/phpredis/phpredis/blob/main/redis_sentinel.stub.php#L11">at line 11</a></div>
|
|
<code>
|
|
<strong>__construct</strong>(string $host, int $port = 26379, float $timeout = 0, mixed $persistent = null, int $retry_interval = 0, float $read_timeout = 0, mixed $auth = null, array $context = null)
|
|
</code>
|
|
</h3>
|
|
<div class="details">
|
|
|
|
|
|
|
|
<div class="method-description">
|
|
<p class="no-description">No description</p>
|
|
|
|
</div>
|
|
<div class="tags">
|
|
<h4>Parameters</h4>
|
|
|
|
<table class="table table-condensed">
|
|
<tr>
|
|
<td>string</td>
|
|
<td>$host</td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td>int</td>
|
|
<td>$port</td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td>float</td>
|
|
<td>$timeout</td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td>mixed</td>
|
|
<td>$persistent</td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td>int</td>
|
|
<td>$retry_interval</td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td>float</td>
|
|
<td>$read_timeout</td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td>mixed</td>
|
|
<td>$auth</td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td>array</td>
|
|
<td>$context</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<div class="method-item">
|
|
<h3 id="method_ckquorum">
|
|
<div class="location"><a href="https://github.com/phpredis/phpredis/blob/main/redis_sentinel.stub.php#L14">at line 14</a></div>
|
|
<code> bool|<a href="RedisSentinel.html">RedisSentinel</a>
|
|
<strong>ckquorum</strong>(string $master)
|
|
</code>
|
|
</h3>
|
|
<div class="details">
|
|
|
|
|
|
|
|
<div class="method-description">
|
|
<p class="no-description">No description</p>
|
|
|
|
</div>
|
|
<div class="tags">
|
|
<h4>Parameters</h4>
|
|
|
|
<table class="table table-condensed">
|
|
<tr>
|
|
<td>string</td>
|
|
<td>$master</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
<h4>Return Value</h4>
|
|
|
|
<table class="table table-condensed">
|
|
<tr>
|
|
<td>bool|<a href="RedisSentinel.html">RedisSentinel</a></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<div class="method-item">
|
|
<h3 id="method_failover">
|
|
<div class="location"><a href="https://github.com/phpredis/phpredis/blob/main/redis_sentinel.stub.php#L17">at line 17</a></div>
|
|
<code> bool|<a href="RedisSentinel.html">RedisSentinel</a>
|
|
<strong>failover</strong>(string $master)
|
|
</code>
|
|
</h3>
|
|
<div class="details">
|
|
|
|
|
|
|
|
<div class="method-description">
|
|
<p class="no-description">No description</p>
|
|
|
|
</div>
|
|
<div class="tags">
|
|
<h4>Parameters</h4>
|
|
|
|
<table class="table table-condensed">
|
|
<tr>
|
|
<td>string</td>
|
|
<td>$master</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
<h4>Return Value</h4>
|
|
|
|
<table class="table table-condensed">
|
|
<tr>
|
|
<td>bool|<a href="RedisSentinel.html">RedisSentinel</a></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<div class="method-item">
|
|
<h3 id="method_flushconfig">
|
|
<div class="location"><a href="https://github.com/phpredis/phpredis/blob/main/redis_sentinel.stub.php#L20">at line 20</a></div>
|
|
<code> bool|<a href="RedisSentinel.html">RedisSentinel</a>
|
|
<strong>flushconfig</strong>()
|
|
</code>
|
|
</h3>
|
|
<div class="details">
|
|
|
|
|
|
|
|
<div class="method-description">
|
|
<p class="no-description">No description</p>
|
|
|
|
</div>
|
|
<div class="tags">
|
|
|
|
<h4>Return Value</h4>
|
|
|
|
<table class="table table-condensed">
|
|
<tr>
|
|
<td>bool|<a href="RedisSentinel.html">RedisSentinel</a></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<div class="method-item">
|
|
<h3 id="method_getMasterAddrByName">
|
|
<div class="location"><a href="https://github.com/phpredis/phpredis/blob/main/redis_sentinel.stub.php#L23">at line 23</a></div>
|
|
<code> array|bool|<a href="RedisSentinel.html">RedisSentinel</a>
|
|
<strong>getMasterAddrByName</strong>(string $master)
|
|
</code>
|
|
</h3>
|
|
<div class="details">
|
|
|
|
|
|
|
|
<div class="method-description">
|
|
<p class="no-description">No description</p>
|
|
|
|
</div>
|
|
<div class="tags">
|
|
<h4>Parameters</h4>
|
|
|
|
<table class="table table-condensed">
|
|
<tr>
|
|
<td>string</td>
|
|
<td>$master</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
<h4>Return Value</h4>
|
|
|
|
<table class="table table-condensed">
|
|
<tr>
|
|
<td>array|bool|<a href="RedisSentinel.html">RedisSentinel</a></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<div class="method-item">
|
|
<h3 id="method_master">
|
|
<div class="location"><a href="https://github.com/phpredis/phpredis/blob/main/redis_sentinel.stub.php#L26">at line 26</a></div>
|
|
<code> array|bool|<a href="RedisSentinel.html">RedisSentinel</a>
|
|
<strong>master</strong>(string $master)
|
|
</code>
|
|
</h3>
|
|
<div class="details">
|
|
|
|
|
|
|
|
<div class="method-description">
|
|
<p class="no-description">No description</p>
|
|
|
|
</div>
|
|
<div class="tags">
|
|
<h4>Parameters</h4>
|
|
|
|
<table class="table table-condensed">
|
|
<tr>
|
|
<td>string</td>
|
|
<td>$master</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
<h4>Return Value</h4>
|
|
|
|
<table class="table table-condensed">
|
|
<tr>
|
|
<td>array|bool|<a href="RedisSentinel.html">RedisSentinel</a></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<div class="method-item">
|
|
<h3 id="method_masters">
|
|
<div class="location"><a href="https://github.com/phpredis/phpredis/blob/main/redis_sentinel.stub.php#L29">at line 29</a></div>
|
|
<code> array|bool|<a href="RedisSentinel.html">RedisSentinel</a>
|
|
<strong>masters</strong>()
|
|
</code>
|
|
</h3>
|
|
<div class="details">
|
|
|
|
|
|
|
|
<div class="method-description">
|
|
<p class="no-description">No description</p>
|
|
|
|
</div>
|
|
<div class="tags">
|
|
|
|
<h4>Return Value</h4>
|
|
|
|
<table class="table table-condensed">
|
|
<tr>
|
|
<td>array|bool|<a href="RedisSentinel.html">RedisSentinel</a></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<div class="method-item">
|
|
<h3 id="method_myid">
|
|
<div class="location"><a href="https://github.com/phpredis/phpredis/blob/main/redis_sentinel.stub.php#L31">at line 31</a></div>
|
|
<code> string
|
|
<strong>myid</strong>()
|
|
</code>
|
|
</h3>
|
|
<div class="details">
|
|
|
|
|
|
|
|
<div class="method-description">
|
|
<p class="no-description">No description</p>
|
|
|
|
</div>
|
|
<div class="tags">
|
|
|
|
<h4>Return Value</h4>
|
|
|
|
<table class="table table-condensed">
|
|
<tr>
|
|
<td>string</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<div class="method-item">
|
|
<h3 id="method_ping">
|
|
<div class="location"><a href="https://github.com/phpredis/phpredis/blob/main/redis_sentinel.stub.php#L34">at line 34</a></div>
|
|
<code> bool|<a href="RedisSentinel.html">RedisSentinel</a>
|
|
<strong>ping</strong>()
|
|
</code>
|
|
</h3>
|
|
<div class="details">
|
|
|
|
|
|
|
|
<div class="method-description">
|
|
<p class="no-description">No description</p>
|
|
|
|
</div>
|
|
<div class="tags">
|
|
|
|
<h4>Return Value</h4>
|
|
|
|
<table class="table table-condensed">
|
|
<tr>
|
|
<td>bool|<a href="RedisSentinel.html">RedisSentinel</a></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<div class="method-item">
|
|
<h3 id="method_reset">
|
|
<div class="location"><a href="https://github.com/phpredis/phpredis/blob/main/redis_sentinel.stub.php#L37">at line 37</a></div>
|
|
<code> bool|<a href="RedisSentinel.html">RedisSentinel</a>
|
|
<strong>reset</strong>(string $pattern)
|
|
</code>
|
|
</h3>
|
|
<div class="details">
|
|
|
|
|
|
|
|
<div class="method-description">
|
|
<p class="no-description">No description</p>
|
|
|
|
</div>
|
|
<div class="tags">
|
|
<h4>Parameters</h4>
|
|
|
|
<table class="table table-condensed">
|
|
<tr>
|
|
<td>string</td>
|
|
<td>$pattern</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
<h4>Return Value</h4>
|
|
|
|
<table class="table table-condensed">
|
|
<tr>
|
|
<td>bool|<a href="RedisSentinel.html">RedisSentinel</a></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<div class="method-item">
|
|
<h3 id="method_sentinels">
|
|
<div class="location"><a href="https://github.com/phpredis/phpredis/blob/main/redis_sentinel.stub.php#L40">at line 40</a></div>
|
|
<code> array|bool|<a href="RedisSentinel.html">RedisSentinel</a>
|
|
<strong>sentinels</strong>(string $master)
|
|
</code>
|
|
</h3>
|
|
<div class="details">
|
|
|
|
|
|
|
|
<div class="method-description">
|
|
<p class="no-description">No description</p>
|
|
|
|
</div>
|
|
<div class="tags">
|
|
<h4>Parameters</h4>
|
|
|
|
<table class="table table-condensed">
|
|
<tr>
|
|
<td>string</td>
|
|
<td>$master</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
<h4>Return Value</h4>
|
|
|
|
<table class="table table-condensed">
|
|
<tr>
|
|
<td>array|bool|<a href="RedisSentinel.html">RedisSentinel</a></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<div class="method-item">
|
|
<h3 id="method_slaves">
|
|
<div class="location"><a href="https://github.com/phpredis/phpredis/blob/main/redis_sentinel.stub.php#L43">at line 43</a></div>
|
|
<code> array|bool|<a href="RedisSentinel.html">RedisSentinel</a>
|
|
<strong>slaves</strong>(string $master)
|
|
</code>
|
|
</h3>
|
|
<div class="details">
|
|
|
|
|
|
|
|
<div class="method-description">
|
|
<p class="no-description">No description</p>
|
|
|
|
</div>
|
|
<div class="tags">
|
|
<h4>Parameters</h4>
|
|
|
|
<table class="table table-condensed">
|
|
<tr>
|
|
<td>string</td>
|
|
<td>$master</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
<h4>Return Value</h4>
|
|
|
|
<table class="table table-condensed">
|
|
<tr>
|
|
<td>array|bool|<a href="RedisSentinel.html">RedisSentinel</a></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
</div><div id="footer">
|
|
Generated by <a href="https://github.com/code-lts/doctum">Doctum, a API Documentation generator and fork of Sami</a>.</div></div>
|
|
</div>
|
|
</body>
|
|
|
|
</html>
|