src/charon/threads/scheduler.h

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