aboutsummaryrefslogtreecommitdiff
path: root/src/mesh/mesh_api_new.c
blob: d68408a3b6db0d2118a110cc4c46d44958a2d2de (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
/*
     This file is part of GNUnet.
     (C) 2011 Christian Grothoff (and other contributing authors)

     GNUnet is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published
     by the Free Software Foundation; either version 3, or (at your
     option) any later version.

     GNUnet is distributed in the hope that it will be useful, but
     WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
     General Public License for more details.

     You should have received a copy of the GNU General Public License
     along with GNUnet; see the file COPYING.  If not, write to the
     Free Software Foundation, Inc., 59 Temple Place - Suite 330,
     Boston, MA 02111-1307, USA.
*/

/**
 * @file mesh/mesh_api_new.c
 * @brief mesh api: client implementation of mesh service
 * @author Bartlomiej Polot
 */

#ifdef __cplusplus

extern "C"
{
#if 0                           /* keep Emacsens' auto-indent happy */
}
#endif
#endif


#include "platform.h"
#include "gnunet_common.h"
#include "gnunet_client_lib.h"
#include "gnunet_util_lib.h"
#include "gnunet_mesh_service_new.h"
#include "mesh.h"

/**
 * Opaque handle to the service.
 */
struct GNUNET_MESH_Handle {
    /**
     * Handle to the server connection, to send messages later
     */
    struct GNUNET_CLIENT_Connection             *mesh;

    /**
     * Set of handlers used for processing incoming messages in the tunnels
     */
    const struct GNUNET_MESH_MessageHandler     *message_handlers;
    int                                         n_handlers;

    /**
     * Set of applications that should be claimed to be offered at this node.
     * Note that this is just informative, the appropiate handlers must be
     * registered independently and the mapping is up to the developer of the
     * client application.
     */
    const GNUNET_MESH_ApplicationType           *applications;
    int                                         n_applications;

    /**
     * Double linked list of the tunnels this client is connected to.
     */
    struct GNUNET_MESH_Tunnel                   *head;
    struct GNUNET_MESH_Tunnel                   *tail;

    /**
     * Callback for tunnel disconnection
     */
    GNUNET_MESH_TunnelEndHandler                *cleaner;

    /**
     * Closure for all the handlers given by the client
     */
    void                                        *cls;
};

/**
 * Opaque handle to a tunnel.
 */
struct GNUNET_MESH_Tunnel {
    /**
     * Owner of the tunnel, either local or remote
     */
    GNUNET_PEER_Id                              owner;

    /**
     * Callback to execute when peers connect to the tunnel
     */
    GNUNET_MESH_TunnelConnectHandler            connect_handler;

    /**
     * Callback to execute when peers disconnect to the tunnel
     */
    GNUNET_MESH_TunnelDisconnectHandler         disconnect_handler;

    /**
     * All peers added to the tunnel
     */
    GNUNET_PEER_Id                              *peers;

    /**
     * Closure for the connect/disconnect handlers
     */
    void                                        *cls;
};

struct GNUNET_MESH_TransmitHandle {
    // TODO
};


/**
 * Function called to notify a client about the socket begin ready to queue more
 * data.  "buf" will be NULL and "size" zero if the socket was closed for
 * writing in the meantime.
 *
 * @param cls closure
 * @param size number of bytes available in buf
 * @param buf where the callee should write the message
 * @return number of bytes written to buf
 */
size_t 
send_connect_packet (void *cls, size_t size, void *buf) {
    struct GNUNET_MESH_Handle           *h;
    struct GNUNET_MESH_ClientConnect    *msg;
    uint16_t                            *types;
    int                                 ntypes;
    GNUNET_MESH_ApplicationType         *apps;
    int                                 napps;

    if(0 == size || buf == NULL) {
        /* TODO treat error / retry */
        return 0;
    }
    if(sizeof(struct GNUNET_MessageHeader) > size) {
        /* TODO treat error / retry */
        return 0;
    }
    msg = (struct GNUNET_MESH_ClientConnect *) buf;
    h = (struct GNUNET_MESH_Handle *) cls;
    msg->header.type = GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT;
    for(ntypes = 0, types = NULL; h->message_handlers[ntypes].type; ntypes++) {
        types = GNUNET_realloc(types, sizeof(uint16_t) * (ntypes + 1));
        types[ntypes] = h->message_handlers[ntypes].type;
    }
    for(napps = 0, apps = NULL; h->applications[napps]; napps++) {
        apps = GNUNET_realloc(apps,
                              sizeof(GNUNET_MESH_ApplicationType) *
                                (napps + 1));
        apps[napps] = h->applications[napps];
    }
    msg->header.size = sizeof(struct GNUNET_MESH_ClientConnect) +
                        sizeof(uint16_t) * ntypes +
                        sizeof(GNUNET_MESH_ApplicationType) * napps;
    if(msg->header.size > size) {
        /* TODO treat error / retry */
        return 0;
    }
    memcpy(&msg[1], types, sizeof(uint16_t) * ntypes);
    memcpy(&msg[1] + sizeof(uint16_t) * ntypes,
           apps,
           sizeof(GNUNET_MESH_ApplicationType) * napps);
    return msg->header.size;
}



/**
 * Connect to the mesh service.
 *
 * @param cfg configuration to use
 * @param cls closure for the various callbacks that follow
 *            (including handlers in the handlers array)
 * @param cleaner function called when an *inbound* tunnel is destroyed
 * @param handlers callbacks for messages we care about, NULL-terminated
 *                 note that the mesh is allowed to drop notifications about
 *                 inbound messages if the client does not process them fast
 *                 enough (for this notification type, a bounded queue is used)
 * @param stypes Application Types the client claims to offer
 * @return handle to the mesh service 
 *         NULL on error (in this case, init is never called)
 */
struct GNUNET_MESH_Handle *
GNUNET_MESH_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
                     void *cls,
                     GNUNET_MESH_TunnelEndHandler cleaner,
                     const struct GNUNET_MESH_MessageHandler *handlers,
                     const GNUNET_MESH_ApplicationType *stypes) {
    struct GNUNET_MESH_Handle           *h;
    size_t                              size;

    h = GNUNET_malloc(sizeof(struct GNUNET_MESH_Handle));


    h->cleaner = cleaner;
    h->mesh = GNUNET_CLIENT_connect("mesh", cfg);
    if(h->mesh == NULL) {
        GNUNET_free(h);
        return NULL;
    }
    h->cls = cls;
    h->message_handlers = handlers;
    h->applications = stypes;

    for(h->n_handlers = 0; handlers[h->n_handlers].type; h->n_handlers++);
    for(h->n_applications = 0; stypes[h->n_applications]; h->n_applications++);
    h->n_handlers--;
    h->n_applications--;

    size = sizeof(struct GNUNET_MESH_ClientConnect);
    size += h->n_handlers * sizeof(uint16_t);
    size += h->n_applications * sizeof(GNUNET_MESH_ApplicationType);

    GNUNET_CLIENT_notify_transmit_ready(h->mesh,
                                        size,
                                        GNUNET_TIME_relative_get_forever(),
                                        GNUNET_YES,
                                        &send_connect_packet,
                                        (void *)h);

    return h;
}


/**
 * Disconnect from the mesh service.
 *
 * @param handle connection to mesh to disconnect
 */
void GNUNET_MESH_disconnect (struct GNUNET_MESH_Handle *handle) {
    
    GNUNET_free(handle);
    return;
}


/**
 * Create a new tunnel (we're initiator and will be allowed to add/remove peers
 * and to broadcast).
 *
 * @param h mesh handle
 * @param connect_handler function to call when peers are actually connected
 * @param disconnect_handler function to call when peers are disconnected
 * @param handler_cls closure for connect/disconnect handlers
 */
struct GNUNET_MESH_Tunnel *
GNUNET_MESH_tunnel_create (struct GNUNET_MESH_Handle *h,
                           GNUNET_MESH_TunnelConnectHandler
                           connect_handler,
                           GNUNET_MESH_TunnelDisconnectHandler
                           disconnect_handler,
                           void *handler_cls) {
    struct GNUNET_MESH_Tunnel           *tunnel;

    tunnel = GNUNET_malloc(sizeof(struct GNUNET_MESH_Tunnel));

    tunnel->connect_handler = connect_handler;
    tunnel->disconnect_handler = disconnect_handler;
    tunnel->peers = NULL;
    tunnel->cls = handler_cls;

    return tunnel;
}


/**
 * Request that a peer should be added to the tunnel.  The existing
 * connect handler will be called ONCE with either success or failure.
 *
 * @param tunnel handle to existing tunnel
 * @param timeout how long to try to establish a connection
 * @param peer peer to add
 */
void
GNUNET_MESH_peer_request_connect_add (struct GNUNET_MESH_Tunnel *tunnel,
                                      struct GNUNET_TIME_Relative timeout,
                                      const struct GNUNET_PeerIdentity *peer) {
    static GNUNET_PEER_Id       peer_id;
    
    peer_id = GNUNET_PEER_intern(peer);
    
    /* FIXME ACTUALLY DO STUFF */
    tunnel->peers = &peer_id;
    tunnel->connect_handler(tunnel->cls, peer, NULL);
    return;
}


/**
 * Request that a peer should be removed from the tunnel.  The existing
 * disconnect handler will be called ONCE if we were connected.
 *
 * @param tunnel handle to existing tunnel
 * @param peer peer to remove
 */
void
GNUNET_MESH_peer_request_connect_del (struct GNUNET_MESH_Tunnel *tunnel,
                                      const struct GNUNET_PeerIdentity *peer) {
    /* FIXME ACTUALLY DO STUFF */
    tunnel->peers = NULL;
    tunnel->disconnect_handler(tunnel->cls, peer);
    return;
}


/**
 * Request that the mesh should try to connect to a peer supporting the given
 * message type.
 *
 * @param tunnel handle to existing tunnel
 * @param timeout how long to try to establish a connection
 * @param app_type application type that must be supported by the peer (MESH
 *                 should discover peer in proximity handling this type)
 */
void
GNUNET_MESH_peer_request_connect_by_type (struct GNUNET_MESH_Tunnel *tunnel,
                                          struct GNUNET_TIME_Relative timeout,
                                          GNUNET_MESH_ApplicationType
                                          app_type) {
    return;
}


/**
 * Ask the mesh to call "notify" once it is ready to transmit the
 * given number of bytes to the specified "target".  If we are not yet
 * connected to the specified peer, a call to this function will cause
 * us to try to establish a connection.
 *
 * @param tunnel tunnel to use for transmission
 * @param cork is corking allowed for this transmission?
 * @param priority how important is the message?
 * @param maxdelay how long can the message wait?
 * @param target destination for the message,
 *               NULL for multicast to all tunnel targets 
 * @param notify_size how many bytes of buffer space does notify want?
 * @param notify function to call when buffer space is available;
 *        will be called with NULL on timeout or if the overall queue
 *        for this peer is larger than queue_size and this is currently
 *        the message with the lowest priority
 * @param notify_cls closure for notify
 * @return non-NULL if the notify callback was queued,
 *         NULL if we can not even queue the request (insufficient
 *         memory); if NULL is returned, "notify" will NOT be called.
 */
struct GNUNET_MESH_TransmitHandle *
GNUNET_MESH_notify_transmit_ready (struct GNUNET_MESH_Tunnel *tunnel,
                                   int cork,
                                   uint32_t priority,
                                   struct GNUNET_TIME_Relative maxdelay,
                                   const struct GNUNET_PeerIdentity *target,
                                   size_t notify_size,
                                   GNUNET_CONNECTION_TransmitReadyNotify
                                   notify,
                                   void *notify_cls) {
    struct GNUNET_MESH_TransmitHandle   *handle;

    handle = GNUNET_malloc(sizeof(struct GNUNET_MESH_TransmitHandle));

    return handle;
}


#if 0                           /* keep Emacsens' auto-indent happy */
{
#endif
#ifdef __cplusplus
}
#endif