gnunet_my_lib.h

Go to the documentation of this file.

/*
     This file is part of GNUnet
     Copyright (C) 2016 GNUnet e.V.
 
     GNUnet is free software: you can redistribute it and/or modify it
     under the terms of the GNU Affero General Public License as published
     by the Free Software Foundation, either version 3 of the License,
     or (at your option) any later version.
 
     GNUnet is distributed in the hope that it will be useful, but
     WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
     Affero General Public License for more details.
 
     You should have received a copy of the GNU Affero General Public License
     along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
     SPDX-License-Identifier: AGPL3.0-or-later
 */
#ifndef GNUNET_MY_LIB_H
#define GNUNET_MY_LIB_H
 
 
#include "gnunet_util_lib.h"
#include "gnunet_mysql_lib.h"
#include <mysql/mysql.h>
 
#ifndef MYSQL_BOOL
#error "You need to define MYSQL_BOOL. See (or include) gnunet_mysql_compat.h"
#endif
 
#ifdef __cplusplus
extern "C"
{
#if 0                           /* keep Emacsens' auto-indent happy */
}
#endif
#endif
 
 
struct GNUNET_MY_QueryParam;
 
 
typedef int
(*GNUNET_MY_QueryConverter)(void *cls,
                            const struct GNUNET_MY_QueryParam *qp,
                            MYSQL_BIND *qbind);
 
 
typedef void
(*GNUNET_MY_QueryCleanup)(void *cls,
                          MYSQL_BIND *qbind);
struct GNUNET_MY_QueryParam
{
  GNUNET_MY_QueryConverter conv;
 
  GNUNET_MY_QueryCleanup cleaner;
 
  void *conv_cls;
 
  unsigned int num_params;
 
  const void *data;
 
  unsigned long data_len;
};
 
#define GNUNET_MY_query_param_end { NULL, NULL, NULL, 0, NULL, 0 }
 
 
struct GNUNET_MY_QueryParam
GNUNET_MY_query_param_fixed_size (const void *ptr,
                                  size_t ptr_size);
 
 
int
GNUNET_MY_exec_prepared (struct GNUNET_MYSQL_Context *mc,
                         struct GNUNET_MYSQL_StatementHandle *sh,
                         struct GNUNET_MY_QueryParam *params);
 
 
struct GNUNET_MY_ResultParam;
 
struct GNUNET_MY_ResultSpec;
 
typedef int
(*GNUNET_MY_ResultConverter)(void *cls,
                             struct GNUNET_MY_ResultSpec *rs,
                             MYSQL_STMT *stmt,
                             unsigned int column,
                             MYSQL_BIND *results);
 
typedef void
(*GNUNET_MY_ResultCleanup)(void *cls,
                           struct GNUNET_MY_ResultSpec *rs);
 
 
struct GNUNET_MY_ResultSpec
{
  GNUNET_MY_ResultConverter pre_conv;
 
  GNUNET_MY_ResultConverter post_conv;
 
  GNUNET_MY_ResultCleanup cleaner;
 
  void *conv_cls;
 
  void *dst;
 
  size_t dst_size;
 
  size_t *result_size;
 
  unsigned int num_fields;
 
  unsigned long mysql_bind_output_length;
 
  MYSQL_BOOL is_null;
};
 
 
#define GNUNET_MY_result_spec_end { NULL, NULL, NULL, 0, NULL, 0, 0 }
 
 
struct GNUNET_MY_ResultSpec
GNUNET_MY_result_spec_fixed_size (void *ptr,
                                  size_t ptr_size);
 
struct GNUNET_MY_QueryParam
GNUNET_MY_query_param_string (const char *ptr);
 
#define GNUNET_MY_query_param_auto_from_type( \
    x) GNUNET_MY_query_param_fixed_size ((x), sizeof(*(x)))
 
struct GNUNET_MY_QueryParam
GNUNET_MY_query_param_rsa_public_key (const struct
                                      GNUNET_CRYPTO_RsaPublicKey *x);
 
struct GNUNET_MY_QueryParam
GNUNET_MY_query_param_rsa_signature (const struct
                                     GNUNET_CRYPTO_RsaSignature *x);
 
struct GNUNET_MY_QueryParam
GNUNET_MY_query_param_absolute_time (const struct GNUNET_TIME_Absolute *x);
 
 
struct GNUNET_MY_QueryParam
GNUNET_MY_query_param_absolute_time_nbo (const struct
                                         GNUNET_TIME_AbsoluteNBO *x);
 
struct GNUNET_MY_QueryParam
GNUNET_MY_query_param_uint16 (const uint16_t *x);
 
struct GNUNET_MY_QueryParam
GNUNET_MY_query_param_uint32 (const uint32_t *x);
 
struct GNUNET_MY_QueryParam
GNUNET_MY_query_param_uint64 (const uint64_t *x);
 
#define GNUNET_MY_result_spec_auto_from_type( \
    dst) GNUNET_MY_result_spec_fixed_size ((dst), sizeof(*(dst)))
 
 
struct GNUNET_MY_ResultSpec
GNUNET_MY_result_spec_variable_size (void **dst,
                                     size_t *ptr_size);
 
struct GNUNET_MY_ResultSpec
GNUNET_MY_result_spec_rsa_public_key (struct GNUNET_CRYPTO_RsaPublicKey **rsa);
 
 
struct GNUNET_MY_ResultSpec
GNUNET_MY_result_spec_rsa_signature (struct GNUNET_CRYPTO_RsaSignature **sig);
 
struct GNUNET_MY_ResultSpec
GNUNET_MY_result_spec_string (char **dst);
 
struct GNUNET_MY_ResultSpec
GNUNET_MY_result_spec_absolute_time (struct GNUNET_TIME_Absolute *at);
 
struct GNUNET_MY_ResultSpec
GNUNET_MY_result_spec_absolute_time_nbo (struct GNUNET_TIME_AbsoluteNBO *at);
 
struct GNUNET_MY_ResultSpec
GNUNET_MY_result_spec_uint16 (uint16_t *u16);
 
struct GNUNET_MY_ResultSpec
GNUNET_MY_result_spec_uint32 (uint32_t *u32);
 
struct GNUNET_MY_ResultSpec
GNUNET_MY_result_spec_uint64 (uint64_t *u64);
 
 
int
GNUNET_MY_extract_result (struct GNUNET_MYSQL_StatementHandle *sh,
                          struct GNUNET_MY_ResultSpec *specs);
 
 
void
GNUNET_MY_cleanup_query (struct GNUNET_MY_QueryParam *qp,
                         MYSQL_BIND *qbind);
 
 
void
GNUNET_MY_cleanup_result (struct GNUNET_MY_ResultSpec *rs);
 
 
#if 0                           /* keep Emacsens' auto-indent happy */
{
#endif
#ifdef __cplusplus
}
#endif
 
#endif
  /* end of group */
  /* end of group addition to lib_extra */