e9b77aa593d184e9a0c3a66883d9a7d5163806ab
[oweals/gnunet.git] / src / fs / gnunet-service-fs_lc.h
1 /*
2      This file is part of GNUnet.
3      (C) 2011 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 fs/gnunet-service-fs_lc.h
23  * @brief API to handle 'connected peers'
24  * @author Christian Grothoff
25  */
26 #ifndef GNUNET_SERVICE_FS_LC_H
27 #define GNUNET_SERVICE_FS_LC_H
28
29 #include "gnunet-service-fs.h"
30
31
32 /**
33  * Look up a local client record or create one if it
34  * doesn't exist yet.
35  *
36  * @param client handle of the client
37  * @return handle to local client entry
38  */
39 struct GSF_LocalClient *
40 GSF_local_client_lookup_ (struct GNUNET_SERVER_Client *client);
41
42
43 /**
44  * Handle START_SEARCH-message (search request from local client).
45  *
46  * @param cls closure
47  * @param client identification of the client
48  * @param message the actual message
49  */
50 void
51 GSF_local_client_start_search_handler_ (void *cls,
52                                         struct GNUNET_SERVER_Client *client,
53                                         const struct GNUNET_MessageHeader *message);
54
55
56 /**
57  * Transmit a message to the given local client as soon as possible.
58  * If the client disconnects before transmission, the message is
59  * simply discarded.
60  *
61  * @param lc recipient
62  * @param msg message to transmit to client
63  */
64 void
65 GSF_local_client_transmit_ (struct GSF_LocalClient *lc,
66                             const struct GNUNET_MessageHeader *msg);
67
68
69 /**
70  * A client disconnected from us.  Tear down the local client record.
71  *
72  * @param cls unused
73  * @param client handle of the client
74  */
75 void
76 GSF_client_disconnect_handler_ (void *cls,
77                                 const struct GNUNET_SERVER_Client *client);
78
79
80 #endif
81 /* end of gnunet-service-fs_lc.h */