~ubuntu-branches/ubuntu/lucid/libsoup2.4/lucid-security

« back to all changes in this revision

Viewing changes to docs/reference/xml/soup-message-filter.xml

  • Committer: Bazaar Package Importer
  • Author(s): Loic Minier
  • Date: 2008-02-13 12:06:57 UTC
  • mfrom: (1.1.2 upstream)
  • Revision ID: james.westby@ubuntu.com-20080213120657-6zh4io8k5q5bpxxs
Tags: 2.3.2-1~hardy1
Push to hardy while the package sits in Debian NEW.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
<?xml version="1.0"?>
2
 
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
3
 
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
4
 
<refentry id="libsoup-SoupMessageFilter">
5
 
<refmeta>
6
 
<refentrytitle role="top_of_page">SoupMessageFilter</refentrytitle>
7
 
<manvolnum>3</manvolnum>
8
 
<refmiscinfo>LIBSOUP Library</refmiscinfo>
9
 
</refmeta>
10
 
 
11
 
<refnamediv>
12
 
<refname>SoupMessageFilter</refname>
13
 
<refpurpose>Automatic message processing</refpurpose>
14
 
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
15
 
</refnamediv>
16
 
 
17
 
<refsynopsisdiv role="synopsis">
18
 
<title role="synopsis.title">Synopsis</title>
19
 
 
20
 
<synopsis>
21
 
 
22
 
 
23
 
 
24
 
<link linkend="void">void</link>        <link linkend="soup-message-filter-setup-message">soup_message_filter_setup_message</link>
25
 
                                            (<link linkend="SoupMessageFilter">SoupMessageFilter</link> *filter,
26
 
                                             <link linkend="SoupMessage">SoupMessage</link> *msg);
27
 
 
28
 
</synopsis>
29
 
</refsynopsisdiv>
30
 
 
31
 
 
32
 
 
33
 
 
34
 
 
35
 
 
36
 
 
37
 
 
38
 
 
39
 
<refsect1 role="desc">
40
 
<title role="desc.title">Description</title>
41
 
<para>
42
 
 
43
 
</para>
44
 
</refsect1>
45
 
 
46
 
<refsect1 role="details">
47
 
<title role="details.title">Details</title>
48
 
<refsect2>
49
 
<title><anchor id="soup-message-filter-setup-message" role="function"/>soup_message_filter_setup_message ()</title>
50
 
<indexterm><primary>soup_message_filter_setup_message</primary></indexterm><programlisting><link linkend="void">void</link>        soup_message_filter_setup_message
51
 
                                            (<link linkend="SoupMessageFilter">SoupMessageFilter</link> *filter,
52
 
                                             <link linkend="SoupMessage">SoupMessage</link> *msg);</programlisting>
53
 
<para>
54
 
Performs some sort of processing on <parameter>msg</parameter> in preparation for it
55
 
being sent. This will generally involve some combination of adding
56
 
headers, adding handlers, and connecting to signals.</para>
57
 
<para>
58
 
 
59
 
</para><variablelist role="params">
60
 
<varlistentry><term><parameter>filter</parameter>&nbsp;:</term>
61
 
<listitem><simpara> an object that implements the <link linkend="SoupMessageFilter"><type>SoupMessageFilter</type></link> interface
62
 
</simpara></listitem></varlistentry>
63
 
<varlistentry><term><parameter>msg</parameter>&nbsp;:</term>
64
 
<listitem><simpara> a <link linkend="SoupMessage"><type>SoupMessage</type></link>
65
 
</simpara></listitem></varlistentry>
66
 
</variablelist></refsect2>
67
 
 
68
 
</refsect1>
69
 
 
70
 
 
71
 
 
72
 
 
73
 
</refentry>