142 lines
3.4 KiB
C++
142 lines
3.4 KiB
C++
//
|
|
// WinService.h
|
|
//
|
|
// Library: Util
|
|
// Package: Windows
|
|
// Module: WinService
|
|
//
|
|
// Definition of the WinService class.
|
|
//
|
|
// Copyright (c) 2004-2006, Applied Informatics Software Engineering GmbH.
|
|
// and Contributors.
|
|
//
|
|
// SPDX-License-Identifier: BSL-1.0
|
|
//
|
|
|
|
|
|
#ifndef Util_WinService_INCLUDED
|
|
#define Util_WinService_INCLUDED
|
|
|
|
|
|
#include "Poco/Util/Util.h"
|
|
#include "Poco/UnWindows.h"
|
|
|
|
|
|
#if defined(POCO_WIN32_UTF8)
|
|
#define POCO_LPQUERY_SERVICE_CONFIG LPQUERY_SERVICE_CONFIGW
|
|
#else
|
|
#define POCO_LPQUERY_SERVICE_CONFIG LPQUERY_SERVICE_CONFIGA
|
|
#endif
|
|
|
|
|
|
namespace Poco {
|
|
namespace Util {
|
|
|
|
|
|
class Util_API WinService
|
|
/// 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.
|
|
{
|
|
public:
|
|
enum Startup
|
|
{
|
|
SVC_AUTO_START,
|
|
SVC_MANUAL_START,
|
|
SVC_DISABLED
|
|
};
|
|
|
|
WinService(const std::string& name);
|
|
/// Creates the WinService, using the given service name.
|
|
|
|
~WinService();
|
|
/// Destroys the WinService.
|
|
|
|
const std::string& name() const;
|
|
/// Returns the service name.
|
|
|
|
std::string displayName() const;
|
|
/// Returns the service's display 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 unregisterService();
|
|
/// Deletes the Windows service.
|
|
///
|
|
/// Throws a NotFoundException if the service has not been registered.
|
|
|
|
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.
|
|
|
|
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 setStartup(Startup startup);
|
|
/// Sets the startup mode for the service.
|
|
|
|
Startup getStartup() const;
|
|
/// Returns the startup mode for the service.
|
|
|
|
void setDescription(const std::string& description);
|
|
/// Sets the service description in the registry.
|
|
|
|
std::string getDescription() const;
|
|
/// Returns the service description from the registry.
|
|
|
|
static const int STARTUP_TIMEOUT;
|
|
|
|
protected:
|
|
static const std::string REGISTRY_KEY;
|
|
static const std::string REGISTRY_DESCRIPTION;
|
|
|
|
private:
|
|
void open() const;
|
|
bool tryOpen() const;
|
|
void close() const;
|
|
POCO_LPQUERY_SERVICE_CONFIG config() const;
|
|
|
|
WinService();
|
|
WinService(const WinService&);
|
|
WinService& operator = (const WinService&);
|
|
|
|
std::string _name;
|
|
SC_HANDLE _scmHandle;
|
|
mutable SC_HANDLE _svcHandle;
|
|
};
|
|
|
|
|
|
} } // namespace Poco::Util
|
|
|
|
|
|
#endif // Util_WinService_INCLUDED
|