win32-start-service-ctrl-dispatcher.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 4d72f13eaf9e06715ae68eac72aa3fd6ae83eb78 Maintainer: mch Status: ready -->
<!-- Reviewed: no -->
<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. -->
<refentry xml:id="function.win32-start-service-ctrl-dispatcher" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>win32_start_service_ctrl_dispatcher</refname>
  <refpurpose>Добавляет в Диспетчер Служб скрипт, который может быть использован, как служба с заданным именем</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>void</type><methodname>win32_start_service_ctrl_dispatcher</methodname>
   <methodparam><type>string</type><parameter>name</parameter></methodparam>
   <methodparam choice="opt"><type>bool</type><parameter>gracefulMode</parameter><initializer>true</initializer></methodparam>
  </methodsynopsis>

  <para>
   При запуске с помощью диспетчера служб, процессу службы необходимо
   сверяться с ним для мониторинга службы и связи с ней.
   Эта функция выполняет сверку посредством создания потока для обработки
   низкоуровневой связи с диспетчером служб.
  </para>
  <para>
   После запуска процесс службы должен осуществить два действия. Первое - сообщить
   диспетчеру служб, что служба запущена. Это осуществляется путём вызова <function>win32_set_service_status</function>
   с константой <constant>WIN32_SERVICE_RUNNING</constant>. Если вам необходимо выполнить
   некий длительный процесс перед запуском службы, то вы можете использовать константу
   <constant>WIN32_SERVICE_START_PENDING</constant>. Второе - продолжить сверку с диспетчером
   служб, чтобы определить необходимость отключения. Это осуществляется посредством
   периодического вызова <function>win32_get_last_control_message</function> и обработки
   кода возврата соответствующим образом.
  </para>
  <caution>
   <para>
    Начиная с версии 0.2.0, эта функция работает только в "cli" SAPI. В прочих SAPI
    функция отключена.
   </para>
  </caution>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>name</parameter></term>
     <listitem>
      <para>
       Короткое имя службы, как при добавлении с помощью
       <function>win32_create_service</function>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>gracefulMode</parameter></term>
     <listitem>
      <para>
       &true; для "элегантного" выхода. &false; для выхода с ошибкой. Смотрите
       <function>win32_set_service_exit_mode</function> для получения подробной информации.
      </para>
         </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.void;
  </para>
  <para>
    До версии 1.0.0, &win32service.noerror.false.error;
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   До версии 1.0.0, если SAPI не является <literal>"cli"</literal>, данная функция вызывает ошибку уровня <constant>E_ERROR</constant>.
   </para>
  <para>
   Начиная с версии 1.0.0, выбрасывает исключение
   <classname>Win32ServiceException</classname>, если SAPI не является <literal>"cli"</literal>
   </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>PECL win32service 1.0.0</entry>
       <entry>
        Выбрасывает <classname>ValueError</classname> при некорректных данных в параметрах,
        ранее возвращалось &false;.
       </entry>
      </row>
      <row>
       <entry>PECL win32service 1.0.0</entry>
       <entry>
        Выбрасывает <classname>Win32ServiceException</classname> в случае возникновения ошибки,
        ранее возвращался
        <link xmlns="http://docbook.org/ns/docbook" linkend="win32service.constants.errors">Код ошибки Win32</link>.
       </entry>
      </row>
      <row>
       <entry>PECL win32service 1.0.0</entry>
       <entry>
        Тип возвращаемого значения <type>void</type>, ранее был <type>mixed</type>.
       </entry>
      </row>
      <row>
       <entry>PECL win32service 0.4.0</entry>
       <entry>
        Добавлен параметр <parameter>gracefulMode</parameter>.
       </entry>
      </row>
      <row>
       <entry>PECL win32service 0.2.0</entry>
       <entry>
        Эта функция работает только с <literal>"cli"</literal> SAPI.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

<refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Пример <function>win32_start_service_ctrl_dispatcher</function></title>
    <para>
     Проверьте, запущен ли сервис в диспетчере служб.
    </para>
    <programlisting role="php">
<![CDATA[
<?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 секунд
  # перед соответствующим переходом в цикл.
}
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>win32_set_service_status</function></member>
    <member><function>win32_get_last_control_message</function></member>
    <member><function>win32_set_service_exit_mode</function></member>
    <member><function>win32_set_service_exit_code</function></member>
    <member><link linkend="win32service.constants.errors">Коды Ошибок Win32</link></member>
   </simplelist>
  </para>
 </refsect1>

</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->