← Back to branch summary

~ubuntu-branches/ubuntu/karmic/evolution-data-server/karmic

« back to all changes in this revision

Viewing changes to docs/reference/camel/xml/camel-stream-mem.xml

  • Committer: Bazaar Package Importer
  • Author(s): Steve Langasek
  • Date: 2009-06-07 06:15:30 UTC
  • mfrom: (1.1.67 upstream) (1.2.5 squeeze)
  • Revision ID: james.westby@ubuntu.com-20090607061530-cb17kuzqikd115dt
Tags: 2.26.2-1ubuntu1
* Merge from Debian unstable, remaining changes:
  - debian/patches/90_upstream_change_fix_calendar_crasher.patch:
    upstream change to fix a calendar crasher leading to evolution hanging
  - debian/control:
    + Bump Build-Dependency on libgtk2.0-dev to (>= 2.14.0)
    + Add new Build-Dependency on libgweather-dev (>= 2.25.4) and
      libical-dev (>= 0.43)
    + Use Breaks instead of Conflicts against evolution 2.25 and earlier.
  - debian/libedata-book1.2-dev.install, debian/libebackend-1.2-dev.install,
    debian/libcamel1.2-dev.install, debian/libedataserverui1.2-dev.install:
    install html documentation
  - debian/evolution-data-server.install,
    debian/patches/45_libcamel_providers_version.patch:
    use the upstream versioning, not a Debian-specific one
* Dropped changes:
  - debian/patches/11_it_translation.patch: the Debian patch has been
    fixed up to apply to the current upstream version, so apply it even
    though we don't need it

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/camel/xml/camel-stream-mem.xml
8
8
<refnamediv>
9
9
<refname>CamelStreamMem</refname>
10
10
<refpurpose></refpurpose>
 
11
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
11
12
</refnamediv>
12
13
 
13
14
<refsynopsisdiv id="camel-CamelStreamMem.synopsis" role="synopsis">
15
16
 
16
17
<synopsis>
17
18
struct              <link linkend="CamelStreamMem">CamelStreamMem</link>;
18
 
<link linkend="CamelStream">CamelStream</link> *       <link linkend="camel-stream-mem-new">camel_stream_mem_new</link>                (void);
19
 
<link linkend="CamelStream">CamelStream</link> *       <link linkend="camel-stream-mem-new-with-byte-array">camel_stream_mem_new_with_byte_array</link>
 
19
<link linkend="CamelStream">CamelStream</link>*        <link linkend="camel-stream-mem-new">camel_stream_mem_new</link>                (void);
 
20
<link linkend="CamelStream">CamelStream</link>*        <link linkend="camel-stream-mem-new-with-byte-array">camel_stream_mem_new_with_byte_array</link>
20
21
                                                        (<link linkend="GByteArray">GByteArray</link> *buffer);
21
 
<link linkend="CamelStream">CamelStream</link> *       <link linkend="camel-stream-mem-new-with-buffer">camel_stream_mem_new_with_buffer</link>    (const <link linkend="char">char</link> *buffer,
 
22
<link linkend="CamelStream">CamelStream</link>*        <link linkend="camel-stream-mem-new-with-buffer">camel_stream_mem_new_with_buffer</link>    (const <link linkend="char">char</link> *buffer,
22
23
                                                         <link linkend="size-t">size_t</link> len);
23
24
<link linkend="void">void</link>                <link linkend="camel-stream-mem-set-secure">camel_stream_mem_set_secure</link>         (<link linkend="CamelStreamMem">CamelStreamMem</link> *mem);
24
25
<link linkend="void">void</link>                <link linkend="camel-stream-mem-set-byte-array">camel_stream_mem_set_byte_array</link>     (<link linkend="CamelStreamMem">CamelStreamMem</link> *mem,
39
40
 
40
41
<refsect1 id="camel-CamelStreamMem.description" role="desc">
41
42
<title role="desc.title">Description</title>
42
 
 
43
43
<para>
 
44
 
44
45
</para>
45
46
</refsect1>
46
47
 
48
49
<title role="details.title">Details</title>
49
50
<refsect2 id="CamelStreamMem" role="struct">
50
51
<title>struct CamelStreamMem</title>
51
 
<indexterm zone="CamelStreamMem"><primary>CamelStreamMem</primary></indexterm>
52
 
<programlisting>struct CamelStreamMem {
 
52
<indexterm zone="CamelStreamMem"><primary>CamelStreamMem</primary></indexterm><programlisting>struct CamelStreamMem {
53
53
        CamelSeekableStream parent_object;
54
54
 
55
 
        unsigned int owner:1;&#160;/* do we own the buffer? */
56
 
        unsigned int secure:1;&#160;/* do we clear the buffer on finalise (if we own it) */
 
55
        unsigned int owner:1;   /* do we own the buffer? */
 
56
        unsigned int secure:1;  /* do we clear the buffer on finalise (if we own it) */
57
57
        GByteArray *buffer;
58
58
};
59
59
</programlisting>
60
60
<para>
 
61
 
61
62
</para></refsect2>
62
63
<refsect2 id="camel-stream-mem-new" role="function">
63
64
<title>camel_stream_mem_new ()</title>
64
 
<indexterm zone="camel-stream-mem-new"><primary>camel_stream_mem_new</primary></indexterm>
65
 
<programlisting><link linkend="CamelStream">CamelStream</link> *       camel_stream_mem_new                (void);</programlisting>
 
65
<indexterm zone="camel-stream-mem-new"><primary>camel_stream_mem_new</primary></indexterm><programlisting><link linkend="CamelStream">CamelStream</link>*        camel_stream_mem_new                (void);</programlisting>
66
66
<para>
67
67
Create a new <link linkend="CamelStreamMem"><type>CamelStreamMem</type></link> object.</para>
68
68
<para>
 
69
 
69
70
</para><variablelist role="params">
70
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a new <link linkend="CamelStreamMem"><type>CamelStreamMem</type></link>
 
71
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a new <link linkend="CamelStreamMem"><type>CamelStreamMem</type></link>
71
72
</simpara></listitem></varlistentry>
72
73
</variablelist></refsect2>
73
74
<refsect2 id="camel-stream-mem-new-with-byte-array" role="function">
74
75
<title>camel_stream_mem_new_with_byte_array ()</title>
75
 
<indexterm zone="camel-stream-mem-new-with-byte-array"><primary>camel_stream_mem_new_with_byte_array</primary></indexterm>
76
 
<programlisting><link linkend="CamelStream">CamelStream</link> *       camel_stream_mem_new_with_byte_array
 
76
<indexterm zone="camel-stream-mem-new-with-byte-array"><primary>camel_stream_mem_new_with_byte_array</primary></indexterm><programlisting><link linkend="CamelStream">CamelStream</link>*        camel_stream_mem_new_with_byte_array
77
77
                                                        (<link linkend="GByteArray">GByteArray</link> *buffer);</programlisting>
78
78
<para>
79
79
Create a new <link linkend="CamelStreamMem"><type>CamelStreamMem</type></link> using <parameter>buffer</parameter> as the stream data.
82
82
Note: The newly created <link linkend="CamelStreamMem"><type>CamelStreamMem</type></link> will destroy <parameter>buffer</parameter>
83
83
when destroyed.</para>
84
84
<para>
 
85
 
85
86
</para><variablelist role="params">
86
 
<varlistentry><term><parameter>buffer</parameter>&#160;:</term>
 
87
<varlistentry><term><parameter>buffer</parameter>&nbsp;:</term>
87
88
<listitem><simpara> a <link linkend="GByteArray"><type>GByteArray</type></link> to use as the stream data
88
89
</simpara></listitem></varlistentry>
89
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a new <link linkend="CamelStreamMem"><type>CamelStreamMem</type></link>
 
90
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a new <link linkend="CamelStreamMem"><type>CamelStreamMem</type></link>
90
91
</simpara></listitem></varlistentry>
91
92
</variablelist></refsect2>
92
93
<refsect2 id="camel-stream-mem-new-with-buffer" role="function">
93
94
<title>camel_stream_mem_new_with_buffer ()</title>
94
 
<indexterm zone="camel-stream-mem-new-with-buffer"><primary>camel_stream_mem_new_with_buffer</primary></indexterm>
95
 
<programlisting><link linkend="CamelStream">CamelStream</link> *       camel_stream_mem_new_with_buffer    (const <link linkend="char">char</link> *buffer,
 
95
<indexterm zone="camel-stream-mem-new-with-buffer"><primary>camel_stream_mem_new_with_buffer</primary></indexterm><programlisting><link linkend="CamelStream">CamelStream</link>*        camel_stream_mem_new_with_buffer    (const <link linkend="char">char</link> *buffer,
96
96
                                                         <link linkend="size-t">size_t</link> len);</programlisting>
97
97
<para>
98
98
Create a new memory stream using <parameter>buffer</parameter> as the stream data.
102
102
for use as the stream backing. This may have resource implications
103
103
you may wish to consider.</para>
104
104
<para>
 
105
 
105
106
</para><variablelist role="params">
106
 
<varlistentry><term><parameter>buffer</parameter>&#160;:</term>
 
107
<varlistentry><term><parameter>buffer</parameter>&nbsp;:</term>
107
108
<listitem><simpara> a memory buffer to use as the stream data
108
109
</simpara></listitem></varlistentry>
109
 
<varlistentry><term><parameter>len</parameter>&#160;:</term>
 
110
<varlistentry><term><parameter>len</parameter>&nbsp;:</term>
110
111
<listitem><simpara> length of <parameter>buffer</parameter>
111
112
</simpara></listitem></varlistentry>
112
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a new <link linkend="CamelStreamMem"><type>CamelStreamMem</type></link>
 
113
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a new <link linkend="CamelStreamMem"><type>CamelStreamMem</type></link>
113
114
</simpara></listitem></varlistentry>
114
115
</variablelist></refsect2>
115
116
<refsect2 id="camel-stream-mem-set-secure" role="function">
116
117
<title>camel_stream_mem_set_secure ()</title>
117
 
<indexterm zone="camel-stream-mem-set-secure"><primary>camel_stream_mem_set_secure</primary></indexterm>
118
 
<programlisting><link linkend="void">void</link>                camel_stream_mem_set_secure         (<link linkend="CamelStreamMem">CamelStreamMem</link> *mem);</programlisting>
 
118
<indexterm zone="camel-stream-mem-set-secure"><primary>camel_stream_mem_set_secure</primary></indexterm><programlisting><link linkend="void">void</link>                camel_stream_mem_set_secure         (<link linkend="CamelStreamMem">CamelStreamMem</link> *mem);</programlisting>
119
119
<para>
120
120
Mark the memory stream as secure.  At the very least this means the
121
121
data in the buffer will be cleared when the buffer is finalised.
122
122
This only applies to buffers owned by the stream.</para>
123
123
<para>
 
124
 
124
125
</para><variablelist role="params">
125
 
<varlistentry><term><parameter>mem</parameter>&#160;:</term>
 
126
<varlistentry><term><parameter>mem</parameter>&nbsp;:</term>
126
127
<listitem><simpara> a <link linkend="CamelStreamMem"><type>CamelStreamMem</type></link> object
127
128
</simpara></listitem></varlistentry>
128
129
</variablelist></refsect2>
129
130
<refsect2 id="camel-stream-mem-set-byte-array" role="function">
130
131
<title>camel_stream_mem_set_byte_array ()</title>
131
 
<indexterm zone="camel-stream-mem-set-byte-array"><primary>camel_stream_mem_set_byte_array</primary></indexterm>
132
 
<programlisting><link linkend="void">void</link>                camel_stream_mem_set_byte_array     (<link linkend="CamelStreamMem">CamelStreamMem</link> *mem,
 
132
<indexterm zone="camel-stream-mem-set-byte-array"><primary>camel_stream_mem_set_byte_array</primary></indexterm><programlisting><link linkend="void">void</link>                camel_stream_mem_set_byte_array     (<link linkend="CamelStreamMem">CamelStreamMem</link> *mem,
133
133
                                                         <link linkend="GByteArray">GByteArray</link> *buffer);</programlisting>
134
134
<para>
135
135
Set <parameter>buffer</parameter> to be the backing data to the existing <link linkend="CamelStreamMem"><type>CamelStreamMem</type></link>, <parameter>mem</parameter>.
138
138
Note: <parameter>mem</parameter> will not take ownership of <parameter>buffer</parameter> and so will need to
139
139
be freed separately from <parameter>mem</parameter>.</para>
140
140
<para>
 
141
 
141
142
</para><variablelist role="params">
142
 
<varlistentry><term><parameter>mem</parameter>&#160;:</term>
 
143
<varlistentry><term><parameter>mem</parameter>&nbsp;:</term>
143
144
<listitem><simpara> a <link linkend="CamelStreamMem"><type>CamelStreamMem</type></link> object
144
145
</simpara></listitem></varlistentry>
145
 
<varlistentry><term><parameter>buffer</parameter>&#160;:</term>
 
146
<varlistentry><term><parameter>buffer</parameter>&nbsp;:</term>
146
147
<listitem><simpara> a <link linkend="GByteArray"><type>GByteArray</type></link>
147
148
</simpara></listitem></varlistentry>
148
149
</variablelist></refsect2>
149
150
<refsect2 id="camel-stream-mem-set-buffer" role="function">
150
151
<title>camel_stream_mem_set_buffer ()</title>
151
 
<indexterm zone="camel-stream-mem-set-buffer"><primary>camel_stream_mem_set_buffer</primary></indexterm>
152
 
<programlisting><link linkend="void">void</link>                camel_stream_mem_set_buffer         (<link linkend="CamelStreamMem">CamelStreamMem</link> *mem,
 
152
<indexterm zone="camel-stream-mem-set-buffer"><primary>camel_stream_mem_set_buffer</primary></indexterm><programlisting><link linkend="void">void</link>                camel_stream_mem_set_buffer         (<link linkend="CamelStreamMem">CamelStreamMem</link> *mem,
153
153
                                                         const <link linkend="char">char</link> *buffer,
154
154
                                                         <link linkend="size-t">size_t</link> len);</programlisting>
155
155
<para>
159
159
Note: <parameter>buffer</parameter> will be copied into an internal <link linkend="GByteArray"><type>GByteArray</type></link> structure
160
160
and so may have resource implications to consider.</para>
161
161
<para>
 
162
 
162
163
</para><variablelist role="params">
163
 
<varlistentry><term><parameter>mem</parameter>&#160;:</term>
 
164
<varlistentry><term><parameter>mem</parameter>&nbsp;:</term>
164
165
<listitem><simpara> a <link linkend="CamelStreamMem"><type>CamelStreamMem</type></link> object
165
166
</simpara></listitem></varlistentry>
166
 
<varlistentry><term><parameter>buffer</parameter>&#160;:</term>
 
167
<varlistentry><term><parameter>buffer</parameter>&nbsp;:</term>
167
168
<listitem><simpara> a memory buffer
168
169
</simpara></listitem></varlistentry>
169
 
<varlistentry><term><parameter>len</parameter>&#160;:</term>
 
170
<varlistentry><term><parameter>len</parameter>&nbsp;:</term>
170
171
<listitem><simpara> length of <parameter>buffer</parameter>
171
172
</simpara></listitem></varlistentry>
172
173
</variablelist></refsect2>