gnunet_ats_transport_service.h

Go to the documentation of this file.

/*
   This file is part of GNUnet.
   Copyright (C) 2010-2015, 2018 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_ATS_TRANSPORT_SERVICE_H
#define GNUNET_ATS_TRANSPORT_SERVICE_H
 
 
#include "gnunet_constants.h"
#include "gnunet_util_lib.h"
#include "gnunet_nt_lib.h"
#include "gnunet_transport_communication_service.h"
 
 
struct GNUNET_ATS_Properties
{
  struct GNUNET_TIME_Relative delay;
 
  uint32_t goodput_out;
 
  uint32_t goodput_in;
 
  uint32_t utilization_out;
 
  uint32_t utilization_in;
 
  uint32_t distance;
 
  uint32_t mtu;
 
  enum GNUNET_NetworkType nt;
 
  enum GNUNET_TRANSPORT_CommunicatorCharacteristics cc;
};
 
 
/* ******************************** Transport API ***************************** */
 
struct GNUNET_ATS_TransportHandle;
 
struct GNUNET_ATS_Session;
 
 
typedef void
(*GNUNET_ATS_AllocationCallback) (void *cls,
                                  struct GNUNET_ATS_Session *session,
                                  struct GNUNET_BANDWIDTH_Value32NBO
                                  bandwidth_out,
                                  struct GNUNET_BANDWIDTH_Value32NBO
                                  bandwidth_in);
 
 
typedef void
(*GNUNET_ATS_SuggestionCallback) (void *cls,
                                  const struct GNUNET_PeerIdentity *pid,
                                  const char *address);
 
 
struct GNUNET_ATS_TransportHandle *
GNUNET_ATS_transport_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
                           GNUNET_ATS_AllocationCallback alloc_cb,
                           void *alloc_cb_cls,
                           GNUNET_ATS_SuggestionCallback suggest_cb,
                           void *suggest_cb_cls);
 
 
void
GNUNET_ATS_transport_done (struct GNUNET_ATS_TransportHandle *ath);
 
 
struct GNUNET_ATS_SessionRecord;
 
 
struct GNUNET_ATS_SessionRecord *
GNUNET_ATS_session_add (struct GNUNET_ATS_TransportHandle *ath,
                        const struct GNUNET_PeerIdentity *pid,
                        const char *address,
                        struct GNUNET_ATS_Session *session,
                        const struct GNUNET_ATS_Properties *prop);
 
 
void
GNUNET_ATS_session_update (struct GNUNET_ATS_SessionRecord *ar,
                           const struct GNUNET_ATS_Properties *prop);
 
 
void
GNUNET_ATS_session_del (struct GNUNET_ATS_SessionRecord *ar);
 
 
#endif
  /* end of group */
 
/* end of file gnunet-service-transport_ats.h */