Commit 2a02994b authored by Claudio Saavedra's avatar Claudio Saavedra

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.
parent 2e94b0c0
......@@ -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
*/
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment