src_frescan/frescan_servers_replenishments.h

   1 /*!
   2  * @file frescan_servers_replenishments.h
   3  *
   4  * @brief the replenishment data and thread for the servers
   5  *
   6  * @version 0.01
   7  *
   8  * @date 12-Mar-2008
   9  *
  10  * @author
  11  *      Daniel Sangorrin
  12  *
  13  * @comments
  14  *
  15  * This module contains the thread that waits for server's replenishment
  16  * timer signals and perform the necessary replenishments.
  17  *
  18  * @license
  19  *
  20  * -----------------------------------------------------------------------
  21  *  Copyright (C) 2006 - 2008 FRESCOR consortium partners:
  22  *
  23  *    Universidad de Cantabria,              SPAIN
  24  *    University of York,                    UK
  25  *    Scuola Superiore Sant'Anna,            ITALY
  26  *    Kaiserslautern University,             GERMANY
  27  *    Univ. Politécnica  Valencia,           SPAIN
  28  *    Czech Technical University in Prague,  CZECH REPUBLIC
  29  *    ENEA                                   SWEDEN
  30  *    Thales Communication S.A.              FRANCE
  31  *    Visual Tools S.A.                      SPAIN
  32  *    Rapita Systems Ltd                     UK
  33  *    Evidence                               ITALY
  34  *
  35  *    See http://www.frescor.org for a link to partners' websites
  36  *
  37  *           FRESCOR project (FP6/2005/IST/5-034026) is funded
  38  *        in part by the European Union Sixth Framework Programme
  39  *        The European Union is not liable of any use that may be
  40  *        made of this code.
  41  *
  42  *  This file is part of FRESCAN
  43  *
  44  *  FRESCAN is free software; you can  redistribute it and/or  modify
  45  *  it under the terms of  the GNU General Public License as published by
  46  *  the Free Software Foundation;  either  version 2, or (at  your option)
  47  *  any later version.
  48  *
  49  *  FRESCAN  is distributed  in  the hope  that  it  will  be useful,  but
  50  *  WITHOUT  ANY  WARRANTY;     without  even the   implied   warranty  of
  51  *  MERCHANTABILITY  or  FITNESS FOR  A  PARTICULAR PURPOSE. See  the  GNU
  52  *  General Public License for more details.
  53  *
  54  *  You should have  received a  copy of  the  GNU  General Public License
  55  *  distributed  with  FRESCAN;  see file COPYING.   If not,  write to the
  56  *  Free Software  Foundation,  59 Temple Place  -  Suite 330,  Boston, MA
  57  *  02111-1307, USA.
  58  *
  59  * As a special exception, including FRESCAN header files in a file,
  60  * instantiating FRESCAN generics or templates, or linking other files
  61  * with FRESCAN objects to produce an executable application, does not
  62  * by itself cause the resulting executable application to be covered
  63  * by the GNU General Public License. This exception does not
  64  * however invalidate any other reasons why the executable file might be
  65  * covered by the GNU Public License.
  66  * -----------------------------------------------------------------------
  67  *
  68  */
  69
  70 #ifndef _MARTE_FRESCAN_SERVERS_REPLENISHMENTS_H_
  71 #define _MARTE_FRESCAN_SERVERS_REPLENISHMENTS_H_
  72
  73 #include "frescan_types.h"
  74
  75 /**
  76  * frescan_replenishments_init - init the replenishment structures and thread
  77  *
  78  * @net: the network instance
  79  *
  80  * Initialize the repl_op pool, set the mask for the timer signals and create
  81  * the thread that will await for those signals and replenish the appropiate
  82  * sporadic server.
  83  *
  84  * NOTE: it must be called from the MAIN because it sets the signal mask
  85  */
  86
  87 extern int frescan_replenishments_init(frescan_network_t net);
  88
  89 extern frescan_repl_op_t *frescan_repl_op_alloc();
  90
  91 extern int frescan_repl_op_free(frescan_repl_op_t *repl_op);
  92
  93 /**
  94  * frescan_replenishment_program - set a replenishment operation
  95  *
  96  * @net: the network instance
  97  * @ss: the server
  98  * @timestamp: timestamp
  99  */
 100
 101 extern int frescan_replenishment_program(frescan_network_t net,
 102                                          frescan_ss_t id,
 103                                          const struct timespec *timestamp);
 104
 105 #endif // _MARTE_FRESCAN_SERVERS_REPLENISHMENTS_H_