src/cadet/gnunet-service-cadet-new_connection.h

   1
   2 /*
   3      This file is part of GNUnet.
   4      Copyright (C) 2001-2017 GNUnet e.V.
   5
   6      GNUnet is free software; you can redistribute it and/or modify
   7      it under the terms of the GNU General Public License as published
   8      by the Free Software Foundation; either version 3, or (at your
   9      option) any later version.
  10
  11      GNUnet is distributed in the hope that it will be useful, but
  12      WITHOUT ANY WARRANTY; without even the implied warranty of
  13      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14      General Public License for more details.
  15
  16      You should have received a copy of the GNU General Public License
  17      along with GNUnet; see the file COPYING.  If not, write to the
  18      Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  19      Boston, MA 02110-1301, USA.
  20 */
  21
  22 /**
  23  * @file cadet/gnunet-service-cadet-new_connection.h
  24  * @brief
  25  * @author Bartlomiej Polot
  26  * @author Christian Grothoff
  27  */
  28 #ifndef GNUNET_SERVICE_CADET_CONNECTION_H
  29 #define GNUNET_SERVICE_CADET_CONNECTION_H
  30
  31 #include "gnunet_util_lib.h"
  32 #include "gnunet-service-cadet-new.h"
  33 #include "gnunet-service-cadet-new_peer.h"
  34
  35
  36 /**
  37  * Is the given connection currently ready for transmission?
  38  *
  39  * @param cc connection to transmit on
  40  * @return #GNUNET_YES if we could transmit
  41  */
  42 int
  43 GCC_is_ready (struct CadetConnection *cc);
  44
  45
  46 /**
  47  * Destroy a connection.
  48  *
  49  * @param cc connection to destroy
  50  */
  51 void
  52 GCC_destroy (struct CadetConnection *cc);
  53
  54
  55 /**
  56  * Create a connection to @a destination via @a path and
  57  * notify @a cb whenever we are ready for more data.
  58  *
  59  * @param destination where to go
  60  * @param path which path to take (may not be the full path)
  61  * @param ready_cb function to call when ready to transmit
  62  * @param ready_cb_cls closure for @a cb
  63  */
  64 struct CadetConnection *
  65 GCC_create (struct CadetPeer *destination,
  66             struct CadetPeerPath *path,
  67             GNUNET_SCHEDULER_TaskCallback ready_cb,
  68             void *ready_cb_cls);
  69
  70
  71 /**
  72  * Transmit message @a msg via connection @a cc.  Must only be called
  73  * (once) after the connection has signalled that it is ready via the
  74  * `ready_cb`.  Clients can also use #GCC_is_ready() to check if the
  75  * connection is right now ready for transmission.
  76  *
  77  * @param cc connection identification
  78  * @param msg message to transmit
  79  */
  80 void
  81 GCC_transmit (struct CadetConnection *cc,
  82               const struct GNUNET_MessageHeader *msg);
  83
  84
  85 /**
  86  * Obtain the path used by this connection.
  87  *
  88  * @param cc connection
  89  * @return path to @a cc
  90  */
  91 struct CadetPeerPath *
  92 GCC_get_path (struct CadetConnection *cc);
  93
  94
  95 /**
  96  * Obtain unique ID for the connection.
  97  *
  98  * @param cc connection.
  99  * @return unique number of the connection
 100  */
 101 const struct GNUNET_CADET_ConnectionTunnelIdentifier *
 102 GCC_get_id (struct CadetConnection *cc);
 103
 104
 105 /**
 106  * Log connection info.
 107  *
 108  * @param cc connection
 109  * @param level Debug level to use.
 110  */
 111 void
 112 GCC_debug (struct CadetConnection *cc,
 113            enum GNUNET_ErrorType level);
 114
 115
 116 #endif