CeylanRunnable.h

Go to the documentation of this file.

/* 
 * Copyright (C) 2003-2009 Olivier Boudeville
 *
 * This file is part of the Ceylan library.
 *
 * The Ceylan library is free software: you can redistribute it and/or modify
 * it under the terms of either the GNU Lesser General Public License or
 * the GNU General Public License, as they are published by the Free Software
 * Foundation, either version 3 of these Licenses, or (at your option) 
 * any later version.
 *
 * The Ceylan 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 Lesser General Public License and the GNU General Public License
 * for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License and the GNU General Public License along with the Ceylan library.
 * If not, see <http://www.gnu.org/licenses/>.
 *
 * Author: Olivier Boudeville (olivier.boudeville@esperide.com)
 *
 */


#ifndef CEYLAN_RUNNABLE_H_
#define CEYLAN_RUNNABLE_H_


#include "CeylanTextDisplayable.h"   // for inheritance
#include "CeylanSystem.h"            // for SystemException

#include <string>



namespace Ceylan 
{


    namespace System
    {
    
    
        class CEYLAN_DLL RunnableException : public SystemException
        {
        
            public:
            
                explicit RunnableException( const std::string message ) ;
                
                virtual ~RunnableException() throw() ;          
                            
        } ;
        
        
    
        typedef void (*Callback) ( void * data ) /* throw() */ ;
    
    
    
        class CEYLAN_DLL Runnable : public Ceylan::TextDisplayable
        {


            public:
            
            
            
                Runnable() ;



                // Constructs a Runnable whose name is the one specified.
                explicit Runnable( const std::string & name ) ;
                
                
                
                // Basic virtual destructor.
                virtual ~Runnable() throw() ;



                virtual void run() = 0 ;
                
                
                
                const std::string & getName() const ;
                
                

                virtual const std::string toString( 
                    Ceylan::VerbosityLevels level = Ceylan::high ) const = 0 ;

                
                
            private:
            

                std::string _name ;


                Runnable( const Runnable & source ) ;
            
            
            
                Runnable & operator = ( const Runnable & source ) ;
                
                
        } ;
        

    }
    
}



#endif // CEYLAN_RUNNABLE_H_

---