Service.h

Go to the documentation of this file.

/*  Service.h - NT service helper
    Copyright (C) 2001-2004 Mark Weaver
    Written by Mark Weaver <mark@npsl.co.uk>

    Part of the Open-Win32 library.
    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Library General Public License for more details.

    You should have received a copy of the GNU Library General Public
    License along with this library; if not, write to the
    Free Software Foundation, Inc., 59 Temple Place - Suite 330,
    Boston, MA  02111-1307, USA.
*/

#ifndef OW32_Service_h
#define OW32_Service_h

#include <OW32/OW32Libs.h>
#include <OW32/EventLog.h>
#include <OW32/tstl.h>

namespace OW32
{

class OW32_LIB_EXPORT CService
{
private:
    bool m_DebugFlag;
    bool m_Interactive;

    LPCTSTR m_ServiceName;
    LPCTSTR m_ServiceDescription;
    DWORD m_dwDesiredAccess;
    DWORD m_dwServiceType;
    DWORD m_dwStartType;
    DWORD m_dwErrorControl;
    LPCTSTR m_lpBinaryPathName;
    LPCTSTR m_lpLoadOrderGroup;
    LPCTSTR m_lpDependencies;
    LPCTSTR m_lpServiceStartName;
    LPCTSTR m_lpPassword;

    static CService* m_pThis;
    
public:
    // Please note that strings are NOT copied; they must be static or
    // available for the lifetime of this object.
    CService(LPCTSTR pServiceName, LPCTSTR pServiceDescription, 
             DWORD dwDesiredAccess = STANDARD_RIGHTS_REQUIRED,
             DWORD dwServiceType = SERVICE_WIN32_OWN_PROCESS,
             DWORD dwStartType = SERVICE_AUTO_START,
             DWORD dwErrorControl = SERVICE_ERROR_NORMAL,
             LPCTSTR lpBinaryPathName = NULL,
             LPCTSTR lpLoadOrderGroup = NULL,
             LPCTSTR lpDependencies = NULL,
             LPCTSTR lpServiceStartName = NULL, 
             LPCTSTR lpPassword = NULL) :
        m_ServiceName(pServiceName),
        m_ServiceDescription(pServiceDescription),
        m_dwDesiredAccess(dwDesiredAccess),
        m_dwServiceType(dwServiceType),
        m_dwStartType(dwStartType),
        m_dwErrorControl(dwErrorControl),
        m_lpBinaryPathName(lpBinaryPathName),
        m_lpLoadOrderGroup(lpLoadOrderGroup),
        m_lpDependencies(lpDependencies),
        m_lpServiceStartName(lpServiceStartName), 
        m_lpPassword(lpPassword),
        m_hServiceStatus(NULL),
        m_DebugFlag(false),
        m_Interactive(false)
    {
        // TODO: assert that only one service exists!
        m_pThis = this;
    }

    // create/delete service
    virtual void Install();
    virtual void Uninstall();

    // Get the service name
    virtual LPCTSTR GetServiceName() const { return m_ServiceName; }

    // callable to start the service running (register with SCM, etc. - doesn't return)
    //virtual void Startup(); 

    // callable from user's main as a total service oriented replacment
    int _tmain(int argc, TCHAR* argv[]);

    // Main function for service (can be overridden if desired)
    virtual DWORD ServiceMain(DWORD dwArgc, LPTSTR* lpszArgv) = 0;

    // The service handler.
    virtual void ServiceHandler(DWORD fdwControl);

    bool InDebugMode() { return m_DebugFlag; }
    void SetDebugMode(bool bDebugFlag) { m_DebugFlag = bDebugFlag; }
    bool InInteractiveMode() { return m_Interactive; }
    void SetInteractiveMode(bool bInteractive) { m_Interactive = bInteractive; }

    // Called when the stop signal is received
    virtual void Stop() {}
    // Called on pause
    virtual void Pause() {}
    // Called on continue
    virtual void Continue() {}
    // Called on system shutdown
    virtual void Shutdown() {}
    // Called on interrogate, defaults to "running"
    virtual void Interrogate() {
        UpdateSCM(SERVICE_RUNNING);
    }

    // utility function to advise the SCM as to the state of the service
    void UpdateSCM(DWORD state, DWORD dwCheckPoint = 0, DWORD dwWaitHint = 1000);

    // Service status handle, in case you want to do something
    // special the UpdateSCM doesn't cover.
    SERVICE_STATUS_HANDLE m_hServiceStatus;

    // event log object - available to derived class - will be opened if _tmain called
    CEventLog m_SysLog;

private:
    // callbacks from Windows service entry points
    static void WINAPI ServiceMainCallback(DWORD dwArgc, LPTSTR* lpszArgv);
    static void WINAPI ServiceHandlerCallback(DWORD fdwControl);
};

} // namespace OW32

#endif // OW32_Service_h

---