bertos/kern/rtask.h

   1 /**
   2  * \file
   3  * <!--
   4  * This file is part of BeRTOS.
   5  *
   6  * Bertos is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  19  *
  20  * As a special exception, you may use this file as part of a free software
  21  * library without restriction.  Specifically, if other files instantiate
  22  * templates or use macros or inline functions from this file, or you compile
  23  * this file and link it with other files to produce an executable, this
  24  * file does not by itself cause the resulting executable to be covered by
  25  * the GNU General Public License.  This exception does not however
  26  * invalidate any other reasons why the executable file might be covered by
  27  * the GNU General Public License.
  28  *
  29  * Copyright 2010 Develer S.r.l. (http://www.develer.com/)
  30  *
  31  * -->
  32  *
  33  * \brief Recurrent task module.
  34  *
  35  * This module is a convenient method to handle multiple recurrent low priority
  36  * tasks. It creates a process with the default priority and schedules all the
  37  * tasks internally.
  38  * You can execute all the operations you want in each callback, since they
  39  * are executed in a different thread from the caller.
  40  *
  41  * Your callback may return true if you want the task to be scheduled
  42  * again, or false if you want the task to end.
  43  *
  44  * Interval time for each task should be fairly high (>20 ms) to avoid
  45  * blocking the whole CPU on this low priority job.
  46  *
  47  * \note rtask_add() may block.
  48  *
  49  * \author Luca Ottaviano <lottaviano@develer.com>
  50  * \author Francesco Sacchi <batt@develer.com>
  51  *
  52  */
  53
  54 #ifndef KERNEL_RTASK_H
  55 #define KERNEL_RTASK_H
  56
  57 #include <cfg/compiler.h>
  58
  59 struct RTask;
  60 typedef bool (*rtask_cb_t)(void *user_data);
  61 typedef struct RTask RTask;
  62
  63 struct RTask *rtask_add(rtask_cb_t cb, mtime_t interval, void *cb_data);
  64
  65 /* Test functions */
  66 int rtask_testRun(void);
  67 int rtask_testSetup(void);
  68 int rtask_testTearDown(void);
  69
  70 #endif /* KERNEL_RTASK_H */