fixing leak

[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 c78df41c7c59a993420f9b661b18a3c76ced01d3..41dbe4efc1809b9ee8744918cd1c6cd2bd40a09d 100644 (file)
--- a/src/include/gnunet_client_lib.h
+++ b/src/include/gnunet_client_lib.h
@@ -49,27 +49,46 @@ struct GNUNET_CLIENT_Connection;
 /**
  * Get a connection with a service.
  *
- * @param sched scheduler to use
  * @param service_name name of the service
  * @param cfg configuration to use
  * @return NULL on error (service unknown to configuration)
  */
-struct GNUNET_CLIENT_Connection *GNUNET_CLIENT_connect (struct
-                                                        GNUNET_SCHEDULER_Handle
-                                                        *sched,
-                                                        const char
+struct GNUNET_CLIENT_Connection *GNUNET_CLIENT_connect (const char
                                                         *service_name,
                                                         const 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).
+ * 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 '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
@@ -82,6 +101,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.
  *
@@ -171,20 +203,9 @@ 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.
  *
- * @param sched scheduler to use
  * @param service name of the service to wait for
  * @param cfg configuration to use
  * @param timeout how long to wait at most in ms
@@ -193,8 +214,7 @@ void GNUNET_CLIENT_service_shutdown (struct GNUNET_CLIENT_Connection *sock);
  *         or "TIMEOUT" (service not known to be running))
  * @param task_cls closure for task
  */
-void GNUNET_CLIENT_service_test (struct GNUNET_SCHEDULER_Handle *sched,
-                                 const char *service,
+void GNUNET_CLIENT_service_test (const char *service,
                                  const struct GNUNET_CONFIGURATION_Handle *cfg,
                                  struct GNUNET_TIME_Relative timeout,
                                  GNUNET_SCHEDULER_Task task, void *task_cls);