Класс MongoDB\Driver\ServerDescription

(mongodb >=1.13.0)

Введение

Класс MongoDB\Driver\ServerDescription — объект значения, который представляет сервер, к которому подключён драйвер. Экземпляры класса возвращаются методами MongoDB\Driver\Server::getServerDescription() и MongoDB\Driver\Monitoring\ServerChangedEvent.

Обзор класса

final class MongoDB\Driver\ServerDescription {
/* Константы */
const string TYPE_UNKNOWN = "Unknown";
const string TYPE_STANDALONE = "Standalone";
const string TYPE_MONGOS = "Mongos";
const string TYPE_POSSIBLE_PRIMARY = "PossiblePrimary";
const string TYPE_RS_PRIMARY = "RSPrimary";
const string TYPE_RS_SECONDARY = "RSSecondary";
const string TYPE_RS_ARBITER = "RSArbiter";
const string TYPE_RS_OTHER = "RSOther";
const string TYPE_RS_GHOST = "RSGhost";
const string TYPE_LOAD_BALANCER = "LoadBalancer";
/* Методы */
final public function getHelloResponse(): array
final public function getHost(): string
final public function getLastUpdateTime(): int
final public function getPort(): int
final public function getRoundTripTime(): ?int
final public function getType(): string
}

Предопределённые константы

MongoDB\Driver\ServerDescription::TYPE_UNKNOWN
Неизвестный тип сервера, который возвращает метод MongoDB\Driver\ServerDescription::getType().
MongoDB\Driver\ServerDescription::TYPE_STANDALONE
Тип автономного сервера, который возвращает метод MongoDB\Driver\ServerDescription::getType().
MongoDB\Driver\ServerDescription::TYPE_MONGOS
Тип сервера Mongos, который возвращает метод MongoDB\Driver\ServerDescription::getType().
MongoDB\Driver\ServerDescription::TYPE_POSSIBLE_PRIMARY
Набор реплик возможного типа первичного сервера, который возвращает метод MongoDB\Driver\ServerDescription::getType(). Сервер может быть определён как возможный первичный, если он ещё не был проверен, но другая память набора реплик считает его первичным.
MongoDB\Driver\ServerDescription::TYPE_RS_PRIMARY
Тип первичного сервера набора реплик, который возвращает метод MongoDB\Driver\ServerDescription::getType().
MongoDB\Driver\ServerDescription::TYPE_RS_SECONDARY
Тип вторичного сервера набора реплик, который возвращает метод MongoDB\Driver\ServerDescription::getType().
MongoDB\Driver\ServerDescription::TYPE_RS_ARBITER
Тип сервера арбитража набора реплик, который возвращает метод MongoDB\Driver\ServerDescription::getType().
MongoDB\Driver\ServerDescription::TYPE_RS_OTHER
Набор реплик другого типа сервера, который возвращает метод MongoDB\Driver\ServerDescription::getType(). Такие серверы могут быть скрыты, запускаться или восстанавливаться. Их нельзя запросить, но их списки хостов полезны для обнаружения текущей конфигурации набора реплик.
MongoDB\Driver\ServerDescription::TYPE_RS_GHOST

Тип сервера-призрака набора реплик, который возвращает метод MongoDB\Driver\ServerDescription::getType().

Серверы могут быть определены как таковые по крайней мере в трёх ситуациях: кратковременно во время запуска сервера; в неинициализированном наборе реплик; или когда сервер избегается (т. е. удаляется из конфигурации набора реплик). Они не могут быть запрошены, и их список хостов не может быть использован для обнаружения текущей конфигурации набора реплик; однако клиент может следить за этим сервером в надежде, что он перейдёт в более полезное состояние.
MongoDB\Driver\ServerDescription::TYPE_LOAD_BALANCER
Тип сервера балансировщика нагрузки, который возвращает метод MongoDB\Driver\ServerDescription::getType().

Содержание