GNUnet  0.17.6
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 
42 #ifndef GNUNET_SERVICE_LIB_H
43 #define GNUNET_SERVICE_LIB_H
44 
45 #ifdef __cplusplus
46 extern "C"
47 {
48 #if 0 /* keep Emacsens' auto-indent happy */
49 }
50 #endif
51 #endif
52 
54 #include "gnunet_mq_lib.h"
55 
56 
61 {
67 
74 
80 
85 
91 };
92 
93 
94 /* **************** NEW SERVICE API ********************** */
95 
100 
101 
105 struct GNUNET_SERVICE_Client;
106 
107 
115 typedef void
116 (*GNUNET_SERVICE_InitCallback)(void *cls,
117  const struct GNUNET_CONFIGURATION_Handle *cfg,
118  struct GNUNET_SERVICE_Handle *sh);
119 
120 
129 typedef void *
130 (*GNUNET_SERVICE_ConnectHandler)(void *cls,
131  struct GNUNET_SERVICE_Client *c,
132  struct GNUNET_MQ_Handle *mq);
133 
134 
142 typedef void
144  struct GNUNET_SERVICE_Client *c,
145  void *internal_cls);
146 
147 
184 struct GNUNET_SERVICE_Handle *
186  const struct GNUNET_CONFIGURATION_Handle *cfg,
189  void *cls,
190  const struct GNUNET_MQ_MessageHandler *handlers);
191 
192 
198 void
200 
201 
243 int
244 GNUNET_SERVICE_run_ (int argc,
245  char *const *argv,
246  const char *service_name,
251  void *cls,
252  const struct GNUNET_MQ_MessageHandler *handlers);
253 
254 
312 #define GNUNET_SERVICE_MAIN(service_name, service_options, init_cb, connect_cb, \
313  disconnect_cb, cls, ...) \
314  int \
315  main (int argc, \
316  char *const *argv) \
317  { \
318  struct GNUNET_MQ_MessageHandler mh[] = { \
319  __VA_ARGS__ \
320  }; \
321  return GNUNET_SERVICE_run_ (argc, \
322  argv, \
323  service_name, \
324  service_options, \
325  init_cb, \
326  connect_cb, \
327  disconnect_cb, \
328  cls, \
329  mh); \
330  }
331 
332 
339 void
341 
342 
348 void
350 
351 
358 void
360 
361 
368 struct GNUNET_MQ_Handle *
370 
371 
380 void
383 
384 
400 void
402 
403 
409 void
411 
412 
425 void
427 
428 
436 void
438 
439 
440 #if 0 /* keep Emacsens' auto-indent happy */
441 {
442 #endif
443 #ifdef __cplusplus
444 }
445 #endif
446 
447 /* ifndef GNUNET_SERVICE_LIB_H */
448 #endif
449  /* end of group service */
451  /* end of group addition */
453 
454 /* end of gnunet_service_lib.h */
struct GNUNET_GETOPT_CommandLineOption options[]
Definition: 002.c:5
struct GNUNET_MQ_Handle * mq
Definition: 003.c:5
static const struct GNUNET_CONFIGURATION_Handle * cfg
Configuration we are using.
Definition: gnunet-abd.c:36
static struct SolverHandle * sh
static struct GNUNET_CADET_MessageHandler handlers[]
Handlers, for diverse services.
static void disconnect_cb(void *cls, const struct GNUNET_CADET_Channel *channel)
Function called by cadet when a client disconnects.
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.
static char * service_name
Option -s: service name (hash to get service descriptor)
Definition: gnunet-vpn.c:51
Configuration API.
General-purpose message queue.
void GNUNET_SERVICE_suspend(struct GNUNET_SERVICE_Handle *sh)
Suspend accepting connections from the listen socket temporarily.
Definition: service.c:2187
void GNUNET_SERVICE_stop(struct GNUNET_SERVICE_Handle *srv)
Stops a service that was started with GNUNET_SERVICE_start().
Definition: service.c:1912
void GNUNET_SERVICE_shutdown(struct GNUNET_SERVICE_Handle *sh)
Explicitly stops the service.
Definition: service.c:2388
GNUNET_SERVICE_Options
Options for the service (bitmask).
void GNUNET_SERVICE_client_mark_monitor(struct GNUNET_SERVICE_Client *c)
Set the 'monitor' flag on this client.
Definition: service.c:2412
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.
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_client_drop(struct GNUNET_SERVICE_Client *c)
Ask the server to disconnect from the given client.
Definition: service.c:2329
struct GNUNET_MQ_Handle * GNUNET_SERVICE_client_get_mq(struct GNUNET_SERVICE_Client *c)
Obtain the message queue of c.
Definition: service.c:2442
void GNUNET_SERVICE_client_persist(struct GNUNET_SERVICE_Client *c)
Set the persist option on this client.
Definition: service.c:2429
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:2272
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:1879
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:2248
void GNUNET_SERVICE_resume(struct GNUNET_SERVICE_Handle *sh)
Resume accepting connections from the listen socket.
Definition: service.c:2199
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:1967
@ GNUNET_SERVICE_OPTION_MANUAL_SHUTDOWN
Do not trigger server shutdown on signal at all; instead, allow for the user to terminate the server ...
@ GNUNET_SERVICE_OPTION_SHUTDOWN_BITMASK
Bitmask over the shutdown options.
@ GNUNET_SERVICE_OPTION_CLOSE_LSOCKS
Instead of listening on lsocks passed by the parent, close them after opening our own listen socket(s...
@ GNUNET_SERVICE_OPTION_NONE
Use defaults.
@ GNUNET_SERVICE_OPTION_SOFT_SHUTDOWN
Trigger a SOFT server shutdown on signals, allowing active non-monitor clients to complete their tran...
Handle to a message queue.
Definition: mq.c:86
Message handler for a specific message type.
Handle to a client that is connected to a service.
Definition: service.c:251
Handle to a service.
Definition: service.c:117
GNUNET_SERVICE_InitCallback service_init_cb
Main service-specific task to run.
Definition: service.c:131