aboutsummaryrefslogtreecommitdiff
path: root/src/transport/gnunet-service-transport_plugins.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/transport/gnunet-service-transport_plugins.h')
-rw-r--r--src/transport/gnunet-service-transport_plugins.h107
1 files changed, 0 insertions, 107 deletions
diff --git a/src/transport/gnunet-service-transport_plugins.h b/src/transport/gnunet-service-transport_plugins.h
deleted file mode 100644
index fdd819fc5..000000000
--- a/src/transport/gnunet-service-transport_plugins.h
+++ /dev/null
@@ -1,107 +0,0 @@
1/*
2 This file is part of GNUnet.
3 Copyright (C) 2010,2011 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/**
22 * @file transport/gnunet-service-transport_plugins.h
23 * @brief plugin management API
24 * @author Christian Grothoff
25 */
26#ifndef GNUNET_SERVICE_TRANSPORT_PLUGINS_H
27#define GNUNET_SERVICE_TRANSPORT_PLUGINS_H
28
29#include "gnunet_statistics_service.h"
30#include "gnunet_transport_service.h"
31#include "gnunet_transport_plugin.h"
32#include "gnunet_util_lib.h"
33#include "gnunet_hello_lib.h"
34
35
36/**
37 * Load and initialize all plugins. The respective functions will be
38 * invoked by the plugins when the respective events happen. The
39 * closure will be set to a 'const char*' containing the name of the
40 * plugin that caused the call.
41 *
42 * @param recv_cb function to call when data is received
43 * @param address_cb function to call when our public addresses changed
44 * @param session_start_cb function to call when a session was created
45 * @param session_end_cb function to call when a session was terminated
46 */
47void
48GST_plugins_load (GNUNET_TRANSPORT_PluginReceiveCallback recv_cb,
49 GNUNET_TRANSPORT_AddressNotification address_cb,
50 GNUNET_TRANSPORT_SessionStart session_start_cb,
51 GNUNET_TRANSPORT_SessionEnd session_end_cb);
52
53/**
54 * Unload all plugins
55 */
56void
57GST_plugins_unload (void);
58
59
60/**
61 * Obtain the plugin API based on a plugin name.
62 *
63 * @param name name of the plugin
64 * @return the plugin's API, NULL if the plugin is not loaded
65 */
66struct GNUNET_TRANSPORT_PluginFunctions *
67GST_plugins_find (const char *name);
68
69
70/**
71 * Obtain the plugin API based on a the stripped plugin name after the underscore.
72 *
73 * Example: GST_plugins_printer_find (http_client) will return all plugins
74 * starting with the prefix "http":
75 * http_client or server if loaded
76 *
77 * @param name name of the plugin
78 * @return the plugin's API, NULL if the plugin is not loaded
79 */
80struct GNUNET_TRANSPORT_PluginFunctions *
81GST_plugins_printer_find (const char *name);
82
83
84/**
85 * Convert a given address to a human-readable format. Note that the
86 * return value will be overwritten on the next call to this function.
87 *
88 * @param address address to convert
89 * @return statically allocated (!) human-readable address
90 */
91const char *
92GST_plugins_a2s (const struct GNUNET_HELLO_Address *address);
93
94
95/**
96 * Register callback with all plugins to monitor their status.
97 *
98 * @param cb callback to register, NULL to unsubscribe
99 * @param cb_cls closure for @a cb
100 */
101void
102GST_plugins_monitor_subscribe (GNUNET_TRANSPORT_SessionInfoCallback cb,
103 void *cb_cls);
104
105
106#endif
107/* end of file gnunet-service-transport_plugins.h */