PHP 8.4.1 Released!

    win32_set_service_status

    (PECL win32service >=0.1.0)

    win32_set_service_status — Met à jour le statut d'un service

    Description

    win32_set_service_status(int $status, int $checkpoint = 0): void

    Informe le SCM d'un statut courant d'un service qui fonctionne. Cet appel est seulement valide pour un processus de service qui fonctionne.

    Attention

    Depuis la version 0.2.0, cette fonction fonctionne uniquement en ligne de commande. Elle est désactivé dans les autres cas.

    Liste de paramètres

    status

    Le code de statut de service, un de WIN32_SERVICE_RUNNING, WIN32_SERVICE_STOPPED, WIN32_SERVICE_STOP_PENDING, WIN32_SERVICE_START_PENDING, WIN32_SERVICE_CONTINUE_PENDING, WIN32_SERVICE_PAUSE_PENDING, WIN32_SERVICE_PAUSED.

    checkpoint

    Cette valeur sera incrémentée par le service périodiquement pour reporter sa progression lors des opérations de démarrage, d'arrêt, de pause ou de reprise. Par exemple, le service incrémentera cette valeur lorsqu'il aura terminé chaque étape de son initialisation lors de son démarrage.

    checkpoint n'est valide que lorsque status est une des constantes suivantes : WIN32_SERVICE_STOP_PENDING, WIN32_SERVICE_START_PENDING, WIN32_SERVICE_CONTINUE_PENDING ou WIN32_SERVICE_PAUSE_PENDING.

    Valeurs de retour

    Aucune valeur n'est retournée.

    Avant la version 1.0.0, retournait WIN32_NO_ERROR on success, false if there is a problem with the parameters or a Win32 Error Code on failure.

    Erreurs / Exceptions

    Avant la version 1.0.0, si cette fonction est utilisé en dehors du SAPI "cli", une erreur E_ERROR sera émise.

    À partir de la version 1.0.0, lancera une Win32ServiceException si le SAPI n'est pas "cli"

    Historique

    Version Description
    PECL win32service 1.0.0 Lance une ValueError si un paramètre est invalide, avant false était retourné.
    PECL win32service 1.0.0 Lance une Win32ServiceException en cas d'erreur, avant un Code d'erreur Win32 était retourné.
    PECL win32service 1.0.0 Le type de retour est maintenant void, avant il était mixed.
    PECL win32service 0.2.0 Cette fonction fonctionne uniquement en ligne de commande.

    Voir aussi

    Improve This Page

    Learn How To Improve This Page • Submit a Pull Request • Report a Bug
    ＋add a note

    User Contributed Notes 2 notes

    up
    3
    m dot hald at surfto dot ch
    16 years ago
    On my Machine (Win XP SP2) the function "win32_get_last_control_message" never returns 4 so i will have to reply to 0 also.

    finally after mixing several examples i now have a version working woithout filling my event log with errors:

    <?php

    /*
    * PHP SAMPLE TEMPLATE
    */

    /*
    * APP MAIN FUNCTION
    * Called each second after the function last time finished
    * Should not take longer than max 20 seconds to execute
    * ELSE you should call NTServiceResponder(); at least each 20 secs
    * WARNING: NTServiceResponder will exit; if there was a STOP request
    */
    function Service_Main()
    {
    // YOU APPLICATION CODE HERE !!!
    sleep(1); // dummy something
    }

    /********************************************************************
    *
    * SERVICE CONTROLLING
    *
    ********************************************************************/

    $SERVICE_NAME = "phptestservice";
    $SERVICE_DISPLAY = "Test Service with PHP";

    // so u can get: $SERVICE_PATH_PARTS["dirname"] $SERVICE_PATH_PARTS["basename"] $SERVICE_PATH_PARTS["extension"]
    $SERVICE_PATH_PARTS = pathinfo(__FILE__);

    $SERVICE_PARAMS = " run";

    if (!isset(    $argv[1]))
    {
    die(    "this application need to be installed as a service.\n run with param install");
    }

    if (    $argv[1] == 'install')
    {
    $x = win32_create_service(array(
    'service' => $SERVICE_NAME,
    'display' => $SERVICE_DISPLAY,
    'params' => __FILE__ . $SERVICE_PARAMS,
    //'path' => $SERVICE_PATH_PARTS["dirname"] . '\php.exe'
    ));
    debug_zval_dump($x);
    exit;
    }
    else if (    $argv[1] == 'uninstall')
    {
    $x = win32_delete_service('dummyphp');
    debug_zval_dump($x);
    exit;
    }
    else if (    $argv[1] != 'run')
    {
    die(    "bogus args, needs to run as service");
    }

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

    // Main Server Loop
    while (1)
    {
    NTServiceResponder();

    // Main script goes here
    Service_Main();

    sleep(1); // at least 1 sec delay per loop
    }
    win32_set_service_status(WIN32_SERVICE_STOPPED);

    /*
    * Response to NTServiceRequests
    */
    function NTServiceResponder()
    {

    switch (    win32_get_last_control_message())
    {
    case     0: // PATCH for: seems never to go to 4 (WIN32_SERVICE_CONTROL_INTERROGATE)
    win32_set_service_status(WIN32_SERVICE_RUNNING);
    return     TRUE;
    break;
    case     WIN32_SERVICE_CONTROL_CONTINUE:
    return     TRUE; // "Continue"
    case WIN32_SERVICE_CONTROL_INTERROGATE:
    win32_set_service_status(WIN32_SERVICE_RUNNING);
    return     TRUE; // 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
    }

    return     FALSE;
    }

    ?>
    up
    -1
    paul_nelson57071 at yahoo dot com
    14 years ago
    So after much searching I finally found all the peices to make a working windows service & server including:
    - Installing & Uninstalling the service
    - Starting & Stopping the Service
    - Actually running a basic Server
    - Responding to windows Service to Stop/Start/Restart

    I hope you find this useful! I did this using PHP 5.2 and the PECL library for 5.2 (PHP 5.3 at the time does not have a PECL Library compiled for it)

    <?php
    //Service Settings
    $Service = 'MyServiceFinal';
    $Display = 'My PHP Service';

    //Server Settings
    $host = '127.0.0.1'; //Bind to IP #
    $port = 23; //On port #
    $max = 20; //Maximum Clients


    //Exit if no start-up argument is passed
    if (!isset($argv[1])){ShowHelp(); exit;}

    //Create Windows Service
    if ($argv[1] == 'install') {
    $x = win32_create_service(array(
    'service' => $Service,
    'display' => $Service,
    'params' => __file__ . ' run',
    'path' => 'c:\\php\\php.exe',
    ));
    debug_zval_dump($x);
    echo     "Service Installed\n\n";
    exit;

    //Remove Windows Service
    } else if ($argv[1] == 'uninstall') {
    $x = win32_delete_service($Service);
    debug_zval_dump($x);
    echo     "Service Removed\n\n";
    exit;

    //Start Windows Service
    } elseif($argv[1] == "start") {
    $x = win32_start_service($Service);
    debug_zval_dump($x);
    echo     "Service Started\n\n";
    exit;

    //Stop Windows Service
    } elseif($argv[1] == "stop") {
    $x = win32_stop_service($Service);
    debug_zval_dump($x);
    echo     "Service Stopped\n\n";
    exit;

    //Unkown Command
    } else if ($argv[1] != 'run') {
    ShowHelp(); exit();
    }

    //Tell windows the service has started...
    if (!win32_start_service_ctrl_dispatcher($Service)) die("Could not connect to service : $Service");
    win32_set_service_status(WIN32_SERVICE_RUNNING);

    // No timeouts, flush content immediatly
    set_time_limit(0);
    ob_implicit_flush();

    //Server Loop
    while (1) {
    usleep(500);

    //Handle Windows Service Request
    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
    }
    //Acutal Server Code

    }

    //Clean up and Exit
    win32_set_service_status(WIN32_SERVICE_STOPPED);
    exit;

    //*************** FUNCTIONS ***************
    function ShowHelp(){
    echo     "Usage:
    install:\t installs servce
    uninstall:\t deletes service
    start:\t\t Start the windows service
    stop:\t\t Stops the windows service
    run:\t\t called by CMS to run the service

    For information on code numbers type 'net helpmsg xxxx'
    EXAMPEL: 'net helpmsg 1072'

    "    ;
    }
    ?>
    ＋add a note
    To Top