RTJob.h

/*
 * Licensed Materials - Property of HCL and/or IBM
 * Copyright HCL Technologies Ltd. 2016, 2021. All Rights Reserved.
 * Copyright IBM Corporation 1999, 2016. All Rights Reserved.
 *
 * U.S. Government Users Restricted Rights -  Use, duplication or 
 * disclosure restricted by GSA ADP Schedule.
 */
 
#ifndef __RTJob_h__
#define __RTJob_h__ included
 
#ifdef PRAGMA
#pragma interface
#endif
 
#ifndef __RTConfig_h__
#include <RTConfig.h>
#endif
 
class RTMutex;
 
class RTJob
{
public:
    enum Phase
    {
        created,    // initialization
        running,    // most of the time will be spent in this state
        finished    // job finished and thread gone
    };
 
    // these are intended for use from "outside" the job
    RTJob( void );
    virtual ~RTJob( void );
 
    // these can be used by anyone
    virtual const char    * name( void ) const = 0;
    RTS_INLINE Phase        phase( void ) const;
 
    // the thread responsible for the job will invoke this function
    virtual void            mainLoop( void ) = 0;
 
    // the thread destructor uses this function
    virtual void            kill( void ) = 0;
 
private:
    Phase                   _phase;
 
protected:
#if USE_THREADS
    RTMutex               * _mutex;
#endif
 
    RTS_INLINE void         enter( Phase );
 
private:
    // unavailable methods
    RTJob( const RTJob & );
    RTJob & operator=( const RTJob & );
};
 
#if RTS_INLINES
#include <RTJob.inl>
#endif
 
#endif // __RTJob_h__