src/include/gnunet_transport_monitor_service.h

   1 /*
   2      This file is part of GNUnet.
   3      Copyright (C) 2009-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  * Monitoring / diagnostics API for the transport service
  26  *
  27  * @defgroup transport TRANSPORT service
  28  * Communication with other peers
  29  *
  30  * @see [Documentation](https://gnunet.org/transport-service)
  31  *
  32  * @{
  33  */
  34 #ifndef GNUNET_TRANSPORT_MONITOR_SERVICE_H
  35 #define GNUNET_TRANSPORT_MONITOR_SERVICE_H
  36
  37 #ifdef __cplusplus
  38 extern "C"
  39 {
  40 #if 0                           /* keep Emacsens' auto-indent happy */
  41 }
  42 #endif
  43 #endif
  44
  45 #include "gnunet_util_lib.h"
  46 #include "gnunet_ats_transport_service.h"
  47 #include "gnunet_transport_communication_service.h"
  48
  49
  50 /**
  51  * Version number of the transport API.
  52  */
  53 #define GNUNET_TRANSPORT_MONITOR_VERSION 0x00000000
  54
  55
  56 /**
  57  * Information about another peer's address.
  58  */
  59 struct GNUNET_TRANSPORT_MonitorInformation {
  60   /**
  61    * Address we have for the peer, human-readable, 0-terminated, in UTF-8.
  62    */
  63   const char *address;
  64
  65   /**
  66    * Network type of the address.
  67    */
  68   enum GNUNET_NetworkType nt;
  69
  70   /**
  71    * Connection status.
  72    */
  73   enum GNUNET_TRANSPORT_ConnectionStatus cs;
  74
  75   /**
  76    * Number of messages pending transmission for this @e address.
  77    */
  78   uint32_t num_msg_pending;
  79
  80   /**
  81    * Number of bytes pending transmission for this @e address.
  82    */
  83   uint32_t num_bytes_pending;
  84
  85   /**
  86    * When was this address last validated.
  87    */
  88   struct GNUNET_TIME_Absolute last_validation;
  89
  90   /**
  91    * When does this address expire.
  92    */
  93   struct GNUNET_TIME_Absolute valid_until;
  94
  95   /**
  96    * Time of the next validation operation.
  97    */
  98   struct GNUNET_TIME_Absolute next_validation;
  99
 100   /**
 101    * Current estimate of the RTT.
 102    */
 103   struct GNUNET_TIME_Relative rtt;
 104 };
 105
 106
 107 /**
 108  * Function to call with information about a peer.
 109  *
 110  * If one_shot was set to #GNUNET_YES to iterate over all peers once,
 111  * a final call with NULL for peer and address will follow when done.
 112  * In this case state and timeout do not contain valid values.
 113  *
 114  * The #GNUNET_TRANSPORT_monitor_peers_cancel() call MUST not be called from
 115  * within this function!
 116  *
 117  *
 118  * @param cls closure
 119  * @param peer peer this update is about,
 120  *        NULL if this is the final last callback for a iteration operation
 121  * @param mi monitoring data on the peer
 122  */
 123 typedef void
 124 (*GNUNET_TRANSPORT_MonitorCallback) (void *cls,
 125                                      const struct GNUNET_PeerIdentity *peer,
 126                                      const struct GNUNET_TRANSPORT_MonitorInformation *mi);
 127
 128
 129 /**
 130  * Handle for a #GNUNET_TRANSPORT_monitor() operation.
 131  */
 132 struct GNUNET_TRANSPORT_MonitorContext;
 133
 134
 135 /**
 136  * Return information about a specific peer or all peers currently known to
 137  * transport service once or in monitoring mode. To obtain information about
 138  * a specific peer, a peer identity can be passed. To obtain information about
 139  * all peers currently known to transport service, NULL can be passed as peer
 140  * identity.
 141  *
 142  * For each peer, the callback is called with information about the address used
 143  * to communicate with this peer, the state this peer is currently in and the
 144  * the current timeout for this state.
 145  *
 146  * Upon completion, the #GNUNET_TRANSPORT_PeerIterateCallback is called one
 147  * more time with `NULL`. After this, the operation must no longer be
 148  * explicitly canceled.
 149  *
 150  * The #GNUNET_TRANSPORT_monitor_peers_cancel call MUST not be called in the
 151  * the peer_callback!
 152  *
 153  * @param cfg configuration to use
 154  * @param peer a specific peer identity to obtain information for,
 155  *      NULL for all peers
 156  * @param one_shot #GNUNET_YES to return the current state and then end (with NULL+NULL),
 157  *                 #GNUNET_NO to monitor peers continuously
 158  * @param cb function to call with the results
 159  * @param cb_cls closure for @a mc
 160  */
 161 struct GNUNET_TRANSPORT_MonitorContext *
 162 GNUNET_TRANSPORT_monitor(const struct GNUNET_CONFIGURATION_Handle *cfg,
 163                          const struct GNUNET_PeerIdentity *peer,
 164                          int one_shot,
 165                          GNUNET_TRANSPORT_MonitorCallback cb,
 166                          void *cb_cls);
 167
 168
 169 /**
 170  * Cancel request to monitor peers
 171  *
 172  * @param mc handle for the request to cancel
 173  */
 174 void
 175 GNUNET_TRANSPORT_monitor_cancel(struct GNUNET_TRANSPORT_MonitorContext *mc);
 176
 177
 178 #if 0                           /* keep Emacsens' auto-indent happy */
 179 {
 180 #endif
 181 #ifdef __cplusplus
 182 }
 183 #endif
 184
 185 /* ifndef GNUNET_TRANSPORT_MONITOR_SERVICE_H */
 186 #endif
 187
 188 /** @} */  /* end of group */
 189
 190 /* end of gnunet_transport_monitor_service.h */