win32_start_service_ctrl_dispatcher

(PECL win32service >=0.1.0)

win32_start_service_ctrl_dispatcherEnregistre un script avec SCM, alors il peut être interprété en tant que service avec le nom donné

Description

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

Lorsque exécuté via le Gestionnaire de Contrôle de Service, un processus de service est requis pour "archiver" avec lui pour établir un service de surveillance et de communication ergonomique. Cette fonction effectue un archivage en démarrant un thread pour gérer les communications de bas niveau avec le gestionnaire de contrôle de service.

Une fois démarré, le processus du service doit faire 2 choses. La première est d'indiquer au Service Control Manager que le service est en cours d'exécution. La seconde est d'appeler la fonction win32_set_service_status() avec la constante WIN32_SERVICE_RUNNING. Si vous avez besoin de lancer des processus longs avant que le service ne soit lancé, alors vous pouvez utiliser la constante WIN32_SERVICE_START_PENDING. La seconde est de continuer à vérifier en utilisant le Service Control Manager sachant qu'il peut déterminer si le service se termine ou non. Ceci consiste à appeler, périodiquement, la fonction win32_get_last_control_message() et à traiter le code retourné.

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

name

Le court nom du service, comme enregistré par win32_create_service().

gracefulMode

true pour la sortie gracieuse. false pour la sortie avec erreur. Voir win32_set_service_exit_mode() pour plus de détails.

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.4.0 Le paramètre gracefulMode a été ajouté.
PECL win32service 0.2.0 Cette fonction fonctionne uniquement en ligne de commande.

Exemples

Exemple #1 Exemple avec win32_start_service_ctrl_dispatcher()

Vérifie si le service fonctionne sous SCM.

<?php
if (!win32_start_service_ctrl_dispatcher('dummyphp')) {
die(
"Je ne fonctionne probablement pas sous le gestionnaire de contrôle de service");
}

win32_set_service_status(WIN32_SERVICE_START_PENDING);

// Quelques processus longs à récupérer pendant que le service fonctionne.

win32_set_service_status(WIN32_SERVICE_RUNNING);


while (
WIN32_SERVICE_CONTROL_STOP != win32_get_last_control_message()) {
# effectuer votre travail ici.
# essayez de ne pas prendre plus de 30 secondes avant de retourner au
}
?>

Voir aussi

add a note add a note

User Contributed Notes 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