No cache version.
Caching disabled. Default setting for this page:enabled (code LNG204)
If the display is too slow, you can disable the user mode to view the cached version.
win32 _start _service _ctrl _dispatcher
(PECL win32service >=0.1.0)
win32_start_service_ctrl_dispatcher — Registers the script with the SCM, so that it can act as the service with the given name
Description
When launched via the Service Control Manager, a service process is required to "check-in" with it to establish service monitoring and communication facilities. This function performs the check-in by spawning a thread to handle the lower-level communication with the service control manager.
Once started, the service process 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 process before the service is actually running, then you can
use the WIN32_SERVICE_START_PENDING
constant. The
second is to continue to check-in with the service control manager so that
it can determine if it should terminate. This is achieved by periodically
calling win32_get_last_control_message() and handling the
return code appropriately.
Since version 0.2.0, this function work only in "cli" SAPI. On other SAPI this function is disabled.
Parameters
-
name
-
The short-name of the service, as registered by win32_create_service().
-
gracefulMode
-
TRUE
for exit graceful.FALSE
for exit with error. See win32_set_service_exit_mode() for more details.
Return Values
Returns TRUE
on success, FALSE
if there is a problem with the parameters or a Win32 Error Code on failure.
Examples
Example #1 A win32_start_service_ctrl_dispatcher() example
Check if the service is runnig under the SCM.
<?php
if (!win32_start_service_ctrl_dispatcher('dummyphp')) {
die("I'm probably not running under the service control manager");
}
win32_set_service_status(WIN32_SERVICE_START_PENDING);
// Some lengthy process to get this service up and running.
win32_set_service_status(WIN32_SERVICE_RUNNING);
while (WIN32_SERVICE_CONTROL_STOP != win32_get_last_control_message()) {
# do some work here, trying not to take more than around 30 seconds
# before coming back into the loop again
}
?>
Changelog
Version | Description |
---|---|
0.4.0 |
The parameter gracefulMode has been added.
|
0.2.0 | This function works only in the "cli" SAPI. |
See Also
- win32_set_service_status() - Update the service status
- win32_get_last_control_message() - Returns the last control message that was sent to this service
- win32_set_service_exit_mode() - Define or return the exit mode for the current running service
- win32_set_service_exit_code() - Define or return the exit code for the current running service
- Win32 Error Codes
English translation
You have asked to visit this site in English. For now, only the interface is translated, but not all the content yet.If you want to help me in translations, your contribution is welcome. All you need to do is register on the site, and send me a message asking me to add you to the group of translators, which will give you the opportunity to translate the pages you want. A link at the bottom of each translated page indicates that you are the translator, and has a link to your profile.
Thank you in advance.
Document created the 30/01/2003, last modified the 26/10/2018
Source of the printed document:https://www.gaudry.be/en/php-rf-win32-start-service-ctrl-dispatcher.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.