clarify use of client_drop
authorChristian Grothoff <christian@grothoff.org>
Sun, 29 Oct 2017 10:23:34 +0000 (11:23 +0100)
committerChristian Grothoff <christian@grothoff.org>
Sun, 29 Oct 2017 10:23:34 +0000 (11:23 +0100)
src/include/gnunet_service_lib.h

index aacafe9565cec73a1b0d16af77de1151185e1ebb..dda827c95e055cb584159f1d5f2cdda2edcd7018 100644 (file)
@@ -366,11 +366,16 @@ GNUNET_SERVICE_client_disable_continue_warning (struct GNUNET_SERVICE_Client *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
+ * handling a message, except 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.
  *
+ * This function should be called (outside of util's internal logic)
+ * if (and usually only if) the client has violated the
+ * protocol. Otherwise, we should leave it to the client to disconnect
+ * from the service.
+ *
  * @param c client to disconnect now
  */
 void