From 479998adbfaa7747f3b415ba3f9c53d87365189d Mon Sep 17 00:00:00 2001 From: Willy Tarreau Date: Sun, 18 Nov 2018 06:30:59 +0100 Subject: [PATCH] CLEANUP: h2: minimum documentation for recent API changes Commit d4dd22d ("MINOR: h2: Let user of h2_recv() and h2_send() know xfer has been done") changed the API without documenting the expected returned values which appear to come out of nowhere in the code :-( Please don't do that anymore! The description was recovered from the commit message. --- src/mux_h2.c | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/src/mux_h2.c b/src/mux_h2.c index a5ea6c3ad..de635127e 100644 --- a/src/mux_h2.c +++ b/src/mux_h2.c @@ -2222,7 +2222,9 @@ static int h2_process_mux(struct h2c *h2c) } -/* Attempt to read data, and subscribe if none available */ +/* Attempt to read data, and subscribe if none available. + * The function returns 1 if data has been received, otherwise zero. + */ static int h2_recv(struct h2c *h2c) { struct connection *conn = h2c->conn; @@ -2263,7 +2265,9 @@ static int h2_recv(struct h2c *h2c) return 1; } -/* Try to send data if possible */ +/* Try to send data if possible. + * The function returns 1 if data have been sent, otherwise zero. + */ static int h2_send(struct h2c *h2c) { struct connection *conn = h2c->conn;