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
|
/*
This file is part of GNUnet.
Copyright (C) 2011 GNUnet e.V.
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., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
/**
* @file fs/gnunet-service-fs_lc.h
* @brief API to handle 'local clients'
* @author Christian Grothoff
*/
#ifndef GNUNET_SERVICE_FS_LC_H
#define GNUNET_SERVICE_FS_LC_H
#include "gnunet-service-fs.h"
/**
* Look up a local client record or create one if it
* doesn't exist yet.
*
* @param client handle of the client
* @return handle to local client entry
*/
struct GSF_LocalClient *
GSF_local_client_lookup_ (struct GNUNET_SERVER_Client *client);
/**
* Handle START_SEARCH-message (search request from local client).
* Only responsible for creating the request entry itself and setting
* up reply callback and cancellation on client disconnect. Does NOT
* execute the actual request strategy (planning).
*
* @param client identification of the client
* @param message the actual message
* @param prptr where to store the pending request handle for the request
* @return GNUNET_YES to start local processing,
* GNUNET_NO to not (yet) start local processing,
* GNUNET_SYSERR on error
*/
int
GSF_local_client_start_search_handler_ (struct GNUNET_SERVER_Client *client,
const struct GNUNET_MessageHeader
*message,
struct GSF_PendingRequest **prptr);
/**
* Transmit a message to the given local client as soon as possible.
* If the client disconnects before transmission, the message is
* simply discarded.
*
* @param lc recipient
* @param msg message to transmit to client
*/
void
GSF_local_client_transmit_ (struct GSF_LocalClient *lc,
const struct GNUNET_MessageHeader *msg);
/**
* A client disconnected from us. Tear down the local client record.
*
* @param cls unused
* @param client handle of the client
*/
void
GSF_client_disconnect_handler_ (void *cls, struct GNUNET_SERVER_Client *client);
#endif
/* end of gnunet-service-fs_lc.h */
|