gzService.h

Go to the documentation of this file.

//******************************************************************************
// File         : gzService.h
// Module       : gzBase
// Description  : Class definition of service features
// Author       : Anders Modén      
// Product      : GizmoBase 2.1.1
//      
// Copyright © 2003- Saab Training Systems AB, Sweden
//          
// NOTE:    GizmoBase is a platform abstraction utility layer for C++. It contains 
//          design patterns and C++ solutions for the advanced programmer.
//
//
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// AMO  041104  Created file    
//
//******************************************************************************
#ifndef __GZ_SERVICE_H__
#define __GZ_SERVICE_H__

#include "gzBase.h"
#include "gzLex.h"

enum gzServiceStatus
{
    GZ_SERVICE_STOPPED,
    GZ_SERVICE_PAUSED_RUNNING,
    GZ_SERVICE_RUNNING
};

//******************************************************************************
// Class    : gzService
//                                  
// Purpose  : Service management
//                                  
// Notes    : - 
//                                  
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// AMO  041104  Created 
//                                  
//******************************************************************************
class gzService 
{
public:

    GZ_BASE_EXPORT gzService(const gzString &name,const gzString &comment=GZ_EMPTY_STRING);
    GZ_BASE_EXPORT virtual ~gzService();

    GZ_BASE_EXPORT gzBool registerService(gzBool autostart=TRUE);
    GZ_BASE_EXPORT gzBool unregisterService();

    GZ_BASE_EXPORT gzBool exec(int argc, char *argv[]);

    GZ_BASE_EXPORT gzBool   startService();
    GZ_BASE_EXPORT gzBool   stopService();
    GZ_BASE_EXPORT gzBool   pauseService();
    GZ_BASE_EXPORT gzBool   continueService();

    GZ_BASE_EXPORT virtual gzVoid process(const gzArgumentParser &args,gzBool runAsService)=0;

    GZ_BASE_EXPORT gzBool   isRunning();
    GZ_BASE_EXPORT gzBool   isPaused();
    GZ_BASE_EXPORT gzBool   isRegistered();

    GZ_BASE_EXPORT gzVoid   setStatus(gzServiceStatus status);

    GZ_BASE_EXPORT const gzString &         getName();
    GZ_BASE_EXPORT const gzString &         getComment();
    GZ_BASE_EXPORT const gzArgumentParser & getArguments();


    // virtual callbacks

    GZ_BASE_EXPORT virtual gzVoid   onStop(){};
    GZ_BASE_EXPORT virtual gzVoid   onPause(){};
    GZ_BASE_EXPORT virtual gzVoid   onContinue(){};


private:

    gzVoid runProcess();

    gzArgumentParser        m_args;

    gzString                m_name;

    gzString                m_comment;

    gzServiceStatus         m_status;
};

#endif //__GZ_SERVICE_H__

---