src/libcharon/tnc/imv/imv_manager.h

   1 /*
   2  * Copyright (C) 2010 Andreas Steffen
   3  * HSR Hochschule fuer Technik Rapperswil
   4  *
   5  * This program is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License as published by the
   7  * Free Software Foundation; either version 2 of the License, or (at your
   8  * option) any later version.  See <http://www.fsf.org/copyleft/gpl.txt>.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  12  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  13  * for more details.
  14  */
  15
  16 /**
  17  * @defgroup imv_manager imv_manager
  18  * @{ @ingroup imv
  19  */
  20
  21 #ifndef IMV_MANAGER_H_
  22 #define IMV_MANAGER_H_
  23
  24 #include "imv.h"
  25
  26 #include <library.h>
  27
  28 typedef struct imv_manager_t imv_manager_t;
  29
  30 /**
  31  * The IMV manager controls all IMV instances.
  32  */
  33 struct imv_manager_t {
  34
  35         /**
  36          * Add an IMV instance
  37          *
  38          * @param imv                           IMV instance
  39          * @return                                      TRUE if initialization successful
  40          */
  41         bool (*add)(imv_manager_t *this, imv_t *imv);
  42
  43         /**
  44          * Remove an IMV instance from the list and return it
  45          *
  46          * @param id                            ID of IMV instance
  47          * @return                                      removed IMC instance
  48          */
  49         imv_t* (*remove)(imv_manager_t *this, TNC_IMVID id);
  50
  51         /**
  52          * Return the number of registered IMVs
  53          *
  54          * @return                                      number of IMVs
  55          */
  56         int (*get_count)(imv_manager_t *this);
  57
  58         /**
  59          * Notify all IMV instances
  60          *
  61          * @param state                 communicate the state a connection has reached
  62          */
  63         void (*notify_connection_change)(imv_manager_t *this,
  64                                                                          TNC_ConnectionID id,
  65                                                                          TNC_ConnectionState state);
  66
  67         /**
  68          * Sets the supported message types reported by a given IMV
  69          *
  70          * @param id                            ID of reporting IMV
  71          * @param supported_types       list of messages type supported by IMV
  72          * @param type_count            number of supported message types
  73          * @return                                      TNC result code
  74          */
  75         TNC_Result (*set_message_types)(imv_manager_t *this,
  76                                                                         TNC_IMVID id,
  77                                                                         TNC_MessageTypeList supported_types,
  78                                                                         TNC_UInt32 type_count);
  79
  80         /**
  81          * Solicit recommendations from IMVs that have not yet provided one
  82          *
  83          * @param id                            connection ID
  84          */
  85         void (*solicit_recommendation)(imv_manager_t *this, TNC_ConnectionID id);
  86
  87         /**
  88          * Delivers a message to interested IMVs.
  89          *
  90          * @param connection_id         ID of connection over which message was received
  91          * @param message                       message
  92          * @param message_len           message length
  93          * @param message_type          message type
  94          */
  95         void (*receive_message)(imv_manager_t *this,
  96                                                         TNC_ConnectionID connection_id,
  97                                                         TNC_BufferReference message,
  98                                                         TNC_UInt32 message_len,
  99                                                         TNC_MessageType message_type);
 100
 101         /**
 102          * Notify all IMVs that all IMC messages received in a batch have been
 103          * delivered and this is the IMVs last chance to send a message in the
 104          * batch of IMV messages currently being collected.
 105          *
 106          * @param id                            connection ID
 107          */
 108         void (*batch_ending)(imv_manager_t *this, TNC_ConnectionID id);
 109
 110         /**
 111          * Destroy an IMV manager and all its controlled instances.
 112          */
 113         void (*destroy)(imv_manager_t *this);
 114 };
 115
 116 #endif /** IMV_MANAGER_H_ @}*/