1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115
|
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="SoupSessionSync">
<refmeta>
<refentrytitle role="top_of_page">SoupSessionSync</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBSOUP Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>SoupSessionSync</refname>
<refpurpose>Soup session for blocking I/O in multithreaded programs.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
struct <link linkend="SoupSessionSync-struct">SoupSessionSync</link>;
<link linkend="SoupSession">SoupSession</link>* <link linkend="soup-session-sync-new">soup_session_sync_new</link> (void);
<link linkend="SoupSession">SoupSession</link>* <link linkend="soup-session-sync-new-with-options">soup_session_sync_new_with_options</link>
(const <link linkend="char">char</link> *optname1,
...);
</synopsis>
</refsynopsisdiv>
<refsect1 role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----<link linkend="SoupSession">SoupSession</link>
+----SoupSessionSync
</synopsis>
</refsect1>
<refsect1 role="impl_interfaces">
<title role="impl_interfaces.title">Implemented Interfaces</title>
<para>
SoupSessionSync implements
<link linkend="SoupMessageFilter">SoupMessageFilter</link>.</para>
</refsect1>
<refsect1 role="desc">
<title role="desc.title">Description</title>
<para>
<link linkend="SoupSessionSync"><type>SoupSessionSync</type></link> is an implementation of <link linkend="SoupSession"><type>SoupSession</type></link> that uses
synchronous I/O, intended for use in multi-threaded programs.
</para>
<para>
Note that you cannot use <link linkend="soup-session-queue-message"><function>soup_session_queue_message()</function></link> with a
synchronous session. You can only use <link linkend="soup-session-send-message"><function>soup_session_send_message()</function></link>.
</para>
</refsect1>
<refsect1 role="details">
<title role="details.title">Details</title>
<refsect2>
<title><anchor id="SoupSessionSync-struct" role="struct"/>struct SoupSessionSync</title>
<indexterm><primary>SoupSessionSync</primary></indexterm><programlisting>struct SoupSessionSync;</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="soup-session-sync-new" role="function"/>soup_session_sync_new ()</title>
<indexterm><primary>soup_session_sync_new</primary></indexterm><programlisting><link linkend="SoupSession">SoupSession</link>* soup_session_sync_new (void);</programlisting>
<para>
Creates an synchronous <link linkend="SoupSession"><type>SoupSession</type></link> with the default options.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the new session.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="soup-session-sync-new-with-options" role="function"/>soup_session_sync_new_with_options ()</title>
<indexterm><primary>soup_session_sync_new_with_options</primary></indexterm><programlisting><link linkend="SoupSession">SoupSession</link>* soup_session_sync_new_with_options
(const <link linkend="char">char</link> *optname1,
...);</programlisting>
<para>
Creates an synchronous <link linkend="SoupSession"><type>SoupSession</type></link> with the specified options.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>optname1</parameter> :</term>
<listitem><simpara> name of first property to set
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>...</parameter> :</term>
<listitem><simpara> value of <parameter>optname1</parameter>, followed by additional property/value pairs
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the new session.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|