src/sensor/gnunet_sensor_model_plugin.h

   1 /*
   2      This file is part of GNUnet
   3      (C) 2012, 2013 Christian Grothoff (and other contributing authors)
   4
   5      GNUnet is free software; you can redistribute it and/or modify
   6      it under the terms of the GNU General Public License as published
   7      by the Free Software Foundation; either version 3, or (at your
   8      option) any later version.
   9
  10      GNUnet is distributed in the hope that it will be useful, but
  11      WITHOUT ANY WARRANTY; without even the implied warranty of
  12      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13      General Public License for more details.
  14
  15      You should have received a copy of the GNU General Public License
  16      along with GNUnet; see the file COPYING.  If not, write to the
  17      Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18      Boston, MA 02111-1307, USA.
  19 */
  20
  21 /**
  22  * @file sensor/gnunet_sensor_model_plugin.h
  23  * @brief plugin API for sensor analysis models
  24  * @author Omar Tarabai
  25  */
  26 #ifndef GNUNET_SENSOR_MODEL_PLUGIN_H
  27 #define GNUNET_SENSOR_MODEL_PLUGIN_H
  28
  29 #include "gnunet_util_lib.h"
  30
  31 #ifdef __cplusplus
  32 extern "C"
  33 {
  34 #if 0                           /* keep Emacsens' auto-indent happy */
  35 }
  36 #endif
  37 #endif
  38
  39
  40 /**
  41  * API for a sensor analysis model
  42  */
  43 struct GNUNET_SENSOR_ModelFunctions
  44 {
  45
  46   /**
  47    * Closure to pass to all plugin functions.
  48    */
  49   void *cls;
  50
  51   /*
  52    * Create a model instance
  53    *
  54    * @param cls closure (plugin state)
  55    * @return model state to be used for later calls
  56    */
  57   void *(*create_model) (void *cls);
  58
  59   /*
  60    * Destroy a model instance
  61    *
  62    * @param cls closure (model state)
  63    */
  64   void (*destroy_model) (void *cls);
  65
  66   /*
  67    * Feed a new value to a model
  68    *
  69    * @param cls closure (model state)
  70    * @param val value to be fed to the model
  71    * @return #GNUNET_YES in case of a detected outlier, #GNUNET_NO otherwise
  72    */
  73   int (*feed_model) (void *cls, double val);
  74
  75 };
  76
  77
  78 #if 0                           /* keep Emacsens' auto-indent happy */
  79 {
  80 #endif
  81 #ifdef __cplusplus
  82 }
  83 #endif
  84
  85 /* end of gnunet_sensor_model_plugin.h */
  86 #endif