Mirrors
/
nssm
mirror of http://git.nssm.cc/nssm/nssm.git
2
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
master
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'db1d114d82'
${ noResults }
nssm/service.h

122 lines
4.3 KiB
C
Raw Normal View History Unescape Escape

NSSM 1.0.
22 years ago
#ifndef SERVICE_H
#define SERVICE_H
Grant SeServiceLogonRight. If the service is to be run under a user account, ensure that the account has the right to log on as a service.
11 years ago
#include <ntsecapi.h>
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
/*
MSDN says the commandline in CreateProcess() is limited to 32768 characters
and the application name to MAX_PATH.
A registry key is limited to 255 characters.
A registry value is limited to 16383 characters.
Therefore we limit the service name to accommodate the path under HKLM.
*/
#define EXE_LENGTH MAX_PATH
#define CMD_LENGTH 32768
#define KEY_LENGTH 255
#define VALUE_LENGTH 16383
#define SERVICE_NAME_LENGTH KEY_LENGTH - 55
Set service details in the GUI. The GUI can now set the service display name, description and startup type.
11 years ago
#define SERVICE_DISPLAYNAME_LENGTH 256
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
Decide how to handle application exit. When the service exits with exit code n look in HKLM\SYSTEM\CurrentControlSet\Services\<service>\Parameters\AppExit\<n>, falling back to the unnamed value if no such code is listed. Parse the (string) value of this entry as follows: Restart: Start the application again (NSSM default). Ignore: Do nothing (srvany default). Exit: Stop the service.
15 years ago
#define ACTION_LEN 16
Allow editing services. "nssm edit <service>" brings up a GUI to edit an existing service. Services not managed by NSSM can also be edited but only system properties such as the display name will appear in the GUI.
11 years ago
#define NSSM_LOCALSYSTEM_ACCOUNT _T("LocalSystem")
Allow service editing on the command line. Individual service parameters can now be queried or edited on the command line. The syntax is designed to be intuitive and is described in some detail in the README. Some examples follow: nssm get Selenium Application nssm get "My Batch Job" AppExit 0 nssm get Jenkins AppEnvironmentExtra CLASSPATH nssm get Netlogon ImagePath nssm set UT2004 Application C:\Games\UT2004\System\UCC.exe nssm set UT2004 AppParameters server nssm set UT2004 AppExit Default Exit nssm set Jenkins ObjectName DOMAIN\ci correct horse battery staple nssm set "My Batch Job" AppExit 0 Exit nssm set WowzaMediaServer362 Start SERVICE_DELAYED_START nssm set UT2004 Type SERVICE_INTERACTIVE_PROCESS nssm reset UT2004 AppEnvironment nssm reset UT2004 ObjectName
11 years ago
#define NSSM_KERNEL_DRIVER _T("SERVICE_KERNEL_DRIVER")
#define NSSM_FILE_SYSTEM_DRIVER _T("SERVICE_FILE_SYSTEM_DRIVER")
#define NSSM_WIN32_OWN_PROCESS _T("SERVICE_WIN32_OWN_PROCESS")
#define NSSM_WIN32_SHARE_PROCESS _T("SERVICE_WIN32_SHARE_PROCESS")
#define NSSM_INTERACTIVE_PROCESS _T("SERVICE_INTERACTIVE_PROCESS")
#define NSSM_SHARE_INTERACTIVE_PROCESS NSSM_WIN32_SHARE_PROCESS _T("|") NSSM_INTERACTIVE_PROCESS
#define NSSM_UNKNOWN _T("?")
Allow editing services. "nssm edit <service>" brings up a GUI to edit an existing service. Services not managed by NSSM can also be edited but only system properties such as the display name will appear in the GUI.
11 years ago
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
typedef struct {
Allow editing services. "nssm edit <service>" brings up a GUI to edit an existing service. Services not managed by NSSM can also be edited but only system properties such as the display name will appear in the GUI.
11 years ago
bool native;
Allow compiling as a Unicode application. Overhaul the entire codebase so that it compiles and runs as either a Unicode or ANSI application.
11 years ago
TCHAR name[SERVICE_NAME_LENGTH];
Set service details in the GUI. The GUI can now set the service display name, description and startup type.
11 years ago
TCHAR displayname[SERVICE_DISPLAYNAME_LENGTH];
TCHAR description[VALUE_LENGTH];
unsigned long startup;
Set log on details in the GUI. The GUI can now set service logon and desktop interactive details.
11 years ago
TCHAR *username;
size_t usernamelen;
TCHAR *password;
size_t passwordlen;
unsigned long type;
Allow editing services. "nssm edit <service>" brings up a GUI to edit an existing service. Services not managed by NSSM can also be edited but only system properties such as the display name will appear in the GUI.
11 years ago
TCHAR image[MAX_PATH];
Allow compiling as a Unicode application. Overhaul the entire codebase so that it compiles and runs as either a Unicode or ANSI application.
11 years ago
TCHAR exe[EXE_LENGTH];
TCHAR flags[VALUE_LENGTH];
TCHAR dir[MAX_PATH];
TCHAR *env;
Allow appending to the service environment. The new registry value AppEnvironmentExtra allows defining a list of environment variables which will be appended to the environment, as opposed to those defined by the srvany-compatible AppEnvironment, which replaces the environment. Though it would serve no useful purpose beyond verifying whether or not I went to the effort of writing a code path for it, it is possible to define bother lists and have them behave intuitively.
11 years ago
unsigned long envlen;
Allow compiling as a Unicode application. Overhaul the entire codebase so that it compiles and runs as either a Unicode or ANSI application.
11 years ago
TCHAR *env_extra;
Allow appending to the service environment. The new registry value AppEnvironmentExtra allows defining a list of environment variables which will be appended to the environment, as opposed to those defined by the srvany-compatible AppEnvironment, which replaces the environment. Though it would serve no useful purpose beyond verifying whether or not I went to the effort of writing a code path for it, it is possible to define bother lists and have them behave intuitively.
11 years ago
unsigned long env_extralen;
Allow compiling as a Unicode application. Overhaul the entire codebase so that it compiles and runs as either a Unicode or ANSI application.
11 years ago
TCHAR stdin_path[MAX_PATH];
Allow configuring output file truncation. A new checkbox in the GUI allows specifying that stdout and stderr should be truncated rather than appended. The registry must still be used to set different disposition for each or to control the disposition of stdin.
11 years ago
unsigned long stdin_sharing;
unsigned long stdin_disposition;
unsigned long stdin_flags;
Allow compiling as a Unicode application. Overhaul the entire codebase so that it compiles and runs as either a Unicode or ANSI application.
11 years ago
TCHAR stdout_path[MAX_PATH];
Allow configuring output file truncation. A new checkbox in the GUI allows specifying that stdout and stderr should be truncated rather than appended. The registry must still be used to set different disposition for each or to control the disposition of stdin.
11 years ago
unsigned long stdout_sharing;
unsigned long stdout_disposition;
unsigned long stdout_flags;
Allow compiling as a Unicode application. Overhaul the entire codebase so that it compiles and runs as either a Unicode or ANSI application.
11 years ago
TCHAR stderr_path[MAX_PATH];
Allow configuring output file truncation. A new checkbox in the GUI allows specifying that stdout and stderr should be truncated rather than appended. The registry must still be used to set different disposition for each or to control the disposition of stdin.
11 years ago
unsigned long stderr_sharing;
unsigned long stderr_disposition;
unsigned long stderr_flags;
Rotate output files. The files specified by AppStdout and AppStderr can now be rotated prior to launching the application. An existing file will be renamed with a new suffix based on its last write time, to millisecond precision. Rotation is controlled independently of the CreateFile() arguments used when opening the files for writing. It is possible to configure rotation regardless of whether existing files would be appended or replaced. Four new REG_DWORD entries control how rotation happens. If AppRotateFiles is 0 or missing, rotation is disabled. If AppRotateSeconds is non-zero, a file will not be rotated if its last write time is less than the given number of seconds in the past. If AppRotateBytes is non-zero, a file will not be rotated if it is smaller than the given number of bytes. 64-bit file sizes can be handled by specifying a high order part in AppRotateBytesHigh. Thanks Doug Watson.
11 years ago
bool rotate_files;
unsigned long rotate_seconds;
unsigned long rotate_bytes_low;
unsigned long rotate_bytes_high;
GUI overhaul. We now have a much less sucky GUI with tabs, combo boxes and all sorts of whizzbang stuff. The new GUI allows setting most of the advanced features we support directly from the service installer without having to poke about in the registry.
11 years ago
unsigned long default_exit_action;
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
unsigned long throttle_delay;
unsigned long stop_method;
unsigned long kill_console_delay;
unsigned long kill_window_delay;
unsigned long kill_threads_delay;
SC_HANDLE handle;
SERVICE_STATUS status;
SERVICE_STATUS_HANDLE status_handle;
HANDLE process_handle;
unsigned long pid;
HANDLE wait_handle;
bool stopping;
bool allow_restart;
unsigned long throttle;
CRITICAL_SECTION throttle_section;
bool throttle_section_initialised;
CONDITION_VARIABLE throttle_condition;
HANDLE throttle_timer;
LARGE_INTEGER throttle_duetime;
FILETIME creation_time;
FILETIME exit_time;
} nssm_service_t;
Allow compiling as a Unicode application. Overhaul the entire codebase so that it compiles and runs as either a Unicode or ANSI application.
11 years ago
void WINAPI service_main(unsigned long, TCHAR **);
TCHAR *service_control_text(unsigned long);
void log_service_control(TCHAR *, unsigned long, bool);
NSSM 1.0.
22 years ago
unsigned long WINAPI service_control_handler(unsigned long, unsigned long, void *, void *);
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
nssm_service_t *alloc_nssm_service();
Fixed bug when installing from the command line. We forgot to set default values when installing from the command line. Installing from the GUI worked. Thanks Paul Spause.
11 years ago
void set_nssm_service_defaults(nssm_service_t *);
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
void cleanup_nssm_service(nssm_service_t *);
NSSM 1.0.
22 years ago
SC_HANDLE open_service_manager();
Added open_service(). New function to open a service either by name or display name. Since no service's display name may conflict with any other service's display name or key name, we can safely use a display name as a key when opening a service. OpenService() expects a service name so if it fails with status ERROR_SERVICE_DOES_NOT_EXIST we can enumerate all services and look for one whose display name matches the argument passed to open_service(), and open it. As a side effect we can optionally store the canonical name in a separate (or not) buffer.
11 years ago
SC_HANDLE open_service(SC_HANDLE, TCHAR *, TCHAR *, unsigned long);
Moved QueryServiceConfig() to a separate function. The new function query_service_config() will return a pointer to a QUERY_SERVICE_CONFIG data structure.
11 years ago
QUERY_SERVICE_CONFIG *query_service_config(const TCHAR *, SC_HANDLE);
Added get_service_description(). New function to set or unset a service's description.
11 years ago
int set_service_description(const TCHAR *, SC_HANDLE, TCHAR *);
Added get_service_description(). New function to get the service description.
11 years ago
int get_service_description(const TCHAR *, SC_HANDLE, unsigned long, TCHAR *);
Added get_service_startup(). New function to retrieve the service startup type.
11 years ago
int get_service_startup(const TCHAR *, SC_HANDLE, const QUERY_SERVICE_CONFIG *, unsigned long *);
Added get_service_username(). New function to get the service username.
11 years ago
int get_service_username(const TCHAR *, const QUERY_SERVICE_CONFIG *, TCHAR **, size_t *);
Allow service editing on the command line. Individual service parameters can now be queried or edited on the command line. The syntax is designed to be intuitive and is described in some detail in the README. Some examples follow: nssm get Selenium Application nssm get "My Batch Job" AppExit 0 nssm get Jenkins AppEnvironmentExtra CLASSPATH nssm get Netlogon ImagePath nssm set UT2004 Application C:\Games\UT2004\System\UCC.exe nssm set UT2004 AppParameters server nssm set UT2004 AppExit Default Exit nssm set Jenkins ObjectName DOMAIN\ci correct horse battery staple nssm set "My Batch Job" AppExit 0 Exit nssm set WowzaMediaServer362 Start SERVICE_DELAYED_START nssm set UT2004 Type SERVICE_INTERACTIVE_PROCESS nssm reset UT2004 AppEnvironment nssm reset UT2004 ObjectName
11 years ago
int grant_logon_as_service(const TCHAR *);
Allow compiling as a Unicode application. Overhaul the entire codebase so that it compiles and runs as either a Unicode or ANSI application.
11 years ago
int pre_install_service(int, TCHAR **);
int pre_remove_service(int, TCHAR **);
Allow editing services. "nssm edit <service>" brings up a GUI to edit an existing service. Services not managed by NSSM can also be edited but only system properties such as the display name will appear in the GUI.
11 years ago
int pre_edit_service(int, TCHAR **);
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
int install_service(nssm_service_t *);
int remove_service(nssm_service_t *);
Allow editing services. "nssm edit <service>" brings up a GUI to edit an existing service. Services not managed by NSSM can also be edited but only system properties such as the display name will appear in the GUI.
11 years ago
int edit_service(nssm_service_t *, bool);
Allow controlling services. Send start/stop/query messages to services is easy so adding the ability to do so is a quick win.
11 years ago
int control_service(unsigned long, int, TCHAR **);
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
void set_service_recovery(nssm_service_t *);
int monitor_service(nssm_service_t *);
int start_service(nssm_service_t *);
int stop_service(nssm_service_t *, unsigned long, bool, bool);
NSSM 1.0.
22 years ago
void CALLBACK end_service(void *, unsigned char);
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
void throttle_restart(nssm_service_t *);
Allow compiling as a Unicode application. Overhaul the entire codebase so that it compiles and runs as either a Unicode or ANSI application.
11 years ago
int await_shutdown(nssm_service_t *, TCHAR *, unsigned long);
NSSM 1.0.
22 years ago
#endif