PHP 8.4.1 Released!

win32_start_service_ctrl_dispatcher

(PECL win32service >=0.1.0)

win32_start_service_ctrl_dispatcher Регистрирует скрипт в Диспетчере управления службами, чтобы он действовал как служба с заданным именем

Описание

win32_start_service_ctrl_dispatcher(string $name, bool $gracefulMode = true): void

При запуске через Диспетчер управления службами (англ. Service Control Manager, SCM) процессу службы требуется «отметиться» в диспетчере, чтобы установить средства мониторинга службы и связи с ней. Функция выполняет такую регистрацию, для чего создаёт поток для обработки низкоуровневой связи с Диспетчером управления службами.

После запуска процесс службы выполняет два действия. Первое — сообщает Диспетчеру управления службами, что служба запустилась. Для этого вызывают функцию win32_set_service_status() с константой WIN32_SERVICE_RUNNING. Функцию вызывают с константой WIN32_SERVICE_START_PENDING, когда требуется выполнить какой-то длительный процесс до фактического запуска службы. Второе — продолжает «отмечаться» в Диспетчере управления службами, чтобы диспетчер определял, требуется ли прекратить работу службы. Для этого периодически вызывают функцию win32_get_last_control_message() и правильно обрабатывают кода возврата.

Предостережение

С версии 0.2.0 функция работает только через SAPI-интерфейс CLI. Через другие SAPI-интерфейсы функция не работает.

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

name

Короткое имя службы, которое зарегистрировали функцией win32_create_service().

gracefulMode

Значение true указывают для изящного выхода, а значение false для выхода с ошибкой. Описание функции win32_set_service_exit_mode() даёт больше информации о режимах выхода.

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

Функция не возвращает значения после выполнения.

До версии 1.0.0 Функция возвращает WIN32_NO_ERROR в случае успешного завершения , false, если возникла проблема с параметрами, или код ошибки Win32, если возникла ошибка.

Ошибки

До версии 1.0.0 при вызове не через SAPI-интерфейс CLI функция выдаёт ошибку уровня E_ERROR.

С версии 1.0.0 при вызове не через SAPI-интерфейс CLI функция выбрасывает исключение Win32ServiceException.

Список изменений

Версия Описание
PECL-модуль win32service 1.0.0 Функция выбрасывает исключение ValueError при недопустимых данных в параметрах, раньше возвращалось false.
PECL-модуль win32service 1.0.0 Функция выбрасывает исключение Win32ServiceException, если возникла ошибка, раньше возвращался код ошибки Win32.
PECL-модуль win32service 1.0.0 Тип значения, которое возвращает функция, теперь void, раньше был mixed.
PECL win32service 0.4.0 Добавили параметр gracefulMode.
PECL win32service 0.2.0 Функция работает только через SAPI-интерфейс CLI.

Примеры

Пример #1 Пример использования функции win32_start_service_ctrl_dispatcher()

Проверим, запустили ли сервис в Диспетчере управления службами.

<?php

if (!win32_start_service_ctrl_dispatcher('dummyphp')) {
die(
"Меня, вероятно, не запустили в Диспетчере управления службами");
}

win32_set_service_status(WIN32_SERVICE_START_PENDING);

// Какой-то длительный процесс для обработки и запуска службы

win32_set_service_status(WIN32_SERVICE_RUNNING);

while (
WIN32_SERVICE_CONTROL_STOP != win32_get_last_control_message()) {
# Здесь выполняются какие-то действия, которые не занимают больше 30 секунд
# перед переходом в цикл
}

?>

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

Добавить

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

up
0
andrea
15 years ago
Insert value of params between " if the string have a space:

<?php
// First you need to create a service, you only need to do this once
/*
win32_create_service(array(
'service' => 'myphpservice',
'display' => 'My PHP Service',
'params' => '"c:\\my folder\myphpservice.php"',
'path' => 'c:\\PHP\\php.exe'));
*/
?>
up
-1
dylan at nopower dot org
17 years ago
<?php
// First you need to create a service, you only need to do this once
/*
win32_create_service(array(
'service' => 'myphpservice',
'display' => 'My PHP Service',
'params' => 'c:\\myphpservice.php',
'path' => 'c:\\PHP\\php.exe'));
*/

$myservicename = 'myphpservice';

// Connect to service dispatcher and notify that startup was successful
if (!win32_start_service_ctrl_dispatcher($myservicename)) die('Could not connect to service :'.$myservicename);
win32_set_service_status(WIN32_SERVICE_RUNNING);

// Main Server Loop
while (1) {
switch (
win32_get_last_control_message()) {
case
WIN32_SERVICE_CONTROL_CONTINUE: break; // Continue server routine
case WIN32_SERVICE_CONTROL_INTERROGATE: win32_set_service_status(WIN32_NO_ERROR); break; // Respond with status
case WIN32_SERVICE_CONTROL_STOP: win32_set_service_status(WIN32_SERVICE_STOPPED); exit; // Terminate script
default: win32_set_service_status(WIN32_ERROR_CALL_NOT_IMPLEMENTED); // Add more cases to handle other service calls
}

// Main script goes here

sleep(10); // Run every 10 seconds
}
win32_set_service_status(WIN32_SERVICE_STOPPED);
?>
up
-2
Guibod
17 years ago
Don't try to call "win32_start_service_ctrl_dispatcher" too late in your code. You'd trigger a #2186 error : "The service is not responding to the control function." (from commande line) or a #1053 error : "The service did not respond to the start or control request in a timely fashion." (from services GUI).

Try not to load a bunch of PEAR classes before to register php script as Service like I did.

Another good hint, to get a verbose version of the return code, you can call "NET HELPMSG ###" from command line where ### is your error code.
To Top