gnunet-service-cadet_tunnels.h

Go to the documentation of this file.

/*
     This file is part of GNUnet.
     Copyright (C) 2001-2017 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_SERVICE_CADET_TUNNELS_H
#define GNUNET_SERVICE_CADET_TUNNELS_H
 
#include "gnunet-service-cadet.h"
#include "cadet_protocol.h"
 
 
#define DESIRED_CONNECTIONS_PER_TUNNEL 3
 
 
enum CadetTunnelEState
{
  CADET_TUNNEL_KEY_UNINITIALIZED,
 
  CADET_TUNNEL_KEY_AX_SENT,
 
  CADET_TUNNEL_KEY_AX_RECV,
 
  CADET_TUNNEL_KEY_AX_SENT_AND_RECV,
 
  CADET_TUNNEL_KEY_AX_AUTH_SENT,
 
  CADET_TUNNEL_KEY_OK
};
 
int
GCT_alice_or_betty (const struct GNUNET_PeerIdentity *other);
 
const char *
GCT_2s (const struct CadetTunnel *t);
 
 
struct CadetTunnel *
GCT_create_tunnel (struct CadetPeer *destination);
 
 
void
GCT_destroy_tunnel_now (struct CadetTunnel *t);
 
 
int
GCT_add_inbound_connection (struct CadetTunnel *t,
                            const struct
                            GNUNET_CADET_ConnectionTunnelIdentifier *cid,
                            struct CadetPeerPath *path);
 
 
void
GCT_connection_lost (struct CadetTConnection *ct);
 
 
struct CadetPeer *
GCT_get_destination (struct CadetTunnel *t);
 
 
void
GCT_consider_path (struct CadetTunnel *t,
                   struct CadetPeerPath *p,
                   unsigned int off);
 
 
struct GNUNET_CADET_ChannelTunnelNumber
GCT_add_channel (struct CadetTunnel *t,
                 struct CadetChannel *ch);
 
 
void
GCT_remove_channel (struct CadetTunnel *t,
                    struct CadetChannel *ch,
                    struct GNUNET_CADET_ChannelTunnelNumber ctn);
 
 
void
GCT_send_channel_destroy (struct CadetTunnel *t,
                          struct GNUNET_CADET_ChannelTunnelNumber ctn);
 
 
typedef void
(*GCT_SendContinuation)(void *cls,
                        const struct
                        GNUNET_CADET_ConnectionTunnelIdentifier *cid);
 
 
struct CadetTunnelQueueEntry *
GCT_send (struct CadetTunnel *t,
          const struct GNUNET_MessageHeader *message,
          GCT_SendContinuation cont,
          void *cont_cls,
          struct GNUNET_CADET_ChannelTunnelNumber *ctn);
 
 
void
GCT_send_cancel (struct CadetTunnelQueueEntry *q);
 
 
unsigned int
GCT_count_channels (struct CadetTunnel *t);
 
 
unsigned int
GCT_count_any_connections (const struct CadetTunnel *t);
 
 
typedef void
(*GCT_ConnectionIterator) (void *cls,
                           struct CadetTConnection *ct);
 
 
void
GCT_iterate_connections (struct CadetTunnel *t,
                         GCT_ConnectionIterator iter,
                         void *iter_cls);
 
 
typedef void
(*GCT_ChannelIterator) (void *cls,
                        struct CadetChannel *ch);
 
 
void
GCT_iterate_channels (struct CadetTunnel *t,
                      GCT_ChannelIterator iter,
                      void *iter_cls);
 
 
enum CadetTunnelEState
GCT_get_estate (struct CadetTunnel *t);
 
void
GCT_change_estate (struct CadetTunnel *t,
                   enum CadetTunnelEState state);
 
void
GCT_handle_kx (struct CadetTConnection *ct,
               const struct GNUNET_CADET_TunnelKeyExchangeMessage *msg);
 
 
void
GCT_handle_kx_auth (struct CadetTConnection *ct,
                    const struct
                    GNUNET_CADET_TunnelKeyExchangeAuthMessage *msg);
 
 
void
GCT_handle_encrypted (struct CadetTConnection *ct,
                      const struct GNUNET_CADET_TunnelEncryptedMessage *msg);
 
 
void
GCT_debug (const struct CadetTunnel *t,
           enum GNUNET_ErrorType level);
 
 
#endif