src_frescan/frescan_bwres_mode_change.h

   1 /*!
   2  * @file frescan_bwres_analysis.h
   3  *
   4  * @brief FRESCAN bandwith reservation layer: mode change protocol
   5  *
   6  * @version 0.02
   7  *
   8  * @date 19-Jul-2008
   9  *
  10  * @author Daniel Sangorrin <daniel.sangorrin@unican.es>
  11  *
  12  * @comments
  13  *
  14  * This module contains the mode change protocol
  15  *
  16  * @license
  17  *
  18 //----------------------------------------------------------------------
  19 //  Copyright (C) 2006 - 2009 by the FRESCOR consortium:
  20 //
  21 //    Universidad de Cantabria,              SPAIN
  22 //    University of York,                    UK
  23 //    Scuola Superiore Sant'Anna,            ITALY
  24 //    Kaiserslautern University,             GERMANY
  25 //    Univ. Politecnica  Valencia,           SPAIN
  26 //    Czech Technical University in Prague,  CZECH REPUBLIC
  27 //    ENEA                                   SWEDEN
  28 //    Thales Communication S.A.              FRANCE
  29 //    Visual Tools S.A.                      SPAIN
  30 //    Rapita Systems Ltd                     UK
  31 //    Evidence                               ITALY
  32 //
  33 //    See http://www.frescor.org
  34 //
  35 //        The FRESCOR project (FP6/2005/IST/5-034026) is funded
  36 //        in part by the European Union Sixth Framework Programme
  37 //        The European Union is not liable of any use that may be
  38 //        made of this code.
  39 //
  40 //
  41 //  based on previous work (FSF) done in the FIRST project
  42 //
  43 //   Copyright (C) 2005  Mälardalen University, SWEDEN
  44 //                       Scuola Superiore S.Anna, ITALY
  45 //                       Universidad de Cantabria, SPAIN
  46 //                       University of York, UK
  47 //
  48 // This file is part of FNA (Frescor Network Adaptation)
  49 //
  50 // FNA is free software; you can redistribute it and/or modify it
  51 // under terms of the GNU General Public License as published by the
  52 // Free Software Foundation; either version 2, or (at your option) any
  53 // later version.  FNA is distributed in the hope that it will be
  54 // useful, but WITHOUT ANY WARRANTY; without even the implied warranty
  55 // of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  56 // General Public License for more details. You should have received a
  57 // copy of the GNU General Public License along with FNA; see file
  58 // COPYING. If not, write to the Free Software Foundation, 675 Mass Ave,
  59 // Cambridge, MA 02139, USA.
  60 //
  61 // As a special exception, including FNA header files in a file,
  62 // instantiating FNA generics or templates, or linking other files
  63 // with FNA objects to produce an executable application, does not
  64 // by itself cause the resulting executable application to be covered
  65 // by the GNU General Public License. This exception does not
  66 // however invalidate any other reasons why the executable file might be
  67 // covered by the GNU Public License.
  68 // -----------------------------------------------------------------------
  69  *
  70  */
  71
  72 #ifndef _FRESCAN_BWRES_MODE_CHANGE_H_
  73 #define _FRESCAN_BWRES_MODE_CHANGE_H_
  74
  75 #include "frescan_types.h"
  76
  77 /**
  78  * frescan_bwres_mode_change_protocol()
  79  *
  80  * Performs the mode change protocol. This function is called by the master
  81  * node who coordinates all the process.
  82  */
  83
  84 extern int frescan_bwres_mode_change_protocol
  85                                 (frescan_bwres_request_data_t *req_data);
  86
  87 /**
  88  * frescan_bwres_mode_change_local()
  89  *
  90  * This function updates local vres. When a slave receives a change mode
  91  * message to change the values of any vres this function is called.
  92  */
  93
  94 extern int frescan_bwres_mode_change_local
  95                 (frescan_network_t net,
  96                  frescan_bwres_mode_change_type_t mode_change_type,
  97                  frescan_ss_group_t *ss_to_cancel);
  98
  99 #endif // _FRESCAN_BWRES_MODE_CHANGE_H_