gnunet_transport_monitor_service.h

Go to the documentation of this file.

/*
     This file is part of GNUnet.
     Copyright (C) 2009-2016 GNUnet e.V.
 
     GNUnet is free software: you can redistribute it and/or modify it
     under the terms of the GNU Affero General Public License as published
     by the Free Software Foundation, either version 3 of the License,
     or (at your option) any later version.
 
     GNUnet is distributed in the hope that it will be useful, but
     WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
     Affero General Public License for more details.
 
     You should have received a copy of the GNU Affero General Public License
     along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
     SPDX-License-Identifier: AGPL3.0-or-later
 */
 
#ifndef GNUNET_TRANSPORT_MONITOR_SERVICE_H
#define GNUNET_TRANSPORT_MONITOR_SERVICE_H
 
#ifdef __cplusplus
extern "C"
{
#if 0                           /* keep Emacsens' auto-indent happy */
}
#endif
#endif
 
 
#include "gnunet_util_lib.h"
#include "gnunet_transport_communication_service.h"
 
 
#define GNUNET_TRANSPORT_MONITOR_VERSION 0x00000000
 
 
struct GNUNET_TRANSPORT_MonitorInformation
{
  const char *address;
 
  enum GNUNET_NetworkType nt;
 
  enum GNUNET_TRANSPORT_ConnectionStatus cs;
 
  uint32_t num_msg_pending;
 
  uint32_t num_bytes_pending;
 
  struct GNUNET_TIME_Absolute last_validation;
 
  struct GNUNET_TIME_Absolute valid_until;
 
  struct GNUNET_TIME_Absolute next_validation;
 
  struct GNUNET_TIME_Relative rtt;
};
 
 
typedef void
(*GNUNET_TRANSPORT_MonitorCallback) (void *cls,
                                     const struct GNUNET_PeerIdentity *peer,
                                     const struct
                                     GNUNET_TRANSPORT_MonitorInformation *mi);
 
 
struct GNUNET_TRANSPORT_MonitorContext;
 
 
struct GNUNET_TRANSPORT_MonitorContext *
GNUNET_TRANSPORT_monitor (const struct GNUNET_CONFIGURATION_Handle *cfg,
                          const struct GNUNET_PeerIdentity *peer,
                          int one_shot,
                          GNUNET_TRANSPORT_MonitorCallback cb,
                          void *cb_cls);
 
 
void
GNUNET_TRANSPORT_monitor_cancel (struct GNUNET_TRANSPORT_MonitorContext *mc);
 
 
enum GNUNET_TRANSPORT_LinkRoute
{
  GNUNET_TRANSPORT_LINK_ROUTE_DIRECT = 0,
 
  GNUNET_TRANSPORT_LINK_ROUTE_DV = 1
};
 
 
struct GNUNET_TRANSPORT_LinkInformation
{
  const char *communicators;
 
  enum GNUNET_TRANSPORT_LinkRoute route;
 
  int confirmed;
 
  unsigned int distance;
 
  unsigned int num_queues;
 
  int core_recv_window;
 
  unsigned int stalled;
 
  unsigned int pending;
 
  unsigned int fc_retransmit_count;
 
  uint64_t available_fc_window_size;
 
  uint64_t incoming_fc_window_size_ram;
 
  uint64_t incoming_fc_window_size;
 
  uint64_t incoming_fc_window_size_used;
 
  int64_t incoming_fc_window_size_loss;
 
  uint64_t outbound_fc_window_size;
 
  uint64_t outbound_fc_window_size_used;
 
  struct GNUNET_TIME_Relative last_fc_rtt;
 
  struct GNUNET_TIME_Relative other_rtt;
 
  struct GNUNET_TIME_Absolute last_fc_transmission;
};
 
 
typedef void
(*GNUNET_TRANSPORT_LinkCallback) (
  void *cls,
  const struct GNUNET_PeerIdentity *peer,
  const struct GNUNET_TRANSPORT_LinkInformation *li);
 
 
struct GNUNET_TRANSPORT_LinkListContext;
 
 
struct GNUNET_TRANSPORT_LinkListContext *
GNUNET_TRANSPORT_links_list (const struct GNUNET_CONFIGURATION_Handle *cfg,
                             const struct GNUNET_PeerIdentity *peer,
                             int include_unconfirmed,
                             GNUNET_TRANSPORT_LinkCallback cb,
                             void *cb_cls);
 
 
void
GNUNET_TRANSPORT_links_list_cancel (
  struct GNUNET_TRANSPORT_LinkListContext *llc);
 
 
#if 0                           /* keep Emacsens' auto-indent happy */
{
#endif
#ifdef __cplusplus
}
#endif
 
/* ifndef GNUNET_TRANSPORT_MONITOR_SERVICE_H */
#endif
 
 
 
/* end of gnunet_transport_monitor_service.h */