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
|
/*
This file is part of GNUnet.
(C) 2009, 2010, 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 core/gnunet-service-core_clients.h
* @brief code for managing interactions with clients of core service
* @author Christian Grothoff
*/
#ifndef GNUNET_SERVICE_CORE_CLIENTS_H
#define GNUNET_SERVICE_CORE_CLIENTS_H
#include "gnunet_util_lib.h"
#include "gnunet-service-core.h"
#include "gnunet-service-core_typemap.h"
/**
* Send a message to one of our clients.
*
* @param client target for the message
* @param msg message to transmit
* @param can_drop could this message be dropped if the
* client's queue is getting too large?
*/
void
GSC_CLIENTS_send_to_client (struct GNUNET_SERVER_Client *client,
const struct GNUNET_MessageHeader *msg,
int can_drop);
/**
* Notify a particular client about a change to existing connection to
* one of our neighbours (check if the client is interested). Called
* from 'GSC_SESSIONS_notify_client_about_sessions'.
*
* @param client client to notify
* @param neighbour identity of the neighbour that changed status
* @param atsi performance information about neighbour
* @param atsi_count number of entries in 'ats' array
* @param tmap_old previous type map for the neighbour, NULL for disconnect
* @param tmap_new updated type map for the neighbour, NULL for disconnect
*/
void
GSC_CLIENTS_notify_client_about_neighbour (struct GSC_Client *client,
const struct GNUNET_PeerIdentity
*neighbour,
const struct GNUNET_ATS_Information
*atsi, unsigned int atsi_count,
const struct GSC_TypeMap *tmap_old,
const struct GSC_TypeMap *tmap_new);
/**
* Notify all clients about a change to existing session.
* Called from SESSIONS whenever there is a change in sessions
* or types processed by the respective peer.
*
* @param neighbour identity of the neighbour that changed status
* @param atsi performance information about neighbour
* @param atsi_count number of entries in 'ats' array
* @param tmap_old previous type map for the neighbour, NULL for disconnect
* @param tmap_new updated type map for the neighbour, NULL for disconnect
*/
void
GSC_CLIENTS_notify_clients_about_neighbour (const struct GNUNET_PeerIdentity
*neighbour,
const struct GNUNET_ATS_Information
*atsi, unsigned int atsi_count,
const struct GSC_TypeMap *tmap_old,
const struct GSC_TypeMap *tmap_new);
/**
* Deliver P2P message to interested clients. Caller must have checked
* that the sending peer actually lists the given message type as one
* of its types.
*
* @param sender peer who sent us the message
* @param atsi performance information about neighbour
* @param atsi_count number of entries in 'ats' array
* @param msg the message
* @param msize number of bytes to transmit
* @param options options for checking which clients should
* receive the message
*/
void
GSC_CLIENTS_deliver_message (const struct GNUNET_PeerIdentity *sender,
const struct GNUNET_ATS_Information *atsi,
unsigned int atsi_count,
const struct GNUNET_MessageHeader *msg,
uint16_t msize, int options);
/**
* Tell a client that we are ready to receive the message.
*
* @param car request that is now ready; the responsibility
* for the handle remains shared between CLIENTS
* and SESSIONS after this call.
*/
void
GSC_CLIENTS_solicit_request (struct GSC_ClientActiveRequest *car);
/**
* Tell a client that we will never be ready to receive the
* given message in time (disconnect or timeout).
*
* @param car request that now permanently failed; the
* responsibility for the handle is now returned
* to CLIENTS (SESSIONS is done with it).
*/
void
GSC_CLIENTS_reject_request (struct GSC_ClientActiveRequest *car);
/**
* Initialize clients subsystem.
*
* @param server handle to server clients connect to
*/
void
GSC_CLIENTS_init (struct GNUNET_SERVER_Handle *server);
/**
* Shutdown clients subsystem.
*/
void
GSC_CLIENTS_done (void);
#endif
/* end of gnunet-service-core_clients.h */
|
