programs/charon/charon/config/connections/local_connection_store.h

   1 /**
   2  * @file local_connection_store.h
   3  *
   4  * @brief Interface of local_connection_store_t.
   5  *
   6  */
   7
   8 /*
   9  * Copyright (C) 2006 Martin Willi
  10  * Hochschule fuer Technik Rapperswil
  11  *
  12  * This program is free software; you can redistribute it and/or modify it
  13  * under the terms of the GNU General Public License as published by the
  14  * Free Software Foundation; either version 2 of the License, or (at your
  15  * option) any later version.  See <http://www.fsf.org/copyleft/gpl.txt>.
  16  *
  17  * This program is distributed in the hope that it will be useful, but
  18  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  19  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  20  * for more details.
  21  */
  22
  23 #ifndef LOCAL_CONNECTION_H_
  24 #define LOCAL_CONNECTION_H_
  25
  26 #include <types.h>
  27 #include <config/connections/connection_store.h>
  28
  29
  30 typedef struct local_connection_store_t local_connection_store_t;
  31
  32 /**
  33  * @brief A connection_store_t implementation using a simple connection list.
  34  *
  35  * The local_connection_store_t class implements the connection_store_t interface
  36  * as simple as possible. connection_t's are stored in an in-memory list.
  37  *
  38  * @b Constructors:
  39  *  - local_connection_store_create()
  40  *
  41  * @todo Make thread-save first
  42  * @todo Add remove_connection method
  43  *
  44  * @ingroup config
  45  */
  46 struct local_connection_store_t {
  47
  48         /**
  49          * Implements connection_store_t interface
  50          */
  51         connection_store_t connection_store;
  52 };
  53
  54 /**
  55  * @brief Creates a local_connection_store_t instance.
  56  *
  57  * @return connection store instance.
  58  *
  59  * @ingroup config
  60  */
  61 local_connection_store_t * local_connection_store_create();
  62
  63 #endif /* LOCAL_CONNECTION_H_ */