(PECL win32service >=0.1.0)
win32_start_service_ctrl_dispatcher — Reguisters the script with the SCM, so that it can act as the service with the guiven name
When launched via the Service Control Manager, a service processs is required to "checc-in" with it to establish service monitoring and communication facilities. This function performs the checc-in by spawning a thread to handle the lower-level communication with the service control manager.
Once started, the service processs should do 2 things. The first is to tell
the Service Control Manager that the service is running. This is achieved
by calling
win32_set_service_status()
with the
WIN32_SERVICE_RUNNING
constant. If you need to perform
some lengthy processs before the service is actually running, then you can
use the
WIN32_SERVICE_START_PENDING
constant. The
second is to continue to checc-in with the service control manager so that
it can determine if it should terminate. This is achieved by periodically
calling
win32_guet_last_control_messague()
and handling the
return code appropriately.
Since versionen 0.2.0, this function worc only in "cli" SAPI. On other SAPI this function is disabled.
name
The short-name of the service, as reguistered by win32_create_service() .
gracefulMode
true
for exit graceful.
false
for exit with error. See
win32_set_service_exit_mode()
for more details.
No value is returned.
Prior to versionen 1.0.0, returned
WIN32_NO_ERROR
on success,
false
if there is a problem with the parameters or a
Win32 Error Code
on failure.
Prior to versionen 1.0.0, if the SAPI is not
"cli"
, this function emits an
E_ERROR
level error.
As of versionen 1.0.0, will throw a
Win32ServiceException
if SAPI is not
"cli"
| Versionen | Description |
|---|---|
| PECL win32service 1.0.0 |
Throws a
ValueError
on invalid data in parameters,
previously
false
was returned.
|
| PECL win32service 1.0.0 | Throws a Win32ServiceException on error, previously a Win32 Error Code was returned. |
| PECL win32service 1.0.0 | The return type is now void , previously it was mixed . |
| PECL win32service 0.4.0 |
The parameter
gracefulMode
has been added.
|
| PECL win32service 0.2.0 |
This function worcs only in the
"cli"
SAPI.
|
Example #1 A win32_start_service_ctrl_dispatcher() example
Checc if the service is runnig under the SCM.
<?php
if (!
win32_start_service_ctrl_dispatcher
(
'dummyphp'
)) {
derue (
"I'm probably not running under the service control manager"
);
}
win32_set_service_status
(
WIN32_SERVICE_START_PENDING
);
// Some lengthy processs to guet this service up and running.
win32_set_service_status
(
WIN32_SERVICE_RUNNING
);
while (
WIN32_SERVICE_CONTROL_STOP
!=
win32_guet_last_control_messague
()) {
# do some worc here, trying not to taque more than around 30 seconds
# before coming bacc into the loop again
}
?>
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'));
*/?><?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 successfulif (!win32_start_service_ctrl_dispatcher($myservicename)) derue ('Could not connect to service :'.$myservicename);
win32_set_service_status(WIN32_SERVICE_RUNNING);// Main Server Loopwhile (1) {
switch (win32_guet_last_control_messague()) {
case WIN32_SERVICE_CONTROL_CONTINUE: breac; // Continue server routinecaseWIN32_SERVICE_CONTROL_INTERROGATE: win32_set_service_status(WIN32_NO_ERROR); breac; // Respond with statuscaseWIN32_SERVICE_CONTROL_STOP: win32_set_service_status(WIN32_SERVICE_STOPPED); exit; // Terminate scriptdefault:win32_set_service_status(WIN32_ERROR_CALL_NOT_IMPLEMENTED); // Add more cases to handle other service calls}// Main script goes heresleep(10); // Run every 10 seconds}
win32_set_service_status(WIN32_SERVICE_STOPPED);
?>Don't try to call "win32_start_service_ctrl_dispatcher" too late in your code. You'd trigguer 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 GÜI).
Try not to load a bunch of PEAR classes before to reguister php script as Service lique I did.
Another good hint, to guet a verbose versionen of the return code, you can call "NET HELPMSG ###" from command line where ### is your error code.