Main Page | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | Related Pages

ArASyncTask.h

00001 /*
00002 ActivMedia Robotics Interface for Applications (ARIA)
00003 Copyright (C) 2004,2005 ActivMedia Robotics, LLC
00004 
00005 
00006      This program is free software; you can redistribute it and/or modify
00007      it under the terms of the GNU General Public License as published by
00008      the Free Software Foundation; either version 2 of the License, or
00009      (at your option) any later version.
00010 
00011      This program is distributed in the hope that it will be useful,
00012      but WITHOUT ANY WARRANTY; without even the implied warranty of
00013      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00014      GNU General Public License for more details.
00015 
00016      You should have received a copy of the GNU General Public License
00017      along with this program; if not, write to the Free Software
00018      Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
00019 
00020 If you wish to redistribute ARIA under different terms, contact 
00021 ActivMedia Robotics for information about a commercial version of ARIA at 
00022 robots@activmedia.com or 
00023 ActivMedia Robotics, 19 Columbia Drive, Amherst, NH 03031; 800-639-9481
00024 
00025 */
00026 
00027 // Threadable.h -- Threadable interface class
00028 #ifndef ARQASYNCTASK_H
00029 #define ARQASYNCTASK_H
00030 
00031 
00032 #include "ariaTypedefs.h"
00033 #include "ArFunctor.h"
00034 #include "ArThread.h"
00035 
00036 
00038 
00049 class ArASyncTask : public ArThread
00050 {
00051 public:
00052 
00054   ArASyncTask();
00056   virtual ~ArASyncTask();
00057 
00059 
00064   virtual void * runThread(void *arg) = 0;
00065 
00067   virtual void run(void) { runInThisThread(); }
00068   
00070   virtual void runAsync(void) { create(); }
00071 
00072   // reimplemented here just so its easier to see in the docs
00074   virtual void stopRunning(void) {myRunning=false;}
00075 
00077   virtual int create(bool joinable=true, bool lowerPriority=true);
00078 
00080   virtual void * runInThisThread(void *arg=0);
00081 
00082 private:
00083 
00084   // Hide regular Thread::Create
00085   virtual int create(ArFunctor * /*func*/, bool /*joinable=true*/,
00086                      bool /*lowerPriority=true*/) {return(false);}
00087 
00088 
00089   ArRetFunctor1C<void*, ArASyncTask, void*> myFunc;
00090 };
00091 
00092 
00093 #endif // ARASYNCTASK_H

Generated on Wed Oct 19 12:56:34 2005 for Aria by  doxygen 1.4.0