iterate topoogy header related stuff

[oweals/gnunet.git] / src / include / gnunet_client_lib.h

diff --git a/src/include/gnunet_client_lib.h b/src/include/gnunet_client_lib.h
index 2ba9e135f4c83b633cc36cd65531ddab0baa651d..49ccc6c6b11e9dacad3e403789363a71ccedaccd 100644 (file)
--- a/src/include/gnunet_client_lib.h
+++ b/src/include/gnunet_client_lib.h
@@ -63,18 +63,36 @@ struct GNUNET_CLIENT_Connection *GNUNET_CLIENT_connect (struct
                                                         GNUNET_CONFIGURATION_Handle
                                                         *cfg);
 
+
+/**
+ * Configure this connection to ignore shutdown signals.
+ *
+ * @param h client handle
+ * @param do_ignore GNUNET_YES to ignore, GNUNET_NO to restore default
+ */
+void
+GNUNET_CLIENT_ignore_shutdown (struct GNUNET_CLIENT_Connection *h,
+                              int do_ignore);
+
+
+
 /**
  * Destroy connection with the service.  This will automatically
  * cancel any pending "receive" request (however, the handler will
  * *NOT* be called, not even with a NULL message).  Any pending
  * transmission request will also be cancelled UNLESS the callback for
  * the transmission request has already been called, in which case the
- * transmission is guaranteed to complete before the socket is fully
- * destroyed.
+ * transmission 'finish_pending_write' argument determines whether or
+ * not the write is guaranteed to complete before the socket is fully
+ * destroyed (unless, of course, there is an error with the server in
+ * which case the message may still be lost).
  *
  * @param sock handle to the service connection
+ * @param finish_pending_write should a transmission already passed to the
+ *          handle be completed?
  */
-void GNUNET_CLIENT_disconnect (struct GNUNET_CLIENT_Connection *sock);
+void GNUNET_CLIENT_disconnect (struct GNUNET_CLIENT_Connection *sock,
+                              int finish_pending_write);
 
 /**
  * Type of a function to call when we receive a message
@@ -87,6 +105,19 @@ typedef void (*GNUNET_CLIENT_MessageHandler) (void *cls,
                                               const struct
                                               GNUNET_MessageHeader * msg);
 
+/**
+ * Type of a function to call when we have finished shutting
+ * down a service, or failed.
+ *
+ * @param cls closure
+ * @param reason what is the result of the shutdown
+ *        GNUNET_NO on shutdown (not running)
+ *        GNUNET_YES on running
+ *        GNUNET_SYSERR on failure to transmit message
+ */
+typedef void (*GNUNET_CLIENT_ShutdownTask) (void *cls,
+                                            int reason);
+
 /**
  * Read from the service.
  *
@@ -176,16 +207,6 @@ GNUNET_CLIENT_transmit_and_get_response (struct GNUNET_CLIENT_Connection *sock,
                                         void *rn_cls);
 
 
-
-/**
- * Request that the service should shutdown.
- * Afterwards, the connection should be disconnected.
- *
- * @param sock the socket connected to the service
- */
-void GNUNET_CLIENT_service_shutdown (struct GNUNET_CLIENT_Connection *sock);
-
-
 /**
  * Wait until the service is running.
  *