API Documentation

API DOCUMENTATION

NOTE: Starting with version 2.5.0 callback method types are introduced:

• TaskCallback (former void *())
• TaskOnDisable (former void *())
• TaskOnEnable (former bool *())
  both variants (void/bool and Task… types are supported)

TASKS

CREATION:

• Task()
• Task(unsigned long aInterval, long aIterations, void (aCallback)(), Scheduler aScheduler, bool aEnable, bool (*aOnEnable)(), void (*aOnDisable)())
• Task(unsigned long aInterval, long aIterations, TaskCallback aCallback, Scheduler* aScheduler, bool aEnable, TaskOnEnable aOnEnable, TaskOnDisable aOnDisable)
• Task(void (aCallback)(), Scheduler aScheduler, bool (*aOnEnable)(), void (*aOnDisable)())
• bool isEnabled()
• unsigned long getInterval()
• long getIterations()
• long getStartDelay()
• long getOverrun()
• unsigned long getRunCounter()
• bool isFirstIteration()
• bool isLastIteration()

CONTROL:

• void enable()
• bool enableIfNot()
• void delay()
• void forceNextIteration()
• void enableDelayed()
• void enableDelayed (unsigned long aDelay)
• void restart()
• void restartDelayed (unsigned long aDelay)
• bool disable()
• void set(unsigned long aInterval, long aIterations, void (*aCallback)(), bool (*aOnEnable)(), void (*aOnDisable)())
• void setInterval (unsigned long aInterval)
• void setIterations (long aIterations)
• void setCallback (void (*aCallback)())
• void setOnEnable (bool (*aCallback)())
• void setOnDisable (void (*aCallback)())
• void yield(void (*aCallback)())
• void yieldOnce(void (*aCallback)())

STATUS REQUEST METHODS:

• void waitFor(StatusRequest* aStatusRequest, unsigned long aInterval = 0, long aIterations = 1)
• void waitForDelayed(StatusRequest* aStatusRequest, unsigned long aInterval = 0, long aIterations = 1)
• StatusRequest* getStatusRequest()
• StatusRequest* getInternalStatusRequest()

TASK ID, CONTROL POINTS METHODS:

• void setId(unsigned int aID)
• unsigned int getId()
• void setControlPoint (unsigned int aPoint)
• unsigned int getControlPoint()

LOCAL TASK STORAGE METHODS:

• void setLtsPointer(void *aPtr)
• void *getLtsPointer()

STATUS REQUEST:

CREATION:

• StatusRequest()
• void setWaiting(unsigned int aCount = 1)
• bool signal(int aStatus)
• bool signalComplete (int aStatus)
• bool pending()
• bool completed()
• int getStatus()
• int getCount()

TASK SCHEDULER:

CREATION:

• Scheduler()
• void init()
• void addTask(Task& aTask)
• void deleteTask(Task& aTask)
• void allowSleep(bool aState)
• void enableAll(bool aRecursive = true)
• void disableAll(bool aRecursive = true)
• Task& currentTask()
• void* currentLts()
• void startNow (bool aRecursive = true)
• long timeUntilNextIteration (Task& aTask)
• bool execute()
• bool isOverrun()

TASK PRIORITY:

• void setHighPriorityScheduler(Scheduler* aScheduler)
• static Scheduler& currentScheduler()

CONSTANTS