Library: Util
Package: Windows
Header: Poco/Util/WinService.h
This class provides an object-oriented interface to the Windows Service Control Manager for registering, unregistering, configuring, starting and stopping services.
This class is only available on Windows platforms.
Member Functions: displayName, getDescription, getStartup, isRegistered, isRunning, name, path, registerService, setDescription, setStartup, start, stop, unregisterService
WinService(
const std::string & name
);
Creates the WinService, using the given service name.
~WinService();
Destroys the WinService.
std::string displayName() const;
Returns the service's display name.
std::string getDescription() const;
Returns the service description from the registry.
Startup getStartup() const;
Returns the startup mode for the service.
bool isRegistered() const;
Returns true if the service has been registered with the Service Control Manager.
bool isRunning() const;
Returns true if the service is currently running.
const std::string & name() const;
Returns the service name.
std::string path() const;
Returns the path to the service executable.
Throws a NotFoundException if the service has not been registered.
void registerService(
const std::string & path,
const std::string & displayName
);
Creates a Windows service with the executable specified by path and the given displayName.
Throws a ExistsException if the service has already been registered.
void registerService(
const std::string & path
);
Creates a Windows service with the executable specified by path and the given displayName. The service name is used as display name.
Throws a ExistsException if the service has already been registered.
void setDescription(
const std::string & description
);
Sets the service description in the registry.
void setStartup(
Startup startup
);
Sets the startup mode for the service.
void start();
Starts the service. Does nothing if the service is already running.
Throws a NotFoundException if the service has not been registered.
void stop();
Stops the service. Does nothing if the service is not running.
Throws a NotFoundException if the service has not been registered.
void unregisterService();
Deletes the Windows service.
Throws a NotFoundException if the service has not been registered.
static const int STARTUP_TIMEOUT;
static const std::string REGISTRY_DESCRIPTION;
static const std::string REGISTRY_KEY;