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
  28 #ifndef GNUNET_HELPER_LIB_H
  29 #define GNUNET_HELPER_LIB_H
  30
  31 #include "gnunet_scheduler_lib.h"
  32 #include "gnunet_server_lib.h"
  33
  34 /**
  35  * The handle to a helper process.
  36  */
  37 struct GNUNET_HELPER_Handle;
  38
  39
  40 /**
  41  * Callback that will be called when the helper process dies. This is not called
  42  * when the helper process is stoped using GNUNET_HELPER_stop()
  43  *
  44  * @param cls the closure from GNUNET_HELPER_start()
  45  */
  46 typedef void (*GNUNET_HELPER_ExceptionCallback) (void *cls);
  47
  48
  49 /**
  50  * Starts a helper and begins reading from it. The helper process is
  51  * restarted when it dies except when it is stopped using GNUNET_HELPER_stop()
  52  * or when the exp_cb callback is not NULL.
  53  *
  54  * @param binary_name name of the binary to run
  55  * @param binary_argv NULL-terminated list of arguments to give when starting the binary (this
  56  *                    argument must not be modified by the client for
  57  *                     the lifetime of the helper handle)
  58  * @param cb function to call if we get messages from the helper
  59  * @param exp_cb the exception callback to call. Set this to NULL if the helper
  60  *          process has to be restarted automatically when it dies/crashes
  61  * @param cb_cls closure for the above callbacks
  62  * @return the new Handle, NULL on error
  63  */
  64 struct GNUNET_HELPER_Handle *
  65 GNUNET_HELPER_start (const char *binary_name,
  66                      char *const binary_argv[],
  67                      GNUNET_SERVER_MessageTokenizerCallback cb,
  68                      GNUNET_HELPER_ExceptionCallback exp_cb,
  69                      void *cb_cls);
  70
  71
  72 /**
  73  * Kills the helper, closes the pipe and frees the handle
  74  *
  75  * @param h handle to helper to stop
  76  */
  77 void
  78 GNUNET_HELPER_stop (struct GNUNET_HELPER_Handle *h);
  79
  80
  81 /**
  82  * Continuation function.
  83  *
  84  * @param cls closure
  85  * @param result GNUNET_OK on success,
  86  *               GNUNET_NO if helper process died
  87  *               GNUNET_SYSERR during GNUNET_HELPER_stop
  88  */
  89 typedef void (*GNUNET_HELPER_Continuation)(void *cls,
  90                                            int result);
  91
  92
  93 /**
  94  * Handle to cancel 'send'
  95  */
  96 struct GNUNET_HELPER_SendHandle;
  97
  98
  99 /**
 100  * Send an message to the helper.
 101  *
 102  * @param h helper to send message to
 103  * @param msg message to send
 104  * @param can_drop can the message be dropped if there is already one in the queue?
 105  * @param cont continuation to run once the message is out
 106  * @param cont_cls closure for 'cont'
 107  * @return NULL if the message was dropped,
 108  *         otherwise handle to cancel *cont* (actual transmission may
 109  *         not be abortable)
 110  */
 111 struct GNUNET_HELPER_SendHandle *
 112 GNUNET_HELPER_send (struct GNUNET_HELPER_Handle *h,
 113                     const struct GNUNET_MessageHeader *msg,
 114                     int can_drop,
 115                     GNUNET_HELPER_Continuation cont,
 116                     void *cont_cls);
 117
 118
 119 /**
 120  * Cancel a 'send' operation.  If possible, transmitting the
 121  * message is also aborted, but at least 'cont' won't be
 122  * called.
 123  *
 124  * @param sh operation to cancel
 125  */
 126 void
 127 GNUNET_HELPER_send_cancel (struct GNUNET_HELPER_SendHandle *sh);
 128
 129 #endif /* end of include guard: GNUNET_HELPER_LIB_H */