2 This file is part of GNUnet.
3 Copyright (C) 2009-2016 GNUnet e.V.
5 GNUnet is free software: you can redistribute it and/or modify it
6 under the terms of the GNU 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.
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.
17 * @author Christian Grothoff
20 * Monitoring / diagnostics API for the transport service
22 * @defgroup transport TRANSPORT service
23 * Communication with other peers
25 * @see [Documentation](https://gnunet.org/transport-service)
30 #ifndef GNUNET_TRANSPORT_MONITOR_SERVICE_H
31 #define GNUNET_TRANSPORT_MONITOR_SERVICE_H
36 #if 0 /* keep Emacsens' auto-indent happy */
41 #include "gnunet_util_lib.h"
44 * Version number of the transport API.
46 #define GNUNET_TRANSPORT_MONITOR_VERSION 0x00000000
50 * Information about another peer's address.
52 struct GNUNET_TRANSPORT_MonitorInformation
56 * Address we have for the peer, human-readable, 0-terminated, in UTF-8.
61 * Network type of the address.
63 enum GNUNET_ATS_Network_Type nt;
66 * #GNUNET_YES if this is an inbound connection (communicator initiated)
67 * #GNUNET_NO if this is an outbound connection (transport initiated)
72 * Number of messages pending transmission for this @e address.
74 uint32_t num_msg_pending;
77 * Number of bytes pending transmission for this @e address.
79 uint32_t num_bytes_pending;
82 * When was this address last validated.
84 struct GNUNET_TIME_Absolute last_validation;
87 * When does this address expire.
89 struct GNUNET_TIME_Absolute valid_until;
92 * Time of the next validation operation.
94 struct GNUNET_TIME_Absolute next_validation;
97 * Current estimate of the RTT.
99 struct GNUNET_TIME_Relative rtt;
105 * Function to call with information about a peer.
107 * If one_shot was set to #GNUNET_YES to iterate over all peers once,
108 * a final call with NULL for peer and address will follow when done.
109 * In this case state and timeout do not contain valid values.
111 * The #GNUNET_TRANSPORT_monitor_peers_cancel() call MUST not be called from
112 * within this function!
116 * @param peer peer this update is about,
117 * NULL if this is the final last callback for a iteration operation
118 * @param mi monitoring data on the peer
121 (*GNUNET_TRANSPORT_MontiorCallback) (void *cls,
122 const struct GNUNET_PeerIdentity *peer,
123 const struct GNUNET_TRANSPORT_MonitorInformation *mi);
127 * Handle for a #GNUNET_TRANSPORT_monitor() operation.
129 struct GNUNET_TRANSPORT_MonitorContext;
133 * Return information about a specific peer or all peers currently known to
134 * transport service once or in monitoring mode. To obtain information about
135 * a specific peer, a peer identity can be passed. To obtain information about
136 * all peers currently known to transport service, NULL can be passed as peer
139 * For each peer, the callback is called with information about the address used
140 * to communicate with this peer, the state this peer is currently in and the
141 * the current timeout for this state.
143 * Upon completion, the #GNUNET_TRANSPORT_PeerIterateCallback is called one
144 * more time with `NULL`. After this, the operation must no longer be
145 * explicitly canceled.
147 * The #GNUNET_TRANSPORT_monitor_peers_cancel call MUST not be called in the
150 * @param cfg configuration to use
151 * @param peer a specific peer identity to obtain information for,
153 * @param one_shot #GNUNET_YES to return the current state and then end (with NULL+NULL),
154 * #GNUNET_NO to monitor peers continuously
155 * @param mc function to call with the results
156 * @param mc_cls closure for @a mc
158 struct GNUNET_TRANSPORT_MonitorContext *
159 GNUNET_TRANSPORT_monitor (const struct GNUNET_CONFIGURATION_Handle *cfg,
160 const struct GNUNET_PeerIdentity *peer,
162 GNUNET_TRANSPORT_MonitorCallback mc,
167 * Cancel request to monitor peers
169 * @param pmc handle for the request to cancel
172 GNUNET_TRANSPORT_monitor_cancel (struct GNUNET_TRANSPORT_MonitorContext *pmc);
175 #if 0 /* keep Emacsens' auto-indent happy */
182 /* ifndef GNUNET_TRANSPORT_MONITOR_SERVICE_H */
185 /** @} */ /* end of group */
187 /* end of gnunet_transport_monitor_service.h */