GNUnet  0.10.x
gnunet_service_lib.h
Go to the documentation of this file.
1 /*
2  This file is part of GNUnet.
3  Copyright (C) 2009-2013, 2016, 2017 GNUnet e.V.
4 
5  GNUnet is free software: you can redistribute it and/or modify it
6  under the terms of the GNU Affero General Public License as published
7  by the Free Software Foundation, either version 3 of the License,
8  or (at your 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  Affero General Public License for more details.
14 
15  You should have received a copy of the GNU Affero General Public License
16  along with this program. If not, see <http://www.gnu.org/licenses/>.
17 
18  SPDX-License-Identifier: AGPL3.0-or-later
19  */
20 
35 #ifndef GNUNET_SERVICE_LIB_H
36 #define GNUNET_SERVICE_LIB_H
37 
38 #ifdef __cplusplus
39 extern "C"
40 {
41 #if 0 /* keep Emacsens' auto-indent happy */
42 }
43 #endif
44 #endif
45 
47 #include "gnunet_mq_lib.h"
48 
49 
59 
66 
72 };
73 
74 
75 
76 /* **************** NEW SERVICE API ********************** */
77 
82 
83 
88 
89 
97 typedef void
99  const struct GNUNET_CONFIGURATION_Handle *cfg,
100  struct GNUNET_SERVICE_Handle *sh);
101 
102 
111 typedef void *
112 (*GNUNET_SERVICE_ConnectHandler)(void *cls,
113  struct GNUNET_SERVICE_Client *c,
114  struct GNUNET_MQ_Handle *mq);
115 
116 
124 typedef void
126  struct GNUNET_SERVICE_Client *c,
127  void *internal_cls);
128 
129 
166 struct GNUNET_SERVICE_Handle *
168  const struct GNUNET_CONFIGURATION_Handle *cfg,
171  void *cls,
172  const struct GNUNET_MQ_MessageHandler *handlers);
173 
174 
180 void
182 
183 
225 int
226 GNUNET_SERVICE_run_(int argc,
227  char *const *argv,
228  const char *service_name,
233  void *cls,
234  const struct GNUNET_MQ_MessageHandler *handlers);
235 
236 
294 #define GNUNET_SERVICE_MAIN(service_name, service_options, init_cb, connect_cb, disconnect_cb, cls, ...) \
295  int \
296  main(int argc, \
297  char *const *argv) \
298  { \
299  struct GNUNET_MQ_MessageHandler mh[] = { \
300  __VA_ARGS__ \
301  }; \
302  return GNUNET_SERVICE_run_(argc, \
303  argv, \
304  service_name, \
305  service_options, \
306  init_cb, \
307  connect_cb, \
308  disconnect_cb, \
309  cls, \
310  mh); \
311  }
312 
313 
320 void
322 
323 
329 void
331 
332 
339 void
341 
342 
349 struct GNUNET_MQ_Handle *
351 
352 
361 void
363 
364 
380 void
382 
383 
389 void
391 
392 
405 void
407 
408 
416 void
418 
419 
420 #if 0 /* keep Emacsens' auto-indent happy */
421 {
422 #endif
423 #ifdef __cplusplus
424 }
425 #endif
426 
427 /* ifndef GNUNET_SERVICE_LIB_H */
428 #endif
429  /* end of group service */
431 
432 /* end of gnunet_service_lib.h */
static void * connect_cb(void *cls, struct GNUNET_CADET_Channel *channel, const struct GNUNET_PeerIdentity *initiator)
Functions of this type are called upon new cadet connection from other peers.
GNUNET_SERVICE_InitCallback service_init_cb
Main service-specific task to run.
Definition: service.c:128
void GNUNET_SERVICE_resume(struct GNUNET_SERVICE_Handle *sh)
Resume accepting connections from the listen socket.
Definition: service.c:2185
struct GNUNET_GETOPT_CommandLineOption options[]
Definition: 002.c:5
Handle to a service.
Definition: service.c:114
struct GNUNET_MQ_Handle * GNUNET_SERVICE_client_get_mq(struct GNUNET_SERVICE_Client *c)
Obtain the message queue of c.
Definition: service.c:2424
GNUNET_SERVICE_Options
Options for the service (bitmask).
static void disconnect_cb(void *cls, const struct GNUNET_CADET_Channel *channel)
Function called by cadet when a client disconnects.
Do not trigger server shutdown on signal at all; instead, allow for the user to terminate the server ...
struct GNUNET_SERVICE_Handle * GNUNET_SERVICE_start(const char *service_name, const struct GNUNET_CONFIGURATION_Handle *cfg, GNUNET_SERVICE_ConnectHandler connect_cb, GNUNET_SERVICE_DisconnectHandler disconnect_cb, void *cls, const struct GNUNET_MQ_MessageHandler *handlers)
Low-level function to start a service if the scheduler is already running.
Definition: service.c:1874
Handle to a client that is connected to a service.
Definition: service.c:246
static struct GNUNET_CADET_MessageHandler handlers[]
Handlers, for diverse services.
void *(* GNUNET_SERVICE_ConnectHandler)(void *cls, struct GNUNET_SERVICE_Client *c, struct GNUNET_MQ_Handle *mq)
Callback to be called when a client connects to the service.
void(* GNUNET_SERVICE_DisconnectHandler)(void *cls, struct GNUNET_SERVICE_Client *c, void *internal_cls)
Callback to be called when a client disconnected from the service.
Trigger a SOFT server shutdown on signals, allowing active non-monitor clients to complete their tran...
static struct SolverHandle * sh
static char * service_name
Option -s: service name (hash to get service descriptor)
Definition: gnunet-vpn.c:51
void GNUNET_SERVICE_client_mark_monitor(struct GNUNET_SERVICE_Client *c)
Set the &#39;monitor&#39; flag on this client.
Definition: service.c:2394
void GNUNET_SERVICE_stop(struct GNUNET_SERVICE_Handle *srv)
Stops a service that was started with GNUNET_SERVICE_start().
Definition: service.c:1907
void GNUNET_SERVICE_client_drop(struct GNUNET_SERVICE_Client *c)
Ask the server to disconnect from the given client.
Definition: service.c:2315
Message handler for a specific message type.
static struct GNUNET_CONFIGURATION_Handle * cfg
Our configuration.
Definition: gnunet-arm.c:104
Handle to a message queue.
Definition: mq.c:84
int GNUNET_SERVICE_run_(int argc, char *const *argv, const char *service_name, enum GNUNET_SERVICE_Options options, GNUNET_SERVICE_InitCallback service_init_cb, GNUNET_SERVICE_ConnectHandler connect_cb, GNUNET_SERVICE_DisconnectHandler disconnect_cb, void *cls, const struct GNUNET_MQ_MessageHandler *handlers)
Creates the "main" function for a GNUnet service.
Definition: service.c:1962
configuration data
Definition: configuration.c:83
struct GNUNET_MQ_Handle * mq
Definition: 003.c:5
void GNUNET_SERVICE_suspend(struct GNUNET_SERVICE_Handle *sh)
Suspend accepting connections from the listen socket temporarily.
Definition: service.c:2173
void GNUNET_SERVICE_client_disable_continue_warning(struct GNUNET_SERVICE_Client *c)
Disable the warning the server issues if a message is not acknowledged in a timely fashion...
Definition: service.c:2258
void(* GNUNET_SERVICE_InitCallback)(void *cls, const struct GNUNET_CONFIGURATION_Handle *cfg, struct GNUNET_SERVICE_Handle *sh)
Callback to initialize a service, called exactly once when the service is run.
void GNUNET_SERVICE_client_continue(struct GNUNET_SERVICE_Client *c)
Continue receiving further messages from the given client.
Definition: service.c:2234
void GNUNET_SERVICE_client_persist(struct GNUNET_SERVICE_Client *c)
Set the persist option on this client.
Definition: service.c:2411
void GNUNET_SERVICE_shutdown(struct GNUNET_SERVICE_Handle *sh)
Explicitly stops the service.
Definition: service.c:2370