Docs for soup_session_requeue_message() don't match implementation
Submitted by min..@..arp.fm
Assigned to libsoup-maint@gnome.bugs
Link to original bug (#756285)
Description
According to the docs at https://developer.gnome.org/libsoup/stable/SoupSession.html#soup-session-queue-message the soup_session_queue_message() function says "Upon message completion, the callback specified in callback will be invoked. If after returning from this callback the message has not been requeued, msg will be unreffed."
According to the docs at https://developer.gnome.org/libsoup/stable/SoupSession.html#soup-session-requeue-message the soup_session_requeue_message() function "causes msg to be placed back on the queue to be attempted again."
In reality the attempt to call soup_session_requeue_message() causes an assertion failure as follows:
ibsoup-CRITICAL **: soup_session_real_requeue_message: assertion 'item != NULL' failed
The cause of the assertion failure is the following bug, marked as WONTFIX: https://bugzilla.gnome.org/show_bug.cgi?id=646835
To resolve this bug, either fix 646835, or document the fact the exact circumstances under which soup_session_requeue_message() works, assuming it works at all.
Version: 2.42.x