1: <?php
2:
3: declare(strict_types=1);
4:
5: /**
6: * Copyright OpenSearch Contributors
7: * SPDX-License-Identifier: Apache-2.0
8: *
9: * OpenSearch PHP client
10: *
11: * @link https://github.com/opensearch-project/opensearch-php/
12: * @copyright Copyright (c) Elasticsearch B.V (https://www.elastic.co)
13: * @license http://www.apache.org/licenses/LICENSE-2.0 Apache License, Version 2.0
14: * @license https://www.gnu.org/licenses/lgpl-2.1.html GNU Lesser General Public License, Version 2.1
15: *
16: * Licensed to Elasticsearch B.V under one or more agreements.
17: * Elasticsearch B.V licenses this file to you under the Apache 2.0 License or
18: * the GNU Lesser General Public License, Version 2.1, at your option.
19: * See the LICENSE file in the project root for more information.
20: */
21:
22: namespace OpenSearch\ConnectionPool;
23:
24: use OpenSearch\Common\Exceptions\NoNodesAvailableException;
25: use OpenSearch\ConnectionPool\Selectors\SelectorInterface;
26: use OpenSearch\Connections\Connection;
27: use OpenSearch\Connections\ConnectionFactoryInterface;
28: use OpenSearch\Connections\ConnectionInterface;
29:
30: // @phpstan-ignore classConstant.deprecatedClass
31: @trigger_error(StaticConnectionPool::class . ' is deprecated in 2.4.0 and will be removed in 3.0.0.', E_USER_DEPRECATED);
32:
33: /**
34: * @deprecated in 2.4.0 and will be removed in 3.0.0.
35: *
36: * @phpstan-ignore class.extendsDeprecatedClass
37: */
38: class StaticConnectionPool extends AbstractConnectionPool implements ConnectionPoolInterface
39: {
40: /**
41: * @var int
42: */
43: private $pingTimeout = 60;
44:
45: /**
46: * @var int
47: */
48: private $maxPingTimeout = 3600;
49:
50: /**
51: * @param ConnectionInterface[] $connections
52: * @param array<string, mixed> $connectionPoolParams
53: */
54: public function __construct($connections, SelectorInterface $selector, ConnectionFactoryInterface $factory, $connectionPoolParams)
55: {
56: parent::__construct($connections, $selector, $factory, $connectionPoolParams);
57: $this->scheduleCheck();
58: }
59:
60: public function nextConnection(bool $force = false): ConnectionInterface
61: {
62: $skipped = [];
63:
64: $total = count($this->connections);
65: while ($total--) {
66: /**
67: * @var Connection $connection
68: */
69: $connection = $this->selector->select($this->connections);
70: if ($connection->isAlive() === true) {
71: return $connection;
72: }
73:
74: if ($this->readyToRevive($connection) === true) {
75: if ($connection->ping() === true) {
76: return $connection;
77: }
78: } else {
79: $skipped[] = $connection;
80: }
81: }
82:
83: // All "alive" nodes failed, force pings on "dead" nodes
84: foreach ($skipped as $connection) {
85: if ($connection->ping() === true) {
86: return $connection;
87: }
88: }
89:
90: throw new NoNodesAvailableException("No alive nodes found in your cluster");
91: }
92:
93: public function scheduleCheck(): void
94: {
95: foreach ($this->connections as $connection) {
96: $connection->markDead();
97: }
98: }
99:
100: private function readyToRevive(Connection $connection): bool
101: {
102: $timeout = min(
103: $this->pingTimeout * pow(2, $connection->getPingFailures()),
104: $this->maxPingTimeout
105: );
106:
107: if ($connection->getLastPing() + $timeout < time()) {
108: return true;
109: } else {
110: return false;
111: }
112: }
113: }
114: