File: gsf-memory.html

package info (click to toggle)
libgsf 1.11.1-1sarge1
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 3,588 kB
  • ctags: 1,947
  • sloc: ansic: 12,552; sh: 8,448; xml: 5,456; makefile: 371
file content (114 lines) | stat: -rw-r--r-- 14,639 bytes parent folder | download
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
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>memory</title><meta name="generator" content="DocBook XSL Stylesheets V1.66.1"><link rel="start" href="index.html" title="GSF Reference Manual"><link rel="up" href="sources.html" title="Stream Sources"><link rel="prev" href="gsf-Reading-and-Writing-from-local-files-and-directories.html" title="Reading and Writing from local files and directories"><link rel="next" href="gsf-GIOChannel.html" title="GIOChannel"><meta name="generator" content="GTK-Doc V1.2 (XML mode)"><link rel="stylesheet" href="style.css" type="text/css"><link rel="part" href="into.html" title="PartI.GSF Overview"><link rel="part" href="api.html" title="PartII.API Reference"><link rel="chapter" href="io.html" title="Basic Input/Output"><link rel="chapter" href="sources.html" title="Stream Sources"><link rel="chapter" href="parsers.html" title="Stream Parsers"><link rel="chapter" href="misc.html" title="Miscellaneous"><link rel="index" href="ix01.html" title="Index"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"><td><a accesskey="p" href="gsf-Reading-and-Writing-from-local-files-and-directories.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td><td><a accesskey="u" href="sources.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td><td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td><th width="100%" align="center">GSF Reference Manual</th><td><a accesskey="n" href="gsf-GIOChannel.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td></tr></table><div class="refentry" lang="en"><a name="gsf-memory"></a><div class="titlepage"></div><div class="refnamediv"><table width="100%"><tr><td valign="top"><h2><span class="refentrytitle">memory</span></h2><p>memory &#8212; </p></td><td valign="top" align="right"></td></tr></table></div><div class="refsynopsisdiv"><h2>Synopsis</h2><a name="GsfInputMemory"></a><a name="GsfOutputMemory"></a><a name="GsfSharedMemory"></a><pre class="synopsis">



            <a href="gsf-memory.html#GsfInputMemory-struct">GsfInputMemory</a>;
<a href="gsf-Input-from-unstructured-files.html#GsfInput">GsfInput</a>*   <a href="gsf-memory.html#gsf-input-mmap-new">gsf_input_mmap_new</a>              (char const *filename,
                                             GError **err);
<a href="gsf-Input-from-unstructured-files.html#GsfInput">GsfInput</a>*   <a href="gsf-memory.html#gsf-input-memory-new">gsf_input_memory_new</a>            (guint8 const *buf,
                                             <a href="gsf-utils.html#gsf-off-t">gsf_off_t</a> length,
                                             gboolean needs_free);
<a href="gsf-Input-from-unstructured-files.html#GsfInput">GsfInput</a>*   <a href="gsf-memory.html#gsf-input-memory-new-clone">gsf_input_memory_new_clone</a>      (guint8 const *buf,
                                             <a href="gsf-utils.html#gsf-off-t">gsf_off_t</a> length);
<a href="gsf-Input-from-unstructured-files.html#GsfInput">GsfInput</a>*   <a href="gsf-memory.html#gsf-input-memory-new-from-iochannel">gsf_input_memory_new_from_iochannel</a>
                                            (GIOChannel *channel,
                                             GError **error);
            <a href="gsf-memory.html#GsfOutputMemory-struct">GsfOutputMemory</a>;
const guint8* <a href="gsf-memory.html#gsf-output-memory-get-bytes">gsf_output_memory_get_bytes</a>   (<a href="gsf-memory.html#GsfOutputMemory">GsfOutputMemory</a> *mem);
GType       <a href="gsf-memory.html#gsf-output-memory-get-type">gsf_output_memory_get_type</a>      (void);
<a href="gsf-Output-to-unstructured-files.html#GsfOutput">GsfOutput</a>*  <a href="gsf-memory.html#gsf-output-memory-new">gsf_output_memory_new</a>           (void);
            <a href="gsf-memory.html#GsfSharedMemory-struct">GsfSharedMemory</a>;
<a href="gsf-memory.html#GsfSharedMemory">GsfSharedMemory</a>* <a href="gsf-memory.html#gsf-shared-memory-new">gsf_shared_memory_new</a>      (void *buf,
                                             <a href="gsf-utils.html#gsf-off-t">gsf_off_t</a> size,
                                             gboolean needs_free);
<a href="gsf-memory.html#GsfSharedMemory">GsfSharedMemory</a>* <a href="gsf-memory.html#gsf-shared-memory-mmapped-new">gsf_shared_memory_mmapped_new</a>
                                            (void *buf,
                                             <a href="gsf-utils.html#gsf-off-t">gsf_off_t</a> size);

</pre></div><div class="refsect1" lang="en"><a name="id2538341"></a><h2>Object Hierarchy</h2><pre class="synopsis">

  GObject
   +----<a href="gsf-Input-from-unstructured-files.html#GsfInput">GsfInput</a>
         +----GsfInputMemory
</pre><pre class="synopsis">

  GObject
   +----<a href="gsf-Output-to-unstructured-files.html#GsfOutput">GsfOutput</a>
         +----GsfOutputMemory
</pre><pre class="synopsis">

  GObject
   +----GsfSharedMemory
</pre></div><div class="refsect1" lang="en"><a name="id2538401"></a><h2>Description</h2><p>

</p></div><div class="refsect1" lang="en"><a name="id2538410"></a><h2>Details</h2><div class="refsect2" lang="en"><a name="id2538416"></a><h3><a name="GsfInputMemory-struct"></a>GsfInputMemory</h3><a class="indexterm" name="id2538428"></a><pre class="programlisting">typedef struct _GsfInputMemory GsfInputMemory;</pre><p>

</p></div><hr><div class="refsect2" lang="en"><a name="id2538444"></a><h3><a name="gsf-input-mmap-new"></a>gsf_input_mmap_new ()</h3><a class="indexterm" name="id2538454"></a><pre class="programlisting"><a href="gsf-Input-from-unstructured-files.html#GsfInput">GsfInput</a>*   gsf_input_mmap_new              (char const *filename,
                                             GError **err);</pre><p>
</p><p>

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>filename</tt></i>:</span></td><td> The file on disk that you want to mmap
</td></tr><tr><td><span class="term"><i class="parameter"><tt>err</tt></i>:</span></td><td> A <span class="type">GError</span>, or optionally <tt class="literal">null</tt>
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td> A new <a href="gsf-memory.html#GsfInputMemory"><span class="type">GsfInputMemory</span></a>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2538557"></a><h3><a name="gsf-input-memory-new"></a>gsf_input_memory_new ()</h3><a class="indexterm" name="id2538568"></a><pre class="programlisting"><a href="gsf-Input-from-unstructured-files.html#GsfInput">GsfInput</a>*   gsf_input_memory_new            (guint8 const *buf,
                                             <a href="gsf-utils.html#gsf-off-t">gsf_off_t</a> length,
                                             gboolean needs_free);</pre><p>
</p><p>

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>buf</tt></i>:</span></td><td> The input bytes
</td></tr><tr><td><span class="term"><i class="parameter"><tt>length</tt></i>:</span></td><td> The length of <i class="parameter"><tt>buf</tt></i>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>needs_free</tt></i>:</span></td><td> Whether you want this memory to be free'd at object destruction
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td> A new <a href="gsf-memory.html#GsfInputMemory"><span class="type">GsfInputMemory</span></a>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2538686"></a><h3><a name="gsf-input-memory-new-clone"></a>gsf_input_memory_new_clone ()</h3><a class="indexterm" name="id2538698"></a><pre class="programlisting"><a href="gsf-Input-from-unstructured-files.html#GsfInput">GsfInput</a>*   gsf_input_memory_new_clone      (guint8 const *buf,
                                             <a href="gsf-utils.html#gsf-off-t">gsf_off_t</a> length);</pre><p>
</p><p>

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>buf</tt></i>:</span></td><td> The input bytes
</td></tr><tr><td><span class="term"><i class="parameter"><tt>length</tt></i>:</span></td><td> The length of <i class="parameter"><tt>buf</tt></i>
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td> A new <a href="gsf-memory.html#GsfInputMemory"><span class="type">GsfInputMemory</span></a>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2538792"></a><h3><a name="gsf-input-memory-new-from-iochannel"></a>gsf_input_memory_new_from_iochannel ()</h3><a class="indexterm" name="id2538805"></a><pre class="programlisting"><a href="gsf-Input-from-unstructured-files.html#GsfInput">GsfInput</a>*   gsf_input_memory_new_from_iochannel
                                            (GIOChannel *channel,
                                             GError **error);</pre><p>
</p><p>

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>channel</tt></i>:</span></td><td> a <span class="type">GIOChannel</span>.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>error</tt></i>:</span></td><td> a <span class="type">GError</span>
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>a new <a href="gsf-memory.html#GsfInputMemory"><span class="type">GsfInputMemory</span></a> or NULL.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2538910"></a><h3><a name="GsfOutputMemory-struct"></a>GsfOutputMemory</h3><a class="indexterm" name="id2538921"></a><pre class="programlisting">typedef struct _GsfOutputMemory GsfOutputMemory;</pre><p>

</p></div><hr><div class="refsect2" lang="en"><a name="id2538937"></a><h3><a name="gsf-output-memory-get-bytes"></a>gsf_output_memory_get_bytes ()</h3><a class="indexterm" name="id2538948"></a><pre class="programlisting">const guint8* gsf_output_memory_get_bytes   (<a href="gsf-memory.html#GsfOutputMemory">GsfOutputMemory</a> *mem);</pre><p>
</p><p>

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>mem</tt></i>:</span></td><td> the output device.
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td> The data that has been written to <i class="parameter"><tt>mem</tt></i>, or <tt class="literal">null</tt>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2539021"></a><h3><a name="gsf-output-memory-get-type"></a>gsf_output_memory_get_type ()</h3><a class="indexterm" name="id2539033"></a><pre class="programlisting">GType       gsf_output_memory_get_type      (void);</pre><p>

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>


</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2539069"></a><h3><a name="gsf-output-memory-new"></a>gsf_output_memory_new ()</h3><a class="indexterm" name="id2539080"></a><pre class="programlisting"><a href="gsf-Output-to-unstructured-files.html#GsfOutput">GsfOutput</a>*  gsf_output_memory_new           (void);</pre><p>
</p><p>

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>a new file or NULL.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2539119"></a><h3><a name="GsfSharedMemory-struct"></a>GsfSharedMemory</h3><a class="indexterm" name="id2539131"></a><pre class="programlisting">typedef struct _GsfSharedMemory GsfSharedMemory;</pre><p>

</p></div><hr><div class="refsect2" lang="en"><a name="id2539146"></a><h3><a name="gsf-shared-memory-new"></a>gsf_shared_memory_new ()</h3><a class="indexterm" name="id2539157"></a><pre class="programlisting"><a href="gsf-memory.html#GsfSharedMemory">GsfSharedMemory</a>* gsf_shared_memory_new      (void *buf,
                                             <a href="gsf-utils.html#gsf-off-t">gsf_off_t</a> size,
                                             gboolean needs_free);</pre><p>

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>buf</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>size</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>needs_free</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>


</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2539256"></a><h3><a name="gsf-shared-memory-mmapped-new"></a>gsf_shared_memory_mmapped_new ()</h3><a class="indexterm" name="id2539268"></a><pre class="programlisting"><a href="gsf-memory.html#GsfSharedMemory">GsfSharedMemory</a>* gsf_shared_memory_mmapped_new
                                            (void *buf,
                                             <a href="gsf-utils.html#gsf-off-t">gsf_off_t</a> size);</pre><p>

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>buf</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>size</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>


</td></tr></tbody></table></div></div></div></div><table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle"><td align="left"><a accesskey="p" href="gsf-Reading-and-Writing-from-local-files-and-directories.html"><b>&lt;&lt;Reading and Writing from local files and directories</b></a></td><td align="right"><a accesskey="n" href="gsf-GIOChannel.html"><b>GIOChannel&gt;&gt;</b></a></td></tr></table></body></html>