[libsoup/websockets-extension-buffer-error: 1/2] WebSockets: document how extensions should treat buffers in case of error



commit 2a02994bdd6c0e9c692426af2fc0450e57d4e55b
Author: Claudio Saavedra <csaavedra igalia com>
Date:   Fri Aug 30 15:15:55 2019 +0300

    WebSockets: document how extensions should treat buffers in case of error
    
    In case of error while processing an incoming or outgoing message, an
    extension should return NULL as is customary. This way, in case of
    error, the caller doesn't need to worry about having to deal with
    dropping the reference for the returned value if non-NULL.

 libsoup/soup-websocket-extension.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
---
diff --git a/libsoup/soup-websocket-extension.c b/libsoup/soup-websocket-extension.c
index b04a4fd8..91ae6951 100644
--- a/libsoup/soup-websocket-extension.c
+++ b/libsoup/soup-websocket-extension.c
@@ -159,7 +159,7 @@ soup_websocket_extension_get_response_params (SoupWebsocketExtension *extension)
  *
  * Extensions using reserved bits of the header will change them in @header.
  *
- * Returns: (transfer full): the message payload data
+ * Returns: (transfer full): the message payload data, or %NULL in case of error
  *
  * Since: 2.68
  */
@@ -196,7 +196,7 @@ soup_websocket_extension_process_outgoing_message (SoupWebsocketExtension *exten
  *
  * Extensions using reserved bits of the header will reset them in @header.
  *
- * Returns: (transfer full): the message payload data
+ * Returns: (transfer full): the message payload data, or %NULL in case of error
  *
  * Since: 2.68
  */


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]