src/libimcv/tcg/pts/pts_database.h

   1 /*
   2  * Copyright (C) 2011 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 pts_database pts_database
  18  * @{ @ingroup pts
  19  */
  20
  21 #ifndef PTS_DATABASE_H_
  22 #define PTS_DATABASE_H_
  23
  24 typedef struct pts_database_t pts_database_t;
  25
  26 #include "pts_meas_algo.h"
  27 #include <library.h>
  28
  29 /**
  30  * Class implementing the PTS File Measurement database
  31  *
  32  */
  33 struct pts_database_t {
  34
  35         /**
  36          * Get files to be measured by PTS
  37          *
  38          * @product                             software product (os, vpn client, etc.)
  39          * @return                              enumerator over all files matching a given release
  40          */
  41         enumerator_t* (*create_file_enumerator)(pts_database_t *this, char *product);
  42
  43         /**
  44          * Get Hash measurement of a file with given id and hashing algorithm type
  45          *
  46          * @product                             software product (os, vpn client, etc.)
  47          * @id                                  primary key in files table
  48          * @algorithm                           measurement algorithm type
  49          * @return                              enumerator over all measurements matching a given release
  50          */
  51         enumerator_t* (*create_meas_enumerator)(pts_database_t *this, char *product, int id, pts_meas_algorithms_t algorithm);
  52
  53         /**
  54          * Destroys a pts_database_t object.
  55          */
  56         void (*destroy)(pts_database_t *this);
  57
  58 };
  59
  60 /**
  61  * Creates an pts_database_t object
  62  *
  63  * @param ur                            database uri
  64  */
  65 pts_database_t* pts_database_create(char *uri);
  66
  67 #endif /** PTS_DATABASE_H_ @}*/