docs/reference/html/GMimeStreamPipe.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <title>GMimeStreamPipe</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="index.html" title="GMime 2.6 Reference Manual">
   8 <link rel="up" href="Streams.html" title="Streams">
   9 <link rel="prev" href="GMimeStreamBuffer.html" title="GMimeStreamBuffer">
  10 <link rel="next" href="GMimeStreamCat.html" title="GMimeStreamCat">
  11 <meta name="generator" content="GTK-Doc V1.18 (XML mode)">
  12 <link rel="stylesheet" href="style.css" type="text/css">
  13 </head>
  14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
  16 <tr valign="middle">
  17 <td><a accesskey="p" href="GMimeStreamBuffer.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="Streams.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
  19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
  20 <th width="100%" align="center">GMime 2.6 Reference Manual</th>
  21 <td><a accesskey="n" href="GMimeStreamCat.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
  22 </tr>
  23 <tr><td colspan="5" class="shortcuts">
  24 <a href="#GMimeStreamPipe.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#GMimeStreamPipe.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#GMimeStreamPipe.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29 </td></tr>
  30 </table>
  31 <div class="refentry">
  32 <a name="GMimeStreamPipe"></a><div class="titlepage"></div>
  33 <div class="refnamediv"><table width="100%"><tr>
  34 <td valign="top">
  35 <h2><span class="refentrytitle"><a name="GMimeStreamPipe.top_of_page"></a>GMimeStreamPipe</span></h2>
  36 <p>GMimeStreamPipe — A low-level pipe stream</p>
  37 </td>
  38 <td valign="top" align="right"></td>
  39 </tr></table></div>
  40 <div class="refsynopsisdiv">
  41 <a name="GMimeStreamPipe.synopsis"></a><h2>Synopsis</h2>
  42 <pre class="synopsis">struct              <a class="link" href="GMimeStreamPipe.html#GMimeStreamPipe-struct" title="struct GMimeStreamPipe">GMimeStreamPipe</a>;
  43 <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="returnvalue">GMimeStream</span></a> *       <a class="link" href="GMimeStreamPipe.html#g-mime-stream-pipe-new" title="g_mime_stream_pipe_new ()">g_mime_stream_pipe_new</a>              (<em class="parameter"><code><span class="type">int</span> fd</code></em>);
  44 <span class="returnvalue">gboolean</span>            <a class="link" href="GMimeStreamPipe.html#g-mime-stream-pipe-get-owner" title="g_mime_stream_pipe_get_owner ()">g_mime_stream_pipe_get_owner</a>        (<em class="parameter"><code><a class="link" href="GMimeStreamPipe.html" title="GMimeStreamPipe"><span class="type">GMimeStreamPipe</span></a> *stream</code></em>);
  45 <span class="returnvalue">void</span>                <a class="link" href="GMimeStreamPipe.html#g-mime-stream-pipe-set-owner" title="g_mime_stream_pipe_set_owner ()">g_mime_stream_pipe_set_owner</a>        (<em class="parameter"><code><a class="link" href="GMimeStreamPipe.html" title="GMimeStreamPipe"><span class="type">GMimeStreamPipe</span></a> *stream</code></em>,
  46                                                          <em class="parameter"><code><span class="type">gboolean</span> owner</code></em>);
  47 </pre>
  48 </div>
  49 <div class="refsect1">
  50 <a name="GMimeStreamPipe.object-hierarchy"></a><h2>Object Hierarchy</h2>
  51 <pre class="synopsis">
  52   GObject
  53    +----<a class="link" href="GMimeStream.html" title="GMimeStream">GMimeStream</a>
  54          +----GMimeStreamPipe
  55 </pre>
  56 </div>
  57 <div class="refsect1">
  58 <a name="GMimeStreamPipe.description"></a><h2>Description</h2>
  59 <p>
  60 A simple <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> implementation that sits on top of low-level
  61 POSIX pipes.
  62 </p>
  63 </div>
  64 <div class="refsect1">
  65 <a name="GMimeStreamPipe.details"></a><h2>Details</h2>
  66 <div class="refsect2">
  67 <a name="GMimeStreamPipe-struct"></a><h3>struct GMimeStreamPipe</h3>
  68 <pre class="programlisting">struct GMimeStreamPipe;</pre>
  69 <p>
  70 A <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> wrapper around pipes.
  71 </p>
  72 <div class="variablelist"><table border="0">
  73 <col align="left" valign="top">
  74 <tbody></tbody>
  75 </table></div>
  76 </div>
  77 <hr>
  78 <div class="refsect2">
  79 <a name="g-mime-stream-pipe-new"></a><h3>g_mime_stream_pipe_new ()</h3>
  80 <pre class="programlisting"><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="returnvalue">GMimeStream</span></a> *       g_mime_stream_pipe_new              (<em class="parameter"><code><span class="type">int</span> fd</code></em>);</pre>
  81 <p>
  82 Creates a new <a class="link" href="GMimeStreamPipe.html" title="GMimeStreamPipe"><span class="type">GMimeStreamPipe</span></a> object around <em class="parameter"><code>fd</code></em>.
  83 </p>
  84 <div class="variablelist"><table border="0">
  85 <col align="left" valign="top">
  86 <tbody>
  87 <tr>
  88 <td><p><span class="term"><em class="parameter"><code>fd</code></em> :</span></p></td>
  89 <td>a pipe descriptor</td>
  90 </tr>
  91 <tr>
  92 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
  93 <td>a stream using <em class="parameter"><code>fd</code></em>.</td>
  94 </tr>
  95 </tbody>
  96 </table></div>
  97 </div>
  98 <hr>
  99 <div class="refsect2">
 100 <a name="g-mime-stream-pipe-get-owner"></a><h3>g_mime_stream_pipe_get_owner ()</h3>
 101 <pre class="programlisting"><span class="returnvalue">gboolean</span>            g_mime_stream_pipe_get_owner        (<em class="parameter"><code><a class="link" href="GMimeStreamPipe.html" title="GMimeStreamPipe"><span class="type">GMimeStreamPipe</span></a> *stream</code></em>);</pre>
 102 <p>
 103 Gets whether or not <em class="parameter"><code>stream</code></em> owns the backend pipe descriptor.
 104 </p>
 105 <div class="variablelist"><table border="0">
 106 <col align="left" valign="top">
 107 <tbody>
 108 <tr>
 109 <td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td>
 110 <td>a <a class="link" href="GMimeStreamPipe.html" title="GMimeStreamPipe"><span class="type">GMimeStreamPipe</span></a>
 111 </td>
 112 </tr>
 113 <tr>
 114 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 115 <td>
 116 <code class="literal">TRUE</code> if <em class="parameter"><code>stream</code></em> owns the backend pipe descriptor or <code class="literal">FALSE</code>
 117 otherwise.</td>
 118 </tr>
 119 </tbody>
 120 </table></div>
 121 </div>
 122 <hr>
 123 <div class="refsect2">
 124 <a name="g-mime-stream-pipe-set-owner"></a><h3>g_mime_stream_pipe_set_owner ()</h3>
 125 <pre class="programlisting"><span class="returnvalue">void</span>                g_mime_stream_pipe_set_owner        (<em class="parameter"><code><a class="link" href="GMimeStreamPipe.html" title="GMimeStreamPipe"><span class="type">GMimeStreamPipe</span></a> *stream</code></em>,
 126                                                          <em class="parameter"><code><span class="type">gboolean</span> owner</code></em>);</pre>
 127 <p>
 128 Sets whether or not <em class="parameter"><code>stream</code></em> owns the backend pipe descriptor.
 129 </p>
 130 <p>
 131 Note: <em class="parameter"><code>owner</code></em> should be <code class="literal">TRUE</code> if the stream should <code class="function">close()</code> the
 132 backend pipe descriptor when destroyed or <code class="literal">FALSE</code> otherwise.
 133 </p>
 134 <div class="variablelist"><table border="0">
 135 <col align="left" valign="top">
 136 <tbody>
 137 <tr>
 138 <td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td>
 139 <td>a <a class="link" href="GMimeStreamPipe.html" title="GMimeStreamPipe"><span class="type">GMimeStreamPipe</span></a>
 140 </td>
 141 </tr>
 142 <tr>
 143 <td><p><span class="term"><em class="parameter"><code>owner</code></em> :</span></p></td>
 144 <td>owner</td>
 145 </tr>
 146 </tbody>
 147 </table></div>
 148 </div>
 149 </div>
 150 <div class="refsect1">
 151 <a name="GMimeStreamPipe.see-also"></a><h2>See Also</h2>
 152 <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a>
 153 </div>
 154 </div>
 155 <div class="footer">
 156 <hr>
 157           Generated by GTK-Doc V1.18</div>
 158 </body>
 159 </html>