Converted tabs to spaces with tabconv.

1 files changed, 315 insertions, 315 deletions

diff --git a/src/stable/minicron.h b/src/stable/minicron.h
index 53e5156..953b82a 100644
--- a/src/stable/minicron.h
+++ b/src/stable/minicron.h
@@ -16,321 +16,321 @@
 
 namespace Bu
 {
-        /**
-         * A simple cron like system designed to be embedded in any program.  This
-         * class creates a simple cron system that can run any number of jobs at
-         * customizable intervals or schedules.  It does not support some of the
-         * more complex scheduling that some cron systems can do such as load
-         * balancing directly, but this could be done on the job side.
-         *
-         * This system is synchronous, it does not use any threads on it's own, but
-         * it is threadsafe, so a cron thread could be created if desired.
-         *
-         * The operation is fairly simple, jobs can be added at any time, and use
-         * any timer they would like, even custom timers.  When it is time for a
-         * job to be run it signals the slot provided when the job was added.  Every
-         * job slot recieves a handle to the job object so that it may control it's
-         * own lifetime and get information about itself.  In addition, every job
-         * is assigned a unique ID that can be used to control it's operation
-         * at any time.
-         *
-         * By default a job will continually reschedule itself after being run
-         * unless it calls stop() on it's job object, it is removed using
-         * removeJob() on the cron object, or it is added with addJobOnce.
-         *
-         *@todo A minor change to the job execution system could allow a Timer to
-         * defer or reschedule execution instead of the job executing.  This would,
-         * in effect, allow us to do every type of interesting scheduling that
-         * systems like fcron offer, including time constrained load-balanced
-         * execution.
-         */
-        class MiniCron
-        {
-        public:
-                class Job;
-                class Timer;
-                typedef Bu::Signal1<void, Bu::MiniCron::Job &> CronSignal;
-                typedef int JobId;
-
-                MiniCron();
-                virtual ~MiniCron();
-
-                /**
-                 * Tells you if there are jobs registered in the MiniCron.
-                 *@returns true if there are jobs, false otherwise.
-                 */
-                virtual bool hasJobs();
-
-                /**
-                 * If there are jobs, tells you the time the next one will execute.
-                 *@returns The timestamp that the next job will execute at.
-                 */
-                virtual time_t getNextRun();
-                
-                /**
-                 * Tells you the time the job matching jid will run next.
-                 *@returns The timestamp that the job jid will next run.
-                 */
-                virtual time_t getNextRun( JobId jid );
-
-                /**
-                 * Call this regularly to execute all jobs that should be executed.
-                 * This will loop until all jobs who's run time match the current time
-                 * or are below the current time (we've missed them).
-                 * If there is nothing to run, the runtime of this funcion is constant,
-                 * it is very fast.  Otherwise it executes at log(N) per job run,
-                 * O(N*log(N)).
-                 */
-                virtual void poll();
-
-                /**
-                 * Add a job for repeated scheduling.  Pass in a slot to signal, and a
-                 * Timer object to use to do the scheduling.  This function returns a
-                 * JobId which can be used at a later time to control the execution of
-                 * the job.
-                 */
-                virtual JobId addJob( const Bu::String &sName, CronSignal sigJob,
-                                const Timer &t );
-
-                /**
-                 * Add a job for one time scheduling.  Pass in a slot to signal, and a
-                 * Timer object to use to schodule the one run of this job.  This
-                 * function returns a JobId which can be used at a later time to control
-                 * the execution of the job.
-                 */
-                virtual JobId addJobOnce( const Bu::String &sName, CronSignal sigJob,
-                                const Timer &t );
-
-                /**
-                 * Remove a job, preventing all future runs of the job.  If there is no
-                 * job matching the given JobId then nothing will happen.  However, this
-                 * function is relatively expensive compared to the others in this class
-                 * and has a worse case runtime of 2*N*log(N), still not that bad, and
-                 * a O(N*log(N)).
-                 */
-                virtual void removeJob( JobId jid );
-
-                /**
-                 * Executes the job specified right now.  If bReschedule is true then
-                 * the job is then removed from the queue and rescheduled as though
-                 * it's time had come naturally to be run.  Otherwise, it's run without
-                 * interrupting the normal schedule.
-                 */
-                virtual void runJob( JobId jid, bool bReschedule=false );
-
-                /**
-                 * Executes the job specified right now.  If bReschedule is true then
-                 * the job is then removed from the queue and rescheduled as though
-                 * it's time had come naturally to be run.  Otherwise, it's run without
-                 * interrupting the normal schedule.
-                 */
-                virtual void runJob( const Bu::String &sName, bool bReschedule=false );
-
-                class JobInfo
-                {
-                public:
-                        JobInfo( const Bu::String &sName, JobId jid, time_t tNext );
-                        virtual ~JobInfo();
-                        
-                        bool operator<( const JobInfo &rhs ) const;
-
-                        Bu::String sName;
-                        JobId jid;
-                        time_t tNext;
-                };
-                typedef Bu::List<JobInfo> JobInfoList;
-
-                JobInfoList getJobInfo();
-
-                /**
-                 * The baseclass for timer/schedulers for MiniCron jobs.  Classes that
-                 * inherit from this are used to determine when jobs will run and at
-                 * what interval.
-                 */
-                class Timer
-                {
-                public:
-                        Timer();
-                        virtual ~Timer();
-
-                        /**
-                         * Called by MiniCron when each job is run to determine the next
-                         * time that a job should be run.  When a job is run, this function
-                         * is actually called before the job is executed again so that the
-                         * job can tell when the next time it will be run will be.
-                         */
-                        virtual time_t nextTime()=0;
-
-                        /**
-                         * This function should return a copy of the child class.
-                         */
-                        virtual Timer *clone() const = 0;
-                };
-
-                /**
-                 * Execute the job every tInterval seconds, also you can delay the
-                 * first run by a different amount of time from the job's creation.
-                 */
-                class TimerInterval : public Timer
-                {
-                public:
-                        TimerInterval( time_t tFirst, time_t tInterval );
-                        virtual ~TimerInterval();
-
-                        virtual time_t nextTime();
-                        virtual Timer *clone() const
-                                { return new TimerInterval( *this ); }
-                private:
-                        time_t tNext;
-                        time_t tInterval;
-                };
-
-                /**
-                 * A much more general timer class that can be used for much more
-                 * "cron-like" functionality.  The constructor takes a string that
-                 * describes the times that the job should be run.  At the moment the
-                 * following schemes are understood:
-                 *
-                 * "daily [hour] [minute]"
-                 * "hourly [minute]"
-                 * "weekly [day] [hour] [minute]"
-                 *
-                 * In these examples each word in [brackets] represents a number that
-                 * matches the data type in the brackets.  [day] is the number of days
-                 * since sunday, 0-6.  You can also use lowercase three character
-                 * abbreviations for the day names.
-                 *
-                 * Many more forms follow.
-                 */
-                class TimerBasic : public Timer
-                {
-                public:
-                        TimerBasic( const Bu::String &s );
-                        virtual ~TimerBasic();
-
-                        virtual time_t nextTime();
-                        virtual Timer *clone() const
-                                { return new TimerBasic( *this ); }
-
-                private:
-                        enum Token
-                        {
-                                tokDaily,
-                                tokHourly,
-                                tokWeekly,
-                                tokMonthly,
-                                tokYearly,
-                                valInt,
-                                tokErr,
-                                tokEos
-                        };
-                        Token lex( Bu::String::const_iterator &i );
-                        int lexInt( Bu::String::const_iterator &i );
-                        int iVal; //< A temp variable for parsing.
-                        time_t tLast;
-                        Bu::String sSpec;
-                };
-                
-                /**
-                 * Represents a MiniCron Job.  This class is used for both internal
-                 * job management as well as job slot interaction and control.  Objects
-                 * of this class are passed into the slots that are signaled when a job
-                 * is executed.
-                 */
-                class Job
-                {
-                        friend class Bu::MiniCron;
-                private:
-                        Job( const Bu::String &sName, JobId jid, bool bRepeat=true );
-                        virtual ~Job();
-
-                public:
-
-                        /**
-                         * Execute this job once, increment the runcount and schedule the
-                         * next occurance of it.
-                         */
-                        void run( bool bReschedule=true );
-
-                        /**
-                         * Get the time this job will next run.
-                         */
-                        time_t getNextRun() const;
-
-                        /**
-                         * Compute the time this job will next run.
-                         */
-                        void calcNextRun();
-
-                        /**
-                         * Replace the current job timer with a new one, this will trigger
-                         * a re-schedule.
-                         */
-                        void setTimer( const Timer &t );
-
-                        /**
-                         * Stop execution of this job, never execute this job again.
-                         */
-                        void stop();
-
-                        /**
-                         * Undo a previous stop.  This will cause a job that has been
-                         * stopped or even added with addJobOnce to be set for repeated
-                         * scheduling.
-                         */
-                        void resume();
-
-                        /**
-                         * Get the unique ID of this job.
-                         */
-                        JobId getId() const;
-
-                        /**
-                         * Get the timestamp this job was created.
-                         */
-                        time_t getTimeCreated() const;
-
-                        /**
-                         * Get the current run count of this job, how many times it has been
-                         * executed.  This is incremented before the slot is signaled.
-                         */
-                        int getRunCount() const;
-
-                        /**
-                         * Get the next time that this job will be run.  Certain timers may
-                         * have the ability to delay job executions, so this is the earliest
-                         * time that the job may run.
-                         */
-                        time_t getNextRunTime() const;
-
-                        /**
-                         * Gets the name that was set when the job was created.
-                         */
-                        Bu::String getName() const;
-
-                private:
-                        Bu::String sName;
-                        CronSignal sigJob;
-                        time_t tNextRun;
-                        Timer *pTimer;
-                        bool bContinue;
-                        JobId jid;
-                        time_t tAdded;
-                        int iRunCount;
-                };
-
-        private:
-                struct JobPtrCmp
-                {
-                        bool operator()( const Job *pLeft, const Job *pRight )
-                        {
-                                return pLeft->tNextRun < pRight->tNextRun;
-                        }
-                };
-                typedef Bu::Heap<Job *, JobPtrCmp> JobHeap;
-                JobHeap hJobs;
-                JobId jidNext;
-        };
+    /**
+     * A simple cron like system designed to be embedded in any program.  This
+     * class creates a simple cron system that can run any number of jobs at
+     * customizable intervals or schedules.  It does not support some of the
+     * more complex scheduling that some cron systems can do such as load
+     * balancing directly, but this could be done on the job side.
+     *
+     * This system is synchronous, it does not use any threads on it's own, but
+     * it is threadsafe, so a cron thread could be created if desired.
+     *
+     * The operation is fairly simple, jobs can be added at any time, and use
+     * any timer they would like, even custom timers.  When it is time for a
+     * job to be run it signals the slot provided when the job was added.  Every
+     * job slot recieves a handle to the job object so that it may control it's
+     * own lifetime and get information about itself.  In addition, every job
+     * is assigned a unique ID that can be used to control it's operation
+     * at any time.
+     *
+     * By default a job will continually reschedule itself after being run
+     * unless it calls stop() on it's job object, it is removed using
+     * removeJob() on the cron object, or it is added with addJobOnce.
+     *
+     *@todo A minor change to the job execution system could allow a Timer to
+     * defer or reschedule execution instead of the job executing.  This would,
+     * in effect, allow us to do every type of interesting scheduling that
+     * systems like fcron offer, including time constrained load-balanced
+     * execution.
+     */
+    class MiniCron
+    {
+    public:
+        class Job;
+        class Timer;
+        typedef Bu::Signal1<void, Bu::MiniCron::Job &> CronSignal;
+        typedef int JobId;
+
+        MiniCron();
+        virtual ~MiniCron();
+
+        /**
+         * Tells you if there are jobs registered in the MiniCron.
+         *@returns true if there are jobs, false otherwise.
+         */
+        virtual bool hasJobs();
+
+        /**
+         * If there are jobs, tells you the time the next one will execute.
+         *@returns The timestamp that the next job will execute at.
+         */
+        virtual time_t getNextRun();
+        
+        /**
+         * Tells you the time the job matching jid will run next.
+         *@returns The timestamp that the job jid will next run.
+         */
+        virtual time_t getNextRun( JobId jid );
+
+        /**
+         * Call this regularly to execute all jobs that should be executed.
+         * This will loop until all jobs who's run time match the current time
+         * or are below the current time (we've missed them).
+         * If there is nothing to run, the runtime of this funcion is constant,
+         * it is very fast.  Otherwise it executes at log(N) per job run,
+         * O(N*log(N)).
+         */
+        virtual void poll();
+
+        /**
+         * Add a job for repeated scheduling.  Pass in a slot to signal, and a
+         * Timer object to use to do the scheduling.  This function returns a
+         * JobId which can be used at a later time to control the execution of
+         * the job.
+         */
+        virtual JobId addJob( const Bu::String &sName, CronSignal sigJob,
+                const Timer &t );
+
+        /**
+         * Add a job for one time scheduling.  Pass in a slot to signal, and a
+         * Timer object to use to schodule the one run of this job.  This
+         * function returns a JobId which can be used at a later time to control
+         * the execution of the job.
+         */
+        virtual JobId addJobOnce( const Bu::String &sName, CronSignal sigJob,
+                const Timer &t );
+
+        /**
+         * Remove a job, preventing all future runs of the job.  If there is no
+         * job matching the given JobId then nothing will happen.  However, this
+         * function is relatively expensive compared to the others in this class
+         * and has a worse case runtime of 2*N*log(N), still not that bad, and
+         * a O(N*log(N)).
+         */
+        virtual void removeJob( JobId jid );
+
+        /**
+         * Executes the job specified right now.  If bReschedule is true then
+         * the job is then removed from the queue and rescheduled as though
+         * it's time had come naturally to be run.  Otherwise, it's run without
+         * interrupting the normal schedule.
+         */
+        virtual void runJob( JobId jid, bool bReschedule=false );
+
+        /**
+         * Executes the job specified right now.  If bReschedule is true then
+         * the job is then removed from the queue and rescheduled as though
+         * it's time had come naturally to be run.  Otherwise, it's run without
+         * interrupting the normal schedule.
+         */
+        virtual void runJob( const Bu::String &sName, bool bReschedule=false );
+
+        class JobInfo
+        {
+        public:
+            JobInfo( const Bu::String &sName, JobId jid, time_t tNext );
+            virtual ~JobInfo();
+            
+            bool operator<( const JobInfo &rhs ) const;
+
+            Bu::String sName;
+            JobId jid;
+            time_t tNext;
+        };
+        typedef Bu::List<JobInfo> JobInfoList;
+
+        JobInfoList getJobInfo();
+
+        /**
+         * The baseclass for timer/schedulers for MiniCron jobs.  Classes that
+         * inherit from this are used to determine when jobs will run and at
+         * what interval.
+         */
+        class Timer
+        {
+        public:
+            Timer();
+            virtual ~Timer();
+
+            /**
+             * Called by MiniCron when each job is run to determine the next
+             * time that a job should be run.  When a job is run, this function
+             * is actually called before the job is executed again so that the
+             * job can tell when the next time it will be run will be.
+             */
+            virtual time_t nextTime()=0;
+
+            /**
+             * This function should return a copy of the child class.
+             */
+            virtual Timer *clone() const = 0;
+        };
+
+        /**
+         * Execute the job every tInterval seconds, also you can delay the
+         * first run by a different amount of time from the job's creation.
+         */
+        class TimerInterval : public Timer
+        {
+        public:
+            TimerInterval( time_t tFirst, time_t tInterval );
+            virtual ~TimerInterval();
+
+            virtual time_t nextTime();
+            virtual Timer *clone() const
+                { return new TimerInterval( *this ); }
+        private:
+            time_t tNext;
+            time_t tInterval;
+        };
+
+        /**
+         * A much more general timer class that can be used for much more
+         * "cron-like" functionality.  The constructor takes a string that
+         * describes the times that the job should be run.  At the moment the
+         * following schemes are understood:
+         *
+         * "daily [hour] [minute]"
+         * "hourly [minute]"
+         * "weekly [day] [hour] [minute]"
+         *
+         * In these examples each word in [brackets] represents a number that
+         * matches the data type in the brackets.  [day] is the number of days
+         * since sunday, 0-6.  You can also use lowercase three character
+         * abbreviations for the day names.
+         *
+         * Many more forms follow.
+         */
+        class TimerBasic : public Timer
+        {
+        public:
+            TimerBasic( const Bu::String &s );
+            virtual ~TimerBasic();
+
+            virtual time_t nextTime();
+            virtual Timer *clone() const
+                { return new TimerBasic( *this ); }
+
+        private:
+            enum Token
+            {
+                tokDaily,
+                tokHourly,
+                tokWeekly,
+                tokMonthly,
+                tokYearly,
+                valInt,
+                tokErr,
+                tokEos
+            };
+            Token lex( Bu::String::const_iterator &i );
+            int lexInt( Bu::String::const_iterator &i );
+            int iVal; //< A temp variable for parsing.
+            time_t tLast;
+            Bu::String sSpec;
+        };
+        
+        /**
+         * Represents a MiniCron Job.  This class is used for both internal
+         * job management as well as job slot interaction and control.  Objects
+         * of this class are passed into the slots that are signaled when a job
+         * is executed.
+         */
+        class Job
+        {
+            friend class Bu::MiniCron;
+        private:
+            Job( const Bu::String &sName, JobId jid, bool bRepeat=true );
+            virtual ~Job();
+
+        public:
+
+            /**
+             * Execute this job once, increment the runcount and schedule the
+             * next occurance of it.
+             */
+            void run( bool bReschedule=true );
+
+            /**
+             * Get the time this job will next run.
+             */
+            time_t getNextRun() const;
+
+            /**
+             * Compute the time this job will next run.
+             */
+            void calcNextRun();
+
+            /**
+             * Replace the current job timer with a new one, this will trigger
+             * a re-schedule.
+             */
+            void setTimer( const Timer &t );
+
+            /**
+             * Stop execution of this job, never execute this job again.
+             */
+            void stop();
+
+            /**
+             * Undo a previous stop.  This will cause a job that has been
+             * stopped or even added with addJobOnce to be set for repeated
+             * scheduling.
+             */
+            void resume();
+
+            /**
+             * Get the unique ID of this job.
+             */
+            JobId getId() const;
+
+            /**
+             * Get the timestamp this job was created.
+             */
+            time_t getTimeCreated() const;
+
+            /**
+             * Get the current run count of this job, how many times it has been
+             * executed.  This is incremented before the slot is signaled.
+             */
+            int getRunCount() const;
+
+            /**
+             * Get the next time that this job will be run.  Certain timers may
+             * have the ability to delay job executions, so this is the earliest
+             * time that the job may run.
+             */
+            time_t getNextRunTime() const;
+
+            /**
+             * Gets the name that was set when the job was created.
+             */
+            Bu::String getName() const;
+
+        private:
+            Bu::String sName;
+            CronSignal sigJob;
+            time_t tNextRun;
+            Timer *pTimer;
+            bool bContinue;
+            JobId jid;
+            time_t tAdded;
+            int iRunCount;
+        };
+
+    private:
+        struct JobPtrCmp
+        {
+            bool operator()( const Job *pLeft, const Job *pRight )
+            {
+                return pLeft->tNextRun < pRight->tNextRun;
+            }
+        };
+        typedef Bu::Heap<Job *, JobPtrCmp> JobHeap;
+        JobHeap hJobs;
+        JobId jidNext;
+    };
 };
 
 #endif