src/include/gnunet_dv_service.h

   1 /*
   2       This file is part of GNUnet
   3       (C) 2009 Christian Grothoff (and other contributing authors)
   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_dv_service.h
  23  * @brief API to deal with dv service
  24  *
  25  * @author Christian Grothoff
  26  * @author Nathan Evans
  27  */
  28
  29 #ifndef GNUNET_DV_SERVICE_H
  30 #define GNUNET_DV_SERVICE_H
  31
  32 #ifdef __cplusplus
  33 extern "C"
  34 {
  35 #if 0                           /* keep Emacsens' auto-indent happy */
  36 }
  37 #endif
  38 #endif
  39
  40 #include "gnunet_common.h"
  41 #include "gnunet_configuration_lib.h"
  42 #include "gnunet_scheduler_lib.h"
  43 #include "gnunet_transport_plugin.h"
  44
  45 /**
  46  * Version of the dv API.
  47  */
  48 #define GNUNET_DV_VERSION 0x00000000
  49
  50 /**
  51  * Opaque handle for the dv service.
  52  */
  53 struct GNUNET_DV_Handle;
  54
  55 /**
  56  * Send a message from the plugin to the DV service indicating that
  57  * a message should be sent via DV to some peer.
  58  *
  59  * @param dv_handle the handle to the DV api
  60  * @param target the final target of the message
  61  * @param msgbuf the msg(s) to send
  62  * @param msgbuf_size the size of msgbuf
  63  * @param priority priority to pass on to core when sending the message
  64  * @param timeout how long can this message be delayed (pass through to core)
  65  * @param addr the address of this peer (internally known to DV)
  66  * @param addrlen the length of the peer address
  67  * @param cont continuation to call once the message has been sent (or failed)
  68  * @param cont_cls closure for continuation
  69  *
  70  */
  71 int
  72 GNUNET_DV_send (struct GNUNET_DV_Handle *dv_handle,
  73                 const struct GNUNET_PeerIdentity *target, const char *msgbuf,
  74                 size_t msgbuf_size, unsigned int priority,
  75                 struct GNUNET_TIME_Relative timeout, const void *addr,
  76                 size_t addrlen, GNUNET_TRANSPORT_TransmitContinuation cont,
  77                 void *cont_cls);
  78
  79
  80
  81 #if 0                           /* keep Emacsens' auto-indent happy */
  82 {
  83 #endif
  84 #ifdef __cplusplus
  85 }
  86 #endif
  87
  88 #endif