1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
|
/*
This file is part of GNUnet.
Copyright (C) 2015 Christian Grothoff (and other contributing authors)
GNUnet is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published
by the Free Software Foundation; either version 3, 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
General Public License for more details.
You should have received a copy of the GNU General Public License
along with GNUnet; see the file COPYING. If not, write to the
Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.
*/
/**
* @file transport/gnunet-service-transport_ats.h
* @brief interfacing between transport and ATS service
* @author Christian Grothoff
*/
#ifndef GNUNET_SERVICE_TRANSPORT_ATS_H
#define GNUNET_SERVICE_TRANSPORT_ATS_H
#include "gnunet_ats_service.h"
/**
* Initialize ATS subsystem.
*/
void
GST_ats_init (void);
/**
* Shutdown ATS subsystem.
*/
void
GST_ats_done (void);
/**
* Test if ATS knows about this address.
*
* @param address the address
* @param session the session
* @return #GNUNET_YES if address is known, #GNUNET_NO if not.
*/
int
GST_ats_is_known (const struct GNUNET_HELLO_Address *address,
struct Session *session);
/**
* Temporarily block a valid address for use by ATS for address
* suggestions. This function should be called if an address was
* suggested by ATS but failed to perform (i.e. failure to establish a
* session or to exchange the PING/PONG).
*
* @param address the address to block
* @param session the session (can be NULL)
*/
void
GST_ats_block_address (const struct GNUNET_HELLO_Address *address,
struct Session *session);
/* FIXME: might want to add a function to reset the
back-off from blocking */
/**
* Notify ATS about the a new inbound address. We may already
* know the address (as this is called each time we receive
* a message from an inbound connection). If the address is
* indeed new, make it available to ATS.
*
* @param address the address
* @param session the session
* @param ats ats information
* @param ats_count number of @a ats information
*/
void
GST_ats_add_inbound_address (const struct GNUNET_HELLO_Address *address,
struct Session *session,
const struct GNUNET_ATS_Information *ats,
uint32_t ats_count);
/**
* Notify ATS about the new address including the network this address is
* located in. The address must NOT be inbound and must be new to ATS.
*
* @param address the address
* @param ats ats information
* @param ats_count number of @a ats information
*/
void
GST_ats_add_address (const struct GNUNET_HELLO_Address *address,
const struct GNUNET_ATS_Information *ats,
uint32_t ats_count);
/**
* Notify ATS about a new session now existing for the given
* address.
*
* @param address the address
* @param session the session
*/
void
GST_ats_new_session (const struct GNUNET_HELLO_Address *address,
struct Session *session);
/**
* Notify ATS about property changes to an address
*
* @param address the address
* @param session the session
* @param ats performance information
* @param ats_count number of elements in @a ats
*/
void
GST_ats_update_metrics (const struct GNUNET_HELLO_Address *address,
struct Session *session,
const struct GNUNET_ATS_Information *ats,
uint32_t ats_count);
/**
* Notify ATS that the session (but not the address) of
* a given address is no longer relevant.
*
* @param address the address
* @param session the session
*/
void
GST_ats_del_session (const struct GNUNET_HELLO_Address *address,
struct Session *session);
/**
* Notify ATS that the address has expired and thus cannot
* be used any longer. This function must only be called
* if the corresponding session is already gone.
*
* @param address the address
*/
void
GST_ats_expire_address (const struct GNUNET_HELLO_Address *address);
#endif
|
