2 This file is part of GNUnet.
3 Copyright (C) 2009-2014, 2016 GNUnet e.V.
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.
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.
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/>.
18 SPDX-License-Identifier: AGPL3.0-or-later
22 * @file core/core_api_monitor_peers.c
23 * @brief implementation of the peer_iterate function
24 * @author Christian Grothoff
25 * @author Nathan Evans
28 #include "gnunet_core_service.h"
33 * Handle to a CORE monitoring operation.
35 struct GNUNET_CORE_MonitorHandle
41 const struct GNUNET_CONFIGURATION_Handle *cfg;
44 * Our connection to the service.
46 struct GNUNET_MQ_Handle *mq;
49 * Function called with the peer.
51 GNUNET_CORE_MonitorCallback peer_cb;
54 * Closure for @e peer_cb.
62 * Protocol error, reconnect to CORE service and notify
65 * @param mh monitoring session to reconnect to CORE
68 reconnect (struct GNUNET_CORE_MonitorHandle *mh);
72 * Generic error handler, called with the appropriate error code and
73 * the same closure specified at the creation of the message queue.
74 * Not every message queue implementation supports an error handler.
76 * @param cls closure, a `struct GNUNET_CORE_MonitorHandle *`
77 * @param error error code
80 handle_mq_error (void *cls,
81 enum GNUNET_MQ_Error error)
83 struct GNUNET_CORE_MonitorHandle *mh = cls;
90 * Receive reply from CORE service with information about a peer.
92 * @param cls our `struct GNUNET_CORE_MonitorHandle *`
93 * @param mon_message monitor message
96 handle_receive_info (void *cls,
97 const struct MonitorNotifyMessage *mon_message)
99 struct GNUNET_CORE_MonitorHandle *mh = cls;
101 mh->peer_cb (mh->peer_cb_cls,
103 (enum GNUNET_CORE_KxState) ntohl (mon_message->state),
104 GNUNET_TIME_absolute_ntoh (mon_message->timeout));
109 * Protocol error, reconnect to CORE service and notify
112 * @param mh monitoring session to reconnect to CORE
115 reconnect (struct GNUNET_CORE_MonitorHandle *mh)
117 struct GNUNET_MQ_MessageHandler handlers[] = {
118 GNUNET_MQ_hd_fixed_size (receive_info,
119 GNUNET_MESSAGE_TYPE_CORE_MONITOR_NOTIFY,
120 struct MonitorNotifyMessage,
122 GNUNET_MQ_handler_end ()
124 struct GNUNET_MQ_Envelope *env;
125 struct GNUNET_MessageHeader *msg;
128 GNUNET_MQ_destroy (mh->mq);
129 /* FIXME: use backoff? */
130 mh->mq = GNUNET_CLIENT_connect (mh->cfg,
137 /* notify callback about reconnect */
138 if (NULL != mh->peer_cb)
139 mh->peer_cb (mh->peer_cb_cls,
141 GNUNET_CORE_KX_CORE_DISCONNECT,
142 GNUNET_TIME_UNIT_FOREVER_ABS);
143 env = GNUNET_MQ_msg (msg,
144 GNUNET_MESSAGE_TYPE_CORE_MONITOR_PEERS);
145 GNUNET_MQ_send (mh->mq,
151 * Monitor connectivity and KX status of all peers known to CORE.
152 * Calls @a peer_cb with the current status for each connected peer,
153 * and then once with NULL to indicate that all peers that are
154 * currently active have been handled. After that, the iteration
155 * continues until it is cancelled. Normal users of the CORE API are
156 * not expected to use this function. It is different in that it
157 * truly lists all connections (including those where the KX is in
158 * progress), not just those relevant to the application. This
159 * function is used by special applications for diagnostics.
161 * @param cfg configuration handle
162 * @param peer_cb function to call with the peer information
163 * @param peer_cb_cls closure for @a peer_cb
164 * @return NULL on error
166 struct GNUNET_CORE_MonitorHandle *
167 GNUNET_CORE_monitor_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
168 GNUNET_CORE_MonitorCallback peer_cb,
171 struct GNUNET_CORE_MonitorHandle *mh;
173 GNUNET_assert (NULL != peer_cb);
174 mh = GNUNET_new (struct GNUNET_CORE_MonitorHandle);
177 mh->peer_cb = peer_cb;
178 mh->peer_cb_cls = peer_cb_cls;
189 * Stop monitoring CORE activity.
191 * @param mh monitor to stop
194 GNUNET_CORE_monitor_stop (struct GNUNET_CORE_MonitorHandle *mh)
198 GNUNET_MQ_destroy (mh->mq);
205 /* end of core_api_monitor_peers.c */