enum GNUNET_SERVICE_Options
{
/**
- * Use defaults.
+ * Use defaults. Terminates all client connections and the listen
+ * sockets immediately upon receiving the shutdown signal.
*/
GNUNET_SERVICE_OPTION_NONE = 0,
/**
- * Do not trigger server shutdown on signals, allow for the user
- * to terminate the server explicitly when needed.
+ * Do not trigger server shutdown on signal at all; instead, allow
+ * for the user to terminate the server explicitly when needed
+ * by calling #GNUNET_SERVICE_shutdown().
*/
GNUNET_SERVICE_OPTION_MANUAL_SHUTDOWN = 1,
/* **************** NEW SERVICE API ********************** */
/**
- *
+ * Handle to a service.
*/
struct GNUNET_SERVICE_Handle;
/**
- *
+ * Handle to a client that is connected to a service.
*/
struct GNUNET_SERVICE_Client;
/**
+ * Callback to initialize a service, called exactly once when the service is run.
*
- *
- * @param cls
- * @param cfg
- * @param sh
+ * @param cls closure passed to #GNUNET_SERVICE_MAIN
+ * @param cfg configuration to use for this service
+ * @param sh handle to the newly create service
*/
typedef void
(*GNUNET_SERVICE_InitCallback)(void *cls,
/**
+ * Callback to be called when a client connects to the service.
*
- *
- * @param cls
- * @param c
- * @param mq
- * @return
+ * @param cls closure for the service
+ * @param c the new client that connected to the service
+ * @param mq the message queue used to send messages to the client
+ * @return the client-specific (`internal') closure
*/
typedef void *
(*GNUNET_SERVICE_ConnectHandler)(void *cls,
/**
+ * Callback to be called when a client disconnected from the service
*
- *
- * @param cls
- * @param c
- * @param internal_cls
+ * @param cls closure for the service
+ * @param c the client that disconnected
+ * @param internal_cls the client-specific (`internal') closure
*/
typedef void
(*GNUNET_SERVICE_DisconnectHandler)(void *cls,
* dropped. Additionally, clients can be dropped at any time using
* #GNUNET_SERVICE_client_drop().
*
- * @param argc
- * @param argv
- * @param service_name
- * @param options
- * @param service_init_cb
- * @param connect_cb
- * @param disconnect_cb
- * @param cls
- * @param handlers
+ * @param argc number of command-line arguments in @a argv
+ * @param argv array of command-line arguments
+ * @param service_name name of the service to run
+ * @param options options controlling shutdown of the service
+ * @param service_init_cb function to call once the service is ready
+ * @param connect_cb function to call whenever a client connects
+ * @param disconnect_cb function to call whenever a client disconnects
+ * @param cls closure argument for @a service_init_cb, @a connect_cb and @a disconnect_cb
+ * @param handlers NULL-terminated array of message handlers for the service,
+ * the closure will be set to the value returned by
+ * the @a connect_cb for the respective connection
* @return 0 on success, non-zero on error
*/
int
* dropped. Additionally, clients can be dropped at any time using
* #GNUNET_SERVICE_client_drop().
*
- * @param argc
- * @param argv
- * @param service_name
- * @param options
- * @param service_init_cb
- * @param connect_cb
- * @param disconnect_cb
- * @param cls
- * @param handlers
+ * @param service_name name of the service to run
+ * @param options options controlling shutdown of the service
+ * @param service_init_cb function to call once the service is ready
+ * @param connect_cb function to call whenever a client connects
+ * @param disconnect_cb function to call whenever a client disconnects
+ * @param cls closure argument for @a service_init_cb, @a connect_cb and @a disconnect_cb
+ * @param handlers NULL-terminated array of message handlers for the service,
+ * the closure will be set to the value returned by
+ * the @a connect_cb for the respective connection
* @return 0 on success, non-zero on error
*/
#define GNUNET_SERVICE_MAIN(service_name,service_options,init_cb,connect_cb,disconnect_cb,cls,handlers) \
/**
+ * Suspend accepting connections from the listen socket temporarily.
+ * Resume activity using #GNUNET_SERVICE_resume.
*
- * @param sh
+ * @param sh service to stop accepting connections.
*/
void
GNUNET_SERVICE_suspend (struct GNUNET_SERVICE_Handle *sh);
+
/**
+ * Resume accepting connections from the listen socket.
*
- * @param sh
+ * @param sh service to resume accepting connections.
*/
void
GNUNET_SERVICE_resume (struct GNUNET_SERVICE_Handle *sh);
+
/**
+ * Continue receiving further messages from the given client.
+ * Must be called after each message received.
*
- * @param c
+ * @param c the client to continue receiving from
*/
void
GNUNET_SERVICE_client_continue (struct GNUNET_SERVICE_Client *c);
+
/**
+ * Disable the warning the server issues if a message is not
+ * acknowledged in a timely fashion. Use this call if a client is
+ * intentionally delayed for a while. Only applies to the current
+ * message.
*
- * @param c
+ * @param c client for which to disable the warning
*/
void
GNUNET_SERVICE_client_disable_continue_warning (struct GNUNET_SERVICE_Client *c);
+
/**
- *
- * @param c
+ * Ask the server to disconnect from the given client. This is the
+ * same as returning #GNUNET_SYSERR within the check procedure when
+ * handling a message, wexcept that it allows dropping of a client even
+ * when not handling a message from that client. The `disconnect_cb`
+ * will be called on @a c even if the application closes the connection
+ * using this function.
+ *
+ * @param c client to disconnect now
*/
void
GNUNET_SERVICE_client_drop (struct GNUNET_SERVICE_Client *c);
+
/**
+ * Explicitly stops the service.
*
- * @param sh
+ * @param sh server to shutdown
*/
void
-GNUNET_SERVICE_stop_listening (struct GNUNET_SERVICE_Handle *sh);
+GNUNET_SERVICE_shutdown (struct GNUNET_SERVICE_Handle *sh);
+
/**
- *
- * @param c
+ * Set the 'monitor' flag on this client. Clients which have been
+ * marked as 'monitors' won't prevent the server from shutting down
+ * once #GNUNET_SERVICE_stop_listening() has been invoked. The idea is
+ * that for "normal" clients we likely want to allow them to process
+ * their requests; however, monitor-clients are likely to 'never'
+ * disconnect during shutdown and thus will not be considered when
+ * determining if the server should continue to exist after
+ * shutdown has been triggered.
+ *
+ * @param c client to mark as a monitor
*/
void
GNUNET_SERVICE_client_mark_monitor (struct GNUNET_SERVICE_Client *c);
+
/**
+ * Set the persist option on this client. Indicates that the
+ * underlying socket or fd should never really be closed. Used for
+ * indicating process death.
*
- * @param c
+ * @param c client to persist the socket (never to be closed)
*/
void
GNUNET_SERVICE_client_persist (struct GNUNET_SERVICE_Client *c);
-
#if 0 /* keep Emacsens' auto-indent happy */
{
#endif