← Back to branch summary

~ubuntu-branches/ubuntu/jaunty/libsoup2.4/jaunty-proposed

« back to all changes in this revision

Viewing changes to docs/reference/xml/soup-session-sync.xml

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2008-12-17 14:51:11 UTC
  • mfrom: (1.1.12 upstream)
  • Revision ID: james.westby@ubuntu.com-20081217145111-sqbz10l57fmrh4vz
Tags: 2.25.4-0ubuntu1
* New upstream version
* debian/control.in:
  - build-depends on libgconf2-dev, libproxy-dev
* Updated to list the new libsoup-gnome binaries
* debian/rules:
  - updated shlibs version and list the new library

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/xml/soup-session-sync.xml
12
12
<refname>SoupSessionSync</refname>
13
13
<refpurpose>Soup session for blocking I/O in multithreaded
14
14
programs.</refpurpose>
15
 
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
16
15
</refnamediv>
17
16
 
18
17
<refsynopsisdiv id="SoupSessionSync.synopsis" role="synopsis">
20
19
 
21
20
<synopsis>
22
21
struct              <link linkend="SoupSessionSync-struct">SoupSessionSync</link>;
23
 
<link linkend="SoupSession">SoupSession</link>*        <link linkend="soup-session-sync-new">soup_session_sync_new</link>               (void);
24
 
<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,
 
22
<link linkend="SoupSession">SoupSession</link> *       <link linkend="soup-session-sync-new">soup_session_sync_new</link>               (void);
 
23
<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,
25
24
                                                         ...);
26
25
</synopsis>
27
26
</refsynopsisdiv>
33
32
   +----<link linkend="SoupSession">SoupSession</link>
34
33
         +----SoupSessionSync
35
34
</synopsis>
36
 
 
37
35
</refsect1>
38
36
 
39
37
 
67
65
off to <link linkend="SoupSessionSync"><type>SoupSessionSync</type></link>, it can only be manipulated from its signal
68
66
handler callbacks, until I/O is complete.</para>
69
67
<para>
70
 
 
71
68
</para>
72
69
</refsect1>
73
70
 
75
72
<title role="details.title">Details</title>
76
73
<refsect2 id="SoupSessionSync-struct" role="struct">
77
74
<title>struct SoupSessionSync</title>
78
 
<indexterm zone="SoupSessionSync-struct"><primary>SoupSessionSync</primary></indexterm><programlisting>struct SoupSessionSync;</programlisting>
 
75
<indexterm zone="SoupSessionSync-struct"><primary sortas="SoupSessionSync">SoupSessionSync</primary></indexterm><programlisting>struct SoupSessionSync;</programlisting>
79
76
<para>
80
 
 
81
77
</para></refsect2>
82
78
<refsect2 id="soup-session-sync-new" role="function">
83
79
<title>soup_session_sync_new ()</title>
84
 
<indexterm zone="soup-session-sync-new"><primary>soup_session_sync_new</primary></indexterm><programlisting><link linkend="SoupSession">SoupSession</link>*        soup_session_sync_new               (void);</programlisting>
 
80
<indexterm zone="soup-session-sync-new"><primary sortas="soup_session_sync_new">soup_session_sync_new</primary></indexterm><programlisting><link linkend="SoupSession">SoupSession</link> *       soup_session_sync_new               (void);</programlisting>
85
81
<para>
86
82
Creates an synchronous <link linkend="SoupSession"><type>SoupSession</type></link> with the default options.</para>
87
83
<para>
88
 
 
89
84
</para><variablelist role="params">
90
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the new session.
 
85
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the new session.
91
86
</simpara></listitem></varlistentry>
92
87
</variablelist></refsect2>
93
88
<refsect2 id="soup-session-sync-new-with-options" role="function">
94
89
<title>soup_session_sync_new_with_options ()</title>
95
 
<indexterm zone="soup-session-sync-new-with-options"><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,
 
90
<indexterm zone="soup-session-sync-new-with-options"><primary sortas="soup_session_sync_new_with_options">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,
96
91
                                                         ...);</programlisting>
97
92
<para>
98
93
Creates an synchronous <link linkend="SoupSession"><type>SoupSession</type></link> with the specified options.</para>
99
94
<para>
100
 
 
101
95
</para><variablelist role="params">
102
 
<varlistentry><term><parameter>optname1</parameter>&nbsp;:</term>
 
96
<varlistentry><term><parameter>optname1</parameter>&#160;:</term>
103
97
<listitem><simpara> name of first property to set
104
98
</simpara></listitem></varlistentry>
105
 
<varlistentry><term><parameter>...</parameter>&nbsp;:</term>
 
99
<varlistentry><term><parameter>...</parameter>&#160;:</term>
106
100
<listitem><simpara> value of <parameter>optname1</parameter>, followed by additional property/value pairs
107
101
</simpara></listitem></varlistentry>
108
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the new session.
 
102
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the new session.
109
103
</simpara></listitem></varlistentry>
110
104
</variablelist></refsect2>
111
105