Создаёт новую запись службы в базе данных SCM

Описание

win32_create_service(array $details, string $machine = null): void

Функция пробует добавить службу в базу данных SCM. Для этого требуются права администратора.

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

details

Массив деталей службы:

service

Краткое название службы. Это имя для управления службой командой net. Служба должна быть уникальной (двум службам нельзя иметь одно и то же название) и, в идеале, не должна содержать пробелов в названии.

display

Отображаемое имя службы. Это имя, которое показывает апплет служб.

description

Подробное описание услуги. Это описание, которое показывает апплет служб.

user

Имя учётной записи пользователя, под которой требуется запускать службу. Если этот параметр не указали, служба будет работать под учётной записью LocalSystem. При установке имени пользователя требуется указать и пароль.

password

Пароль, который соответствуют пользователю user.

path

Полный путь к исполняемому модулю, который ОС запустит при запуске службы. Функция будет использовать путь к текущему процессу PHP, если параметр не указали.

params

Параметры командной строки для передачи службе при её запуске. Если вы хотите запустить скрипт PHP как службу, то первым параметром должен быть полный путь к скрипту PHP, который вы собираетесь запустить. Полный путь к скрипту берут в кавычки ", если имя скрипта или путь содержат пробелы.

load_order

Управляет load_order. Ещё не полностью поддерживается.

svc_type

Устанавливает тип службы. Если опустили, функция будет использовать значение по умолчанию WIN32_SERVICE_WIN32_OWN_PROCESS. Это значение изменяют, когда точно знают, что делают.

start_type

Устанавливает способ запуска службы. По умолчанию используется WIN32_SERVICE_AUTO_START, что означает, что служба будет запущена при запуске машины.

error_control

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

delayed_start

Если для параметра delayed_start установили значение true, это проинформирует БД SCM о том, что требуется запустить службу после запуска других служб автозапуска, плюс небольшая задержка.

Любую службу можно пометить как службу с отложенным автозапуском; однако этот параметр не действует, если значением параметра start_type службы не равно WIN32_SERVICE_AUTO_START.

Параметр применим только в Windows Vista и Windows Server 2008 или более поздних версиях.

base_priority

Чтобы уменьшить влияние на загрузку процессора, иногда требуется установка базового приоритета ниже обычного.

Параметр base_priority принимает значение константы из списка базовых классов приоритета Win32.

dependencies

Чтобы определить зависимости для службы, иногда требуется установка для параметра списка имён служб в массиве.

recovery_delay

Параметр определяет задержку между ошибкой и выполнением действия восстановления. Значение указывают в миллисекундах.

Значение по умолчанию равно 60000.

recovery_action_1

Действие, которое выполнится при первой ошибке. Значение по умолчанию — WIN32_SC_ACTION_NONE.

Параметр recovery_action_1 принимает значение константы из списка действий восстановления Win32.

recovery_action_2

Действие, которое выполнится при второй ошибке. Значение по умолчанию — WIN32_SC_ACTION_NONE.

Параметр recovery_action_2 принимает значение константы из списка действий восстановления Win32.

recovery_action_3

Действие, которое выполнится при очередных ошибках. Значение по умолчанию — WIN32_SC_ACTION_NONE.

Параметр recovery_action_3 принимает значение константы из списка действий восстановления Win32.

recovery_reset_period

Параметр определяет задержку, после которой сбрасывается счётчик отказов. Задержку указывают в секундах.

Значение по умолчанию равно 86400.

recovery_enabled

Со значением true параметр включает настройки восстановления, со значением false — отключает.

Значение по умолчанию равно false

recovery_reboot_msg

Параметр определяет сообщение, которое сохраняется в журнале событий Windows перед перезагрузкой. Функция учитывает параметр, только если для какого-то действия установили значение WIN32_SC_ACTION_REBOOT.

recovery_command

Параметр определяет команду, которая выполняется, если какое-либо действие определили как WIN32_SC_ACTION_RUN_COMMAND.

machine

Необязательное имя машины, на которой требуется создать службу. Функция будет работать с локальной машиной, если параметр не указали.

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

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

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

Ошибки

Функция выбрасывает исключение ValueError, если значение параметра service не задали.

Функция выбрасывает исключение ValueError, если значение параметра path не задали.

Функция выбрасывает исключение ValueError, если значение параметра svc_type указали неверно.

Функция выбрасывает исключение ValueError, если значение параметра start_type указали неверно.

Функция выбрасывает исключение ValueError, если значение параметра error_control указали неверно.

Функция выбрасывает исключение ValueError, если значение параметра base_priority указали неверно.

Функция выбрасывает исключение ValueError, если значение параметра recovery_delay выходит за пределы значений от 0 до PHP_INT_MAX.

Выбрасывается ValueError, если значение параметра recovery_action_1 указано неверно.

Выбрасывается ValueError, если значение параметра recovery_action_2 указано неверно.

Функция выбрасывает исключение ValueError, если значение параметра recovery_action_3 указали неверно.

Функция выбрасывает исключение ValueError, значение параметра recovery_reset_period выходит за пределы значений от 0 и PHP_INT_MAX.

Функция выбрасывает исключение 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	Добавили параметры `dependencies`, `recovery_delay`, `recovery_action_1`, `recovery_action_2`, `recovery_action_3`, `recovery_reset_period`, `recovery_enabled`, `recovery_reboot_msg` и `recovery_command`.

Примеры

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

Пример создаёт сервис с кратким названием 'dummyphp'.

<?php

$x = win32_create_service(array(
    'service'     => 'dummyphp',                                           // Название сервиса
    'display'     => 'sample dummy PHP service',                           // Краткое описание
    'description' => 'This is a dummy Windows service created using PHP.', // Полное описание
    'params'      => '"' . __FILE__ . '"  run',                            // Путь до скрипта и параметров
));

debug_zval_dump($x);

?>

Пример #2 Пример работы функции win32_create_service() с зависимостями

Пример создаёт сервис с кратким названием 'dummyphp' и зависимостями.

<?php

$x = win32_create_service(array(
    'service'      => 'dummyphp',                                           // Название сервиса
    'display'      => 'sample dummy PHP service',                           // Краткое описание
    'description'  => 'This is a dummy Windows service created using PHP.', // Полное описание
    'params'       => '"' . __FILE__ . '"  run',                            // Путь до скрипта и параметров
    'dependencies' => array("Netman"),                                      // Список зависимостей
));

debug_zval_dump($x);

?>

Пример #3 Пример работы функции win32_create_service() с восстановлением

Пример создаёт сервис с кратким названием 'dummyphp' и настройками восстановления.

<?php

$x = win32_create_service(array(
    'service'               => 'dummyphp',                                           // Название сервиса
    'display'               => 'sample dummy PHP service',                           // Краткое описание
    'description'           => 'This is a dummy Windows service created using PHP.', // Полное описание
    'params'                => '"' . __FILE__ . '"  run',                            // Путь до скрипта и параметров
    'recovery_delay'        => 120000,                                               // Действие восстановления выполняется через 2 минуты.
    'recovery_action_1'     => WIN32_SC_ACTION_RESTART,                              // При первом сбое перезапускается служба.
    'recovery_action_2'     => WIN32_SC_ACTION_RUN_COMMAND,                          // При втором сбое выполняется команда
    'recovery_action_3'     => WIN32_SC_ACTION_NONE,                                 // При последующих сбоях ничего не делать
    'recovery_reset_period' => 86400,                                                // Сбросить счётчик ошибок через 1 день
    'recovery_enabled'      => true,                                                 // Включить параметр восстановления
    'recovery_reboot_msg'   => null,                                                 // Не определяйте сообщение о перезагрузке, здесь оно не требуется
    'recovery_command'      => "c:\clean-service.bat",                               // Когда действие — WIN32_SC_ACTION_RUN_COMMAND, выполняется эта команда
));

debug_zval_dump($x);

?>

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

win32_delete_service() - Удаляет запись службы из базы данных SCM
Базовые классы приоритета Win32
Действия восстановления Win32
Коды ошибок Win32