Memcache::addServer

memcache_add_server

(PECL memcache >= 2.0.0)

Memcache::addServer -- memcache_add_server — Добавляет сервер memcached в пул соединений

Описание

Memcache::addServer(
    string $host,
    int $port = 11211,
    bool $persistent = ?,
    int $weight = ?,
    int $timeout = ?,
    int $retry_interval = ?,
    bool $status = ?,
    callable $failure_callback = ?,
    int $timeoutms = ?
): bool

memcache_add_server(
    Memcache $memcache,
    string $host,
    int $port = 11211,
    bool $persistent = ?,
    int $weight = ?,
    int $timeout = ?,
    int $retry_interval = ?,
    bool $status = ?,
    callable $failure_callback = ?,
    int $timeoutms = ?
): bool

Метод Memcache::addServer() добавляет сервер в пул соединений.

В отличие от методов Memcache::connect() и Memcache::pconnect() при вызове этого метода сетевое соединение не устанавливается, пока не потребуется. Поэтому при добавлении большого количества серверов в пул производительность не снижается, поскольку, возможно, соединения не потребуются.

Потребность в отказоустойчивости возникает на любом этапе в любом методе, и если при этом хотя бы один сервер из пула окажется доступен, пользователь не получит оповещения. Любой тип ошибки сокета или сервера Memcached, за исключением ошибки переполнения памяти, может включить протокол обеспечения отказоустойчивости. Стандартные клиентские ошибки наподобие добавления существующего ключа не вызовут такого поведения.

Замечание:
Метод добавили в модуль Memcache версии 2.0.0.

Список параметров

host

Параметр указывает на хост с запущенным сервисом memcached. Для параметра возможно установить значение наподобие unix:///path/to/memcached.sock для соединения с Unix-сокетом, но тогда для параметра port потребуется установить значение 0.

port

Параметр указывает порт, по которому доступен сервис memcached. Для соединения с Unix-сокетом потребуется установить для параметра значение 0.

Обратите внимание: значение параметра port по умолчанию равно значению директивы memcache.default_port. Поэтому при вызове метода рекомендуют указывать номер порта.

persistent

Устанавливать ли постоянное соединение. Значение по умолчанию равно true.

weight

Необходимое количество созданных пакетов данных для этого сервера, что, в свою очередь, определяет вероятность выбора сервера. Вероятность рассчитывается относительно общего веса всех серверов.

timeout

Время ожидания в секундах для подключения к демону. Изменение значения по умолчанию в 1 секунду часто нивелирует преимущества кеширования на медленных соединениях.

retry_interval

Параметр управляет частотой проверки доступности отказавшего сервера, значение по умолчанию равно 15 секундам. Со значением "-1" попытки проверить доступность сервера не выполняются. Ни этот параметр, ни параметр persistent не оказывают никакого влияния, если модуль загружен динамически через функцию dl().

Каждая провалившаяся структура соединения содержит своё значение времени ожидания, и, пока оно не превышено, структура пропускается, после чего попробует выбрать другой сервер для обслуживания запроса. После истечения времени ожидания соединение либо удачно переустанавливается, либо помечается провалившимся и ожидает еще столько секунуд, сколько указали в параметре retry_interval. Обычно эффект заключается в том, что каждый процесс веб-сервера ожидает секунд при обслуживании запроса, сколько указали в параметре retry_interval.

status

Параметр определяет, помечать ли сервер флагом "онлайн". Одновременная установка значения false для этого параметра и значения -1 для параметра retry_interval оставит отказавший сервер в пуле, чтобы не влиять на алгоритм распределения ключей. Запрос к этому серверу либо запустит механизм отказоустойчивости, либо сразу же прервётся с ошибкой, в зависимости от настройки директивы memcache.allow_failover. Значение по умолчанию равно true — сервер активен и готов принимать запросы.

failure_callback

Пользовательская callback-функция, которая запустится при ошибке. Эта функция вызывается до запуска механизма отказоустойчивости. Функция принимает два параметра — имя хоста и порт отказавшего сервера.

timeoutms

Возвращаемые значения

Функция возвращает true, если выполнилась успешно, или false, если возникла ошибка.

Примеры

Пример #1 Пример добавления сервера в пул соединений методом Memcache::addServer()

<?php

/* Объектно-ориентированный API */
$memcache = new Memcache;
$memcache->addServer('memcache_host', 11211);
$memcache->addServer('memcache_host2', 11211);

/* Процедурный API */
$memcache_obj = memcache_connect('memcache_host', 11211);
memcache_add_server($memcache_obj, 'memcache_host2', 11211);

?>

Примечания

Внимание

При пропуске параметра port метод извлекает значение ini-директивы PHP memcache.default_port. При изменении значения директивы в коде приложения поведение метода становится непредсказуемым. Поэтому лучше явно указывать порт при вызове метода.

Смотрите также

Memcache::connect() - Открывает соединение с сервером memcached
Memcache::pconnect() - Открывает постоянное соединение с сервером memcached
Memcache::close() - Закрывает соединение с сервером memcached
Memcache::setServerParams() - Изменяет параметры и статус сервера во время выполнения
Memcache::getServerStatus() - Возвращает статус сервера

Нашли ошибку?

Инструкция • Исправление • Сообщение об ошибке

＋Добавить

Примечания пользователей 6 notes

down

rstaveley at seseit dot com ¶

14 years ago

The Memcache client library is responsible for picking the right server to set/get data. That's why addServer is what you want to use rather than connect, when you have more than one Memcache server. A subsequent set/get will then connect on demand to the appropriate instance as needs be. Disconnection to whatever servers were connected to happening when you close or your script terminates.

Memcache instances added to your Memcache object via addServer should be added in the same order in your application to ensure that the same server is picked for use with the same key. 

A client library may be implemented to run a CRC on the key and do a modulus over the number of instances in the list to select an instance from the list for the set/get. This ensures that data is spread nicely across the nodes. 

That all works nicely behind the scenes for you in your PHP code, as long as you add your list of Memcache instances in a consistent manner with addServer.

down

enno dot rehling at gmail dot com ¶

13 years ago

The $timeoutms argument can be used to specify the timeout in milliseconds, but isn't available in all versions. For example, it exists in php_memcache 2.2.6, but not in 3.0.4. In 2.2.6, if you specify it, then it overrides $timeout.

Caveat emptor: If $timeoutms is not specified, it defaults to the value of memcache.default_timeout_ms in php.ini, which defaults to 1000 if not set. This also overrides $timeout, which has the curious effect that $timeout is always ignored in php_memcache 2.2.6 (either in favor of $timeoutms, memcache.default_timeout_ms or the value 1000, in that order of priority).

down

joewynn dot nz+phpnet at gmail dot com ¶

11 years ago

Note that this method will always return TRUE because a connection is not actually made at call time. See this bug report for more information: https://bugs.php.net/bug.php?id=58193

down

eu at serbannistor dot ro ¶

14 years ago

Actually if you have two memcached servers from which one of them is on localhost, and the other is on a remote machine you can communicate with both even if you specify the loopback address for the local one.

<?php
$memcache_obj = memcache_connect("127.0.0.1", 11211);
memcache_add_server($memcache_obj, "memcache_remote_host");
$memcache_obj->set('var_key', time());
?>

This WILL communicate with both hosts but however there are two aspects that must be taken into account:
1. the communication will be done through different network interfaces with the two hosts. It will use the loopback interface for the "127.0.0.1" host (lo in my case on Linux) and the external interface for the "memcache_remote_host" (eth0 in my case). Only if you want to use the same network interface to communicate with both hosts you must use the external IPs of both machines (and all communication will go out through the eth0 interface).
2. the connection with the two hosts will be established differently because of how memcache_connect() and memcache_add_server() work. Therefore the memcache_connect() will initiate the connection to localhost through the loopback interface when it is called, while memcache_add_server() will just add the second server to the pool, but it will not send any package through the network until it's absolutely needed (for example when a memcache_set() command is issued).

down

iwind dot liu at gmail dot com ¶

15 years ago

The weight of the server must be greater than 0.



If there is no memcached server to use, and you try to set/add variables, the apache will be crashed, with the error message "[notice] child pid 18725 exit signal Segmentation fault (11)" in error_log file.

down

-6

Jean-Baptiste Quenot ¶

17 years ago

The default value for the "weight" argument is 1

＋Добавить