aboutsummaryrefslogtreecommitdiff
path: root/src/include/gnunet_transport_application_service.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/include/gnunet_transport_application_service.h')
-rw-r--r--src/include/gnunet_transport_application_service.h100
1 files changed, 100 insertions, 0 deletions
diff --git a/src/include/gnunet_transport_application_service.h b/src/include/gnunet_transport_application_service.h
new file mode 100644
index 000000000..31097b88e
--- /dev/null
+++ b/src/include/gnunet_transport_application_service.h
@@ -0,0 +1,100 @@
1/*
2 This file is part of GNUnet.
3 Copyright (C) 2010-2015, 2018, 2019 GNUnet e.V.
4
5 GNUnet is free software: you can redistribute it and/or modify it
6 under the terms of the GNU Affero General Public License as published
7 by the Free Software Foundation, either version 3 of the License,
8 or (at your option) any later version.
9
10 GNUnet is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 Affero General Public License for more details.
14
15 You should have received a copy of the GNU Affero General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>.
17
18 SPDX-License-Identifier: AGPL3.0-or-later
19 */
20/**
21 * @file
22 * Bandwidth allocation API for applications to interact with
23 *
24 * @author Christian Grothoff
25 * @author Matthias Wachs
26 *
27 * @defgroup TRANSPORT service
28 * Bandwidth allocation
29 *
30 * @{
31 */
32#ifndef GNUNET_TRANSPORT_APPLICATION_SERVICE_H
33#define GNUNET_TRANSPORT_APPLICATION_SERVICE_H
34
35#include "gnunet_constants.h"
36#include "gnunet_util_lib.h"
37
38/**
39 * Handle to the TRANSPORT subsystem for making suggestions about
40 * connections the peer would like to have.
41 */
42struct GNUNET_TRANSPORT_ApplicationHandle;
43
44
45/**
46 * Initialize the TRANSPORT application client handle.
47 *
48 * @param cfg configuration to use
49 * @return ats application handle, NULL on error
50 */
51struct GNUNET_TRANSPORT_ApplicationHandle *
52GNUNET_TRANSPORT_application_init (const struct GNUNET_CONFIGURATION_Handle *cfg);
53
54
55/**
56 * Shutdown TRANSPORT application client.
57 *
58 * @param ch handle to destroy
59 */
60void
61GNUNET_TRANSPORT_application_done (struct GNUNET_TRANSPORT_ApplicationHandle *ch);
62
63
64/**
65 * Handle for suggestion requests.
66 */
67struct GNUNET_TRANSPORT_ApplicationSuggestHandle;
68
69
70/**
71 * An application would like to communicate with a peer. TRANSPORT should
72 * allocate bandwith using a suitable address for requiremetns @a pk
73 * to transport.
74 *
75 * @param ch handle
76 * @param peer identity of the peer we need an address for
77 * @param pk what kind of application will the application require (can be
78 * #GNUNET_MQ_PREFERENCE_NONE, we will still try to connect)
79 * @param bw desired bandwith, can be zero (we will still try to connect)
80 * @return suggestion handle, NULL if request is already pending
81 */
82struct GNUNET_TRANSPORT_ApplicationSuggestHandle *
83GNUNET_TRANSPORT_application_suggest (struct GNUNET_TRANSPORT_ApplicationHandle *ch,
84 const struct GNUNET_PeerIdentity *peer,
85 enum GNUNET_MQ_PreferenceKind pk,
86 struct GNUNET_BANDWIDTH_Value32NBO bw);
87
88
89/**
90 * We no longer care about communicating with a peer.
91 *
92 * @param sh handle
93 */
94void
95GNUNET_TRANSPORT_application_suggest_cancel (struct GNUNET_TRANSPORT_ApplicationSuggestHandle *sh);
96
97/** @} */ /* end of group */
98
99#endif
100/* end of file gnunet_ats_application_service.h */