libmicrohttpd

commit 4b924674f31d09c222087f8eae0a76882558bd06
parent 23b0752b1dd4b67a0ea7e1bb06923e73d0509061
Author: ng0 <ng0@n0.is>
Date:   Sun, 21 Jul 2019 16:34:07 +0000

doxygen for send_

Diffstat:
M
src/microhttpd/mhd_send.c
 | 
19
+++++++++++++++++++

1 file changed, 19 insertions(+), 0 deletions(-)
diff --git a/src/microhttpd/mhd_send.c b/src/microhttpd/mhd_send.c
@@ -64,6 +64,25 @@
  * MHD_socket is defined in lib/mhd_sockets.h and the type
  * depends on the platform. However it is always a socket.
  */
+/**
+ * Send buffer on connection, and remember the current state of
+ * the socket options; only call setsockopt when absolutely
+ * necessary.
+ *
+ * @param connection the MHD_Connection structure
+ * @param buffer content of the buffer to send
+ * @param buffer_size the size of the buffer (in bytes)
+ * @param options the MHD_SendSocketOptions enum,
+          MHD_SSO_NO_CORK: definitely no corking (use NODELAY, or explicitly disable cork),
+          MHD_SSO_MAY_CORK: should enable corking (use MSG_MORE, or explicitly enable cork),
+          MHD_SSO_HDR_CORK: consider tcpi_snd_mss and consider not corking for the header
+          part if the size of the header is close to the MSS.
+          Only used if we are NOT doing 100 Continue and are still sending the
+          header (provided in full as the buffer to MHD_send_on_connection_ or as
+          the header to MHD_send_on_connection2_).
+ * @return sum of the number of bytes sent from both buffers or
+           -1 on error
+ */
 ssize_t
 MHD_send_on_connection_ (struct MHD_Connection *connection,
                          const char *buffer,