src/include/gnunet_client_lib.h

   1 /*
   2      This file is part of GNUnet.
   3      Copyright (C) 2001-2013, 2016 GNUnet e.V.
   4
   5      GNUnet is free software: you can redistribute it and/or modify it
   6      under the terms of the GNU Affero General Public License as published
   7      by the Free Software Foundation, either version 3 of the License,
   8      or (at your 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      Affero General Public License for more details.
  14
  15      You should have received a copy of the GNU Affero General Public License
  16      along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17
  18      SPDX-License-Identifier: AGPL3.0-or-later
  19  */
  20
  21 /**
  22  * @author Christian Grothoff
  23  *
  24  * @file
  25  * Functions related to accessing services
  26
  27  * @defgroup client  Client library
  28  * Generic client-side communication with services
  29  *
  30  * @see [Documentation](https://gnunet.org/ipc)
  31  *
  32  * @{
  33  */
  34
  35 #ifndef GNUNET_CLIENT_LIB_H
  36 #define GNUNET_CLIENT_LIB_H
  37
  38 #ifdef __cplusplus
  39 extern "C"
  40 {
  41 #if 0                           /* keep Emacsens' auto-indent happy */
  42 }
  43 #endif
  44 #endif
  45
  46 #include "gnunet_mq_lib.h"
  47
  48
  49 /**
  50  * Create a message queue to connect to a GNUnet service.
  51  * If handlers are specfied, receive messages from the connection.
  52  *
  53  * @param connection the client connection
  54  * @param handlers handlers for receiving messages, can be NULL
  55  * @param error_handler error handler
  56  * @param error_handler_cls closure for the @a error_handler
  57  * @return the message queue, NULL on error
  58  */
  59 struct GNUNET_MQ_Handle *
  60 GNUNET_CLIENT_connect(const struct GNUNET_CONFIGURATION_Handle *cfg,
  61                       const char *service_name,
  62                       const struct GNUNET_MQ_MessageHandler *handlers,
  63                       GNUNET_MQ_ErrorHandler error_handler,
  64                       void *error_handler_cls);
  65
  66
  67 #if 0                           /* keep Emacsens' auto-indent happy */
  68 {
  69 #endif
  70 #ifdef __cplusplus
  71 }
  72 #endif
  73
  74 /* ifndef GNUNET_CLIENT_LIB_H */
  75 #endif
  76
  77 /** @} */ /* end of group client */
  78
  79 /* end of gnunet_client_lib.h */