summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPatrick Griffis <pgriffis@igalia.com>2021-04-17 14:35:43 -0500
committerPatrick Griffis <pgriffis@igalia.com>2021-04-17 14:35:43 -0500
commit6ba415885e332ac0d34e0f03686105870e937276 (patch)
tree8c293f0d3a56ee018513ab287c752c38c0025245
parentcfb9193039e2fb54e13e84bd3378b649c0f9afba (diff)
downloadlibsoup-wip/docs-threading.tar.gz
docs: Add clarification on threadingwip/docs-threading
-rw-r--r--docs/reference/migrating-from-libsoup-2.xml6
1 files changed, 6 insertions, 0 deletions
diff --git a/docs/reference/migrating-from-libsoup-2.xml b/docs/reference/migrating-from-libsoup-2.xml
index 74f2e375..50c5ba29 100644
--- a/docs/reference/migrating-from-libsoup-2.xml
+++ b/docs/reference/migrating-from-libsoup-2.xml
@@ -182,5 +182,11 @@ linkend="soup-uri-decode-data-uri"><function>soup_uri_decode_data_uri()</functio
<link linkend="soup_message_set_request_body_from_bytes"><function>soup_message_set_request_body_from_bytes()</function></link> to use a GBytes
buffer.</para>
</sect2>
+ <sect2 id="threading">
+ <title>Clarification on thread-safety</title>
+ <para>In libsoup 2 there was an attempt at making various APIs of the library thread-safe; However this was never well tested, maintained, or documented.</para>
+ <para>In libsoup 3 it now behaves in-line with other GObject libraries. Once you create a <link linkend="SoupSession"><type>SoupSession</type></link> all usage of that
+ session must happen on the same thread. You may create seperate sessions per thread but in most use-cases you should be using the async APIs which handle non-blocking IO for you.</para>
+ </sect2>
</chapter>