NAME

ACE_NT_Service - Provide the base class which defines the interface for controlling an NT service.

SYNOPSIS

#include <ace/NT_Service.h>

class ACE_NT_Service : public ACE_Task<ACE_MT_SYNCH> { public: ACE_NT_Service ( DWORD start_timeout = ACE_NT_SERVICE_START_TIMEOUT, DWORD service_type = SERVICE_WIN32_OWN_PROCESS, DWORD controls_mask = SERVICE_ACCEPT_STOP ); ACE_NT_Service ( LPCTSTR name, LPCTSTR desc = 0, DWORD start_timeout = ACE_NT_SERVICE_START_TIMEOUT, DWORD service_type = SERVICE_WIN32_OWN_PROCESS, DWORD controls_mask = SERVICE_ACCEPT_STOP ); virtual ~ACE_NT_Service (void); virtual int open (void *args = 0); virtual int svc (void); virtual void handle_control (DWORD control_code); void svc_handle (const SERVICE_STATUS_HANDLE new_svc_handle); void name (LPCTSTR name, LPCTSTR desc = 0); LPCTSTR name (void) const; LPCTSTR desc (void) const; int insert ( DWORD start_type = SERVICE_DEMAND_START, DWORD error_control = SERVICE_ERROR_IGNORE, LPCTSTR exe_path = 0, LPCTSTR group_name = 0, LPDWORD tag_id = 0, LPCTSTR dependencies = 0, LPCTSTR account_name = 0, LPCTSTR password = 0 ); int remove (void); int startup (DWORD startup); DWORD startup (void); int start_svc ( ACE_Time_Value *wait_time = 0, DWORD *svc_state = 0, DWORD argc = 0, LPCTSTR *argv = 0 ); int stop_svc ( ACE_Time_Value *wait_time = 0, DWORD *svc_state = 0 ); int pause_svc ( ACE_Time_Value *wait_time = 0, DWORD *svc_state = 0 ); int continue_svc ( ACE_Time_Value *wait_time = 0, DWORD *svc_state = 0 ); DWORD state (ACE_Time_Value *wait_hint = 0); int state (DWORD *pstate, ACE_Time_Value *wait_hint = 0); int test_access (DWORD desired_access = SERVICE_ALL_ACCESS); ACE_ALLOC_HOOK_DECLARE; protected: int report_status (DWORD new_status, DWORD time_hint = 0); SC_HANDLE svc_sc_handle (void); void wait_for_service_state ( DWORD desired_state, ACE_Time_Value *wait_time ); virtual void stop_requested (DWORD control_code); virtual void pause_requested (DWORD control_code); virtual void continue_requested (DWORD control_code); virtual void interrogate_requested (DWORD control_code); DWORD start_time_; SERVICE_STATUS_HANDLE svc_handle_; SERVICE_STATUS svc_status_; SC_HANDLE svc_sc_handle_; LPTSTR name_; LPTSTR desc_; };

DESCRIPTION

Initialization and termination methods.

ACE_NT_Service (
    DWORD start_timeout = ACE_NT_SERVICE_START_TIMEOUT,
    DWORD service_type = SERVICE_WIN32_OWN_PROCESS,
    DWORD controls_mask = SERVICE_ACCEPT_STOP
    );

ACE_NT_Service (
    LPCTSTR name,
    LPCTSTR desc = 0,
    DWORD start_timeout = ACE_NT_SERVICE_START_TIMEOUT,
    DWORD service_type = SERVICE_WIN32_OWN_PROCESS,
    DWORD controls_mask = SERVICE_ACCEPT_STOP
    );

virtual ~ACE_NT_Service (void);

Functions to operate the service

virtual int open (void *args = 0);

virtual int svc (void);

virtual void handle_control (DWORD control_code);

void svc_handle (const SERVICE_STATUS_HANDLE new_svc_handle);

Methods which can be used to do SCP-like functions. The first group

are used to register/insert and remove the service's definition in the SCM registry.
void name (LPCTSTR name, LPCTSTR desc = 0);

LPCTSTR name (void) const;

LPCTSTR desc (void) const;

int insert (
    DWORD start_type = SERVICE_DEMAND_START,
    DWORD error_control = SERVICE_ERROR_IGNORE,
    LPCTSTR exe_path = 0,
    LPCTSTR group_name = 0,
    LPDWORD tag_id = 0,
    LPCTSTR dependencies = 0,
    LPCTSTR account_name = 0,
    LPCTSTR password = 0
    );

int remove (void);

int startup (DWORD startup);

DWORD startup (void);

Methods which control the service's execution.

These methods to start/pause/resume/stop/check the service all have the following common behavior with respect to wait_time and return value. wait_time is a pointer to an ACE_Time_Value object. If not supplied (a zero pointer) the function will wait indefinitely for the action to be finalized (service reach running state, completely shut down, etc.) or get "stuck" before returning. If the time is supplied, it specifies how long to wait for the service to reach a steady state, and on return, it is updated to the service's last reported wait hint. So, if you want to control the waiting yourself (for example, you want to react to UI events during the wait) specify a wait_time of (0, 0) and use the updated time to know when to check the service's state again. NOTE!!!! The wait_time things don't work yet. The calls always check status once, and do not wait for it to change.

The return value from start_svc, stop_svc, pause_svc, continue_svc is 0 if the request to NT to effect the change was made successfully. The service may refuse to change, or not do what you wanted; so if you need to know, supply a svc_state pointer to receive the service's reported last state on return and check it to see if it's what you want. The functions only return -1 when the actual request to the service is refused - this would include privilege restrictions and if the service is not configured to receive the request (this is most likely to happen in the case of pause and continue).

int start_svc (
    ACE_Time_Value *wait_time = 0,
    DWORD *svc_state = 0,
    DWORD argc = 0,
    LPCTSTR *argv = 0
    );

int stop_svc (ACE_Time_Value *wait_time = 0, DWORD *svc_state = 0);

int pause_svc (ACE_Time_Value *wait_time = 0, DWORD *svc_state = 0);

int continue_svc (
    ACE_Time_Value *wait_time = 0,
    DWORD *svc_state = 0
    );

DWORD state (ACE_Time_Value *wait_hint = 0);

int state (DWORD *pstate, ACE_Time_Value *wait_hint = 0);

int test_access (DWORD desired_access = SERVICE_ALL_ACCESS);

ACE_ALLOC_HOOK_DECLARE;

AUTHOR

Steve Huston

LIBRARY

ace