src/include/gnunet_helper_lib.h

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2011, 2012 Christian Grothoff
   4
   5      GNUnet is free software; you can redistribute it and/or modify
   6      it under the terms of the GNU General Public License as published
   7      by the Free Software Foundation; either version 3, or (at your
   8      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      General Public License for more details.
  14
  15      You should have received a copy of the GNU General Public License
  16      along with GNUnet; see the file COPYING.  If not, write to the
  17      Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18      Boston, MA 02111-1307, USA.
  19 */
  20
  21 /**
  22  * @file include/gnunet_helper_lib.h
  23  * @brief API for dealing with (SUID) helper processes that communicate via GNUNET_MessageHeaders on stdin/stdout
  24  * @author Philipp Toelke
  25  * @author Christian Grothoff
  26  */
  27 #ifndef GNUNET_HELPER_LIB_H
  28 #define GNUNET_HELPER_LIB_H
  29
  30 #include "gnunet_scheduler_lib.h"
  31 #include "gnunet_server_lib.h"
  32
  33 /**
  34  * The handle to a helper process.
  35  */
  36 struct GNUNET_HELPER_Handle;
  37
  38
  39 /**
  40  * @brief Starts a helper and begins reading from it
  41  *
  42  * @param binary_name name of the binary to run
  43  * @param binary_argv NULL-terminated list of arguments to give when starting the binary (this
  44  *                    argument must not be modified by the client for
  45  *                     the lifetime of the helper handle)
  46  * @param cb function to call if we get messages from the helper
  47  * @param cb_cls Closure for the callback
  48  * @return the new Handle, NULL on error
  49  */
  50 struct GNUNET_HELPER_Handle *
  51 GNUNET_HELPER_start (const char *binary_name,
  52                      char *const binary_argv[],
  53                      GNUNET_SERVER_MessageTokenizerCallback cb, void *cb_cls);
  54
  55
  56 /**
  57  * @brief Kills the helper, closes the pipe and frees the handle
  58  *
  59  * @param h handle to helper to stop
  60  */
  61 void
  62 GNUNET_HELPER_stop (struct GNUNET_HELPER_Handle *h);
  63
  64
  65 /**
  66  * Continuation function.
  67  *
  68  * @param cls closure
  69  * @param result GNUNET_OK on success,
  70  *               GNUNET_NO if helper process died
  71  *               GNUNET_SYSERR during GNUNET_HELPER_stop
  72  */
  73 typedef void (*GNUNET_HELPER_Continuation)(void *cls,
  74                                            int result);
  75
  76
  77 /**
  78  * Handle to cancel 'send'
  79  */
  80 struct GNUNET_HELPER_SendHandle;
  81
  82
  83 /**
  84  * Send an message to the helper.
  85  *
  86  * @param h helper to send message to
  87  * @param msg message to send
  88  * @param can_drop can the message be dropped if there is already one in the queue?
  89  * @param cont continuation to run once the message is out
  90  * @param cont_cls closure for 'cont'
  91  * @return NULL if the message was dropped,
  92  *         otherwise handle to cancel *cont* (actual transmission may
  93  *         not be abortable)
  94  */
  95 struct GNUNET_HELPER_SendHandle *
  96 GNUNET_HELPER_send (struct GNUNET_HELPER_Handle *h,
  97                     const struct GNUNET_MessageHeader *msg,
  98                     int can_drop,
  99                     GNUNET_HELPER_Continuation cont,
 100                     void *cont_cls);
 101
 102
 103 /**
 104  * Cancel a 'send' operation.  If possible, transmitting the
 105  * message is also aborted, but at least 'cont' won't be
 106  * called.
 107  *
 108  * @param sh operation to cancel
 109  */
 110 void
 111 GNUNET_HELPER_send_cancel (struct GNUNET_HELPER_SendHandle *sh);
 112
 113 #endif /* end of include guard: GNUNET_HELPER_LIB_H */