gnunet_nat_lib.h

Go to the documentation of this file.

/*
   This file is part of GNUnet.
   Copyright (C) 2024 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
 */
 
#include "gnunet_common.h"
#if !defined (__GNUNET_UTIL_LIB_H_INSIDE__)
#error "Only <gnunet_util_lib.h> can be included directly."
#endif
 
#ifndef GNUNET_NAT_LIB_H
#define GNUNET_NAT_LIB_H
 
GNUNET_NETWORK_STRUCT_BEGIN
struct GNUNET_BurstSync
{
  struct GNUNET_TIME_RelativeNBO rtt_average;
 
  enum GNUNET_GenericReturnValue sync_ready;
};
 
struct GNUNET_BurstMessage
{
  struct GNUNET_PeerIdentity peer;
 
  unsigned int local_port;
};
GNUNET_NETWORK_STRUCT_END
 
struct GNUNET_StartBurstCls
{
  void *context;
 
  struct GNUNET_TIME_Relative rtt;
 
  struct GNUNET_TIME_Relative delay;
 
  struct GNUNET_PEERSTORE_Monitor *mo;
 
  struct VirtualLink *vl;
 
  unsigned int sync_ready;
};
 
struct GNUNET_UdpSocketInfo;
 
typedef void (*GNUNET_NotifyUdpSocket) (struct GNUNET_UdpSocketInfo *sock_info);
 
struct GNUNET_UdpSocketInfo
{
  struct GNUNET_UdpSocketInfo *prev;
 
  struct GNUNET_UdpSocketInfo *next;
 
  // The peer the socket is for.
  const struct GNUNET_PeerIdentity *peer;
 
  // The socket to send message with to the peer.
  struct GNUNET_NETWORK_Handle *udp_sock;
 
  struct GNUNET_TIME_Relative rtt;
 
  struct GNUNET_PeerIdentity *pid;
 
  GNUNET_NotifyUdpSocket nus;
 
  struct GNUNET_SCHEDULER_Task *read_task;
 
  struct GNUNET_SCHEDULER_Task *timeout_task;
 
  char *address;
 
  const char *bind_address;
 
  unsigned int port;
 
  struct sockaddr *actual_address;
 
  unsigned int std_port;
 
  enum GNUNET_GenericReturnValue has_port;
};
 
 
struct GNUNET_BurstSync *
GNUNET_get_burst_sync_msg (struct GNUNET_TIME_Relative rtt_average,
                           enum GNUNET_GenericReturnValue sync_ready);
 
 
void
GNUNET_is_burst_ready (struct GNUNET_TIME_Relative rtt_average,
                       struct GNUNET_BurstSync *burst_sync,
                       GNUNET_SCHEDULER_TaskCallback task,
                       struct GNUNET_StartBurstCls *task_cls);
 
 
struct GNUNET_SCHEDULER_Task * 
GNUNET_get_udp_socket (struct GNUNET_UdpSocketInfo *sock_info,
                       GNUNET_NotifyUdpSocket nus);
 
void
GNUNET_stop_burst (struct GNUNET_NETWORK_Handle *do_not_touch);
 
#endif
  /* end of group */
  /* end of group addition to backbone */