-doxygen
[oweals/gnunet.git] / src / core / core_api_iterate_peers.c
1 /*
2      This file is part of GNUnet.
3      (C) 2009, 2010 Christian Grothoff (and other contributing authors)
4
5      GNUnet is free software; you can redistribute it and/or modify
6      it under the terms of the GNU General Public License as published
7      by the Free Software Foundation; either version 3, or (at your
8      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      General Public License for more details.
14
15      You should have received a copy of the GNU General Public License
16      along with GNUnet; see the file COPYING.  If not, write to the
17      Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18      Boston, MA 02111-1307, USA.
19 */
20
21 /**
22  * @file core/core_api_iterate_peers.c
23  * @brief implementation of the peer_iterate function
24  * @author Christian Grothoff
25  * @author Nathan Evans
26  */
27 #include "platform.h"
28 #include "gnunet_core_service.h"
29 #include "core.h"
30
31
32 struct GNUNET_CORE_RequestContext
33 {
34   /**
35    * Our connection to the service.
36    */
37   struct GNUNET_CLIENT_Connection *client;
38
39   /**
40
41    * Handle for transmitting a request.
42    */
43   struct GNUNET_CLIENT_TransmitHandle *th;
44
45   /**
46    * Function called with the peer.
47    */
48   GNUNET_CORE_ConnectEventHandler peer_cb;
49
50   /**
51    * Peer to check for.
52    */
53   struct GNUNET_PeerIdentity *peer;
54
55   /**
56    * Closure for peer_cb.
57    */
58   void *cb_cls;
59
60 };
61
62
63 /**
64  * Receive reply from core service with information about a peer.
65  *
66  * @param cls our 'struct  GNUNET_CORE_RequestContext *'
67  * @param msg NULL on error or last entry
68  */
69 static void
70 receive_info (void *cls, const struct GNUNET_MessageHeader *msg)
71 {
72   struct GNUNET_CORE_RequestContext *request_context = cls;
73   const struct ConnectNotifyMessage *connect_message;
74   uint16_t msize;
75
76   /* Handle last message or error case, disconnect and clean up */
77   if ((msg == NULL) ||
78       ((ntohs (msg->type) == GNUNET_MESSAGE_TYPE_CORE_ITERATE_PEERS_END) &&
79        (ntohs (msg->size) == sizeof (struct GNUNET_MessageHeader))))
80   {
81     if (request_context->peer_cb != NULL)
82       request_context->peer_cb (request_context->cb_cls, NULL);
83     GNUNET_CLIENT_disconnect (request_context->client);
84     GNUNET_free (request_context);
85     return;
86   }
87
88   msize = ntohs (msg->size);
89   /* Handle incorrect message type or size, disconnect and clean up */
90   if ((ntohs (msg->type) != GNUNET_MESSAGE_TYPE_CORE_NOTIFY_CONNECT) ||
91       (msize < sizeof (struct ConnectNotifyMessage)))
92   {
93     GNUNET_break (0);
94     if (request_context->peer_cb != NULL)
95       request_context->peer_cb (request_context->cb_cls, NULL);
96     GNUNET_CLIENT_disconnect (request_context->client);
97     GNUNET_free (request_context);
98     return;
99   }
100   connect_message = (const struct ConnectNotifyMessage *) msg;
101   if (msize != sizeof (struct ConnectNotifyMessage))
102   {
103     GNUNET_break (0);
104     if (request_context->peer_cb != NULL)
105       request_context->peer_cb (request_context->cb_cls, NULL);
106     GNUNET_CLIENT_disconnect (request_context->client);
107     GNUNET_free (request_context);
108     return;
109   }
110   /* Normal case */
111   if (request_context->peer_cb != NULL)
112     request_context->peer_cb (request_context->cb_cls, &connect_message->peer);
113   GNUNET_CLIENT_receive (request_context->client, &receive_info,
114                          request_context, GNUNET_TIME_UNIT_FOREVER_REL);
115 }
116
117
118 /**
119  * Function called to notify a client about the socket
120  * begin ready to queue more data.  "buf" will be
121  * NULL and "size" zero if the socket was closed for
122  * writing in the meantime.
123  *
124  * @param cls closure, always NULL
125  * @param size number of bytes available in buf
126  * @param buf where the callee should write the message
127  * @return number of bytes written to buf
128  */
129 static size_t
130 transmit_request (void *cls, size_t size, void *buf)
131 {
132   struct GNUNET_MessageHeader *msg;
133   int msize;
134
135   msize = sizeof (struct GNUNET_MessageHeader);
136   if ((size < msize) || (buf == NULL))
137     return 0;
138   msg = (struct GNUNET_MessageHeader *) buf;
139   msg->size = htons (msize);
140   msg->type = htons (GNUNET_MESSAGE_TYPE_CORE_ITERATE_PEERS);
141
142   return msize;
143 }
144
145
146 /**
147  * Iterate over all currently connected peers.
148  * Calls peer_cb with each connected peer, and then
149  * once with NULL to indicate that all peers have
150  * been handled.
151  *
152  * @param cfg configuration to use
153  * @param peer_cb function to call with the peer information
154  * @param cb_cls closure for @a peer_cb
155  * @return #GNUNET_OK if iterating, #GNUNET_SYSERR on error
156  */
157 int
158 GNUNET_CORE_iterate_peers (const struct GNUNET_CONFIGURATION_Handle *cfg,
159                            GNUNET_CORE_ConnectEventHandler peer_cb,
160                            void *cb_cls)
161 {
162   struct GNUNET_CORE_RequestContext *request_context;
163   struct GNUNET_CLIENT_Connection *client;
164
165   client = GNUNET_CLIENT_connect ("core", cfg);
166   if (client == NULL)
167     return GNUNET_SYSERR;
168   request_context = GNUNET_new (struct GNUNET_CORE_RequestContext);
169   request_context->client = client;
170   request_context->peer_cb = peer_cb;
171   request_context->cb_cls = cb_cls;
172
173   request_context->th =
174       GNUNET_CLIENT_notify_transmit_ready (client,
175                                            sizeof (struct GNUNET_MessageHeader),
176                                            GNUNET_TIME_UNIT_FOREVER_REL,
177                                            GNUNET_YES, &transmit_request, NULL);
178
179   GNUNET_CLIENT_receive (client, &receive_info, request_context,
180                          GNUNET_TIME_UNIT_FOREVER_REL);
181   return GNUNET_OK;
182 }
183
184 /* end of core_api_iterate_peers.c */