Source/charon/threads/scheduler.h

   1 /**
   2  * @file scheduler.h
   3  *
   4  * @brief Interface of scheduler_t.
   5  *
   6  */
   7
   8 /*
   9  * Copyright (C) 2005 Jan Hutter, Martin Willi
  10  * Hochschule fuer Technik Rapperswil
  11  *
  12  * This program is free software; you can redistribute it and/or modify it
  13  * under the terms of the GNU General Public License as published by the
  14  * Free Software Foundation; either version 2 of the License, or (at your
  15  * option) any later version.  See <http://www.fsf.org/copyleft/gpl.txt>.
  16  *
  17  * This program is distributed in the hope that it will be useful, but
  18  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  19  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  20  * for more details.
  21  */
  22
  23 #ifndef SCHEDULER_H_
  24 #define SCHEDULER_H_
  25
  26 #include <types.h>
  27
  28 typedef struct scheduler_t scheduler_t;
  29
  30 /**
  31  * @brief The scheduler thread is responsible for timed events.
  32  *
  33  * The scheduler thread takes out jobs from the event-queue and adds them
  34  * to the job-queue.
  35  *
  36  * Starts a thread which does the work, since event-queue is blocking.
  37  *
  38  * @b Constructors:
  39  *  - scheduler_create()
  40  *
  41  * @ingroup threads
  42  */
  43 struct scheduler_t {
  44
  45         /**
  46          * @brief Destroys a scheduler object.
  47          *
  48          * @param scheduler     calling object
  49          */
  50         void (*destroy) (scheduler_t *scheduler);
  51 };
  52
  53 /**
  54  * @brief Create a scheduler with its associated thread.
  55  *
  56  * The thread will start to get jobs form the event queue
  57  * and adds them to the job queue.
  58  *
  59  * @return
  60  *                              - scheduler_t object
  61  *                              - NULL if thread could not be started
  62  *
  63  * @ingroup threads
  64  */
  65 scheduler_t * scheduler_create();
  66
  67 #endif /*SCHEDULER_H_*/