<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>glibmm: Gio::UnixInputStream Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="namespaceGio.html">Gio</a>::<a class="el" href="classGio_1_1UnixInputStream.html">UnixInputStream</a>
</div>
</div>
<div class="contents">
<h1>Gio::UnixInputStream Class Reference<br/>
<small>
[<a class="el" href="group__Streams.html">Stream Classes</a>]</small>
</h1><!-- doxytag: class="Gio::UnixInputStream" --><!-- doxytag: inherits="Gio::InputStream" -->
<p><a class="el" href="classGio_1_1UnixInputStream.html" title="UnixInputStream implements InputStream for reading from a unix file descriptor, including...">UnixInputStream</a> implements <a class="el" href="classGio_1_1InputStream.html" title="Base class for implementing streaming input.">InputStream</a> for reading from a unix file descriptor, including asynchronous operations. <a href="#_details">More...</a></p>
<p>Inherits <a class="el" href="classGio_1_1InputStream.html">Gio::InputStream</a>.</p>
<div class="dynheader">
Collaboration diagram for Gio::UnixInputStream:</div>
<div class="dynsection">
<div class="center"><img src="classGio_1_1UnixInputStream__coll__graph.png" border="0" usemap="#Gio_1_1UnixInputStream_coll__map" alt="Collaboration graph"/></div>
<map name="Gio_1_1UnixInputStream_coll__map" id="Gio_1_1UnixInputStream_coll__map">
<area shape="rect" href="classGio_1_1InputStream.html" title="Base class for implementing streaming input." alt="" coords="19,237,139,267"/><area shape="rect" href="classGlib_1_1Object.html" title="Glib::Object" alt="" coords="33,160,124,189"/><area shape="rect" href="classGlib_1_1ObjectBase.html" title="Glib::ObjectBase is a common base class for Objects and Interfaces." alt="" coords="19,83,139,112"/><area shape="rect" href="../../../libsigc++-2.0/reference/html/structsigc_1_1trackable.html" title="sigc::trackable" alt="" coords="25,5,132,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classGio_1_1UnixInputStream-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1UnixInputStream.html#a21a51896fece91ec2034dea1a47f659b">~UnixInputStream</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">GUnixInputStream* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1UnixInputStream.html#aa0b863b654d38a9e10f7d7d49b82c5ea">gobj</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#aa0b863b654d38a9e10f7d7d49b82c5ea"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const GUnixInputStream* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1UnixInputStream.html#adc7b87c43606f90378a521df99220971">gobj</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#adc7b87c43606f90378a521df99220971"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">GUnixInputStream* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1UnixInputStream.html#a5f05de3f98b2dd8e7f0f2c5038fbc69f">gobj_copy</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. <a href="#a5f05de3f98b2dd8e7f0f2c5038fbc69f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1UnixInputStream.html#a86e845ad209749c3358634a58be66023">set_close_fd</a> (bool close_fd=true)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets whether the file descriptor of <em>stream</em> shall be closed when the stream is closed. <a href="#a86e845ad209749c3358634a58be66023"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1UnixInputStream.html#a110e2c9201e53065f2140053ebb442c5">get_close_fd</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return value: <code>true</code> if the file descriptor is closed when done. <a href="#a110e2c9201e53065f2140053ebb442c5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1UnixInputStream.html#a6bf398ce16adca31b594e0f4fad40a76">get_fd</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the UNIX file descriptor that the stream reads from. <a href="#a6bf398ce16adca31b594e0f4fad40a76"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classGlib_1_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a>< int > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1UnixInputStream.html#a9fc70aa3eb7e8b9848bf0995351d51be">property_fd</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The file descriptor to read from. <a href="#a9fc70aa3eb7e8b9848bf0995351d51be"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classGlib_1_1PropertyProxy.html">Glib::PropertyProxy</a>< bool > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1UnixInputStream.html#a1dd943a8606e68c30916b50f9c495d0b">property_close_fd</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Whether to close the file descriptor when the stream is closed. <a href="#a1dd943a8606e68c30916b50f9c495d0b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classGlib_1_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a><br class="typebreak"/>
< bool > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1UnixInputStream.html#a136c4f6529c203b8aa613ebd9ac027af">property_close_fd</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Whether to close the file descriptor when the stream is closed. <a href="#a136c4f6529c203b8aa613ebd9ac027af"></a><br/></td></tr>
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><br class="typebreak"/>
< <a class="el" href="classGio_1_1UnixInputStream.html">UnixInputStream</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1UnixInputStream.html#a70e7a49b38c8b8b93c47635cb3a193b8">create</a> (int fd, bool close_fd_at_close)</td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1UnixInputStream.html#a0238ab9e774980521c79ec866352a429">UnixInputStream</a> (int fd, bool close_fd_at_close)</td></tr>
<tr><td colspan="2"><h2>Related Functions</h2></td></tr>
<tr><td colspan="2"><p>(Note that these are not member functions.) </p>
<br/><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><br class="typebreak"/>
< <a class="el" href="classGio_1_1UnixInputStream.html">Gio::UnixInputStream</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1UnixInputStream.html#a631c2896887d90e8fa13ac8132c9f5db">wrap</a> (GUnixInputStream* object, bool take_copy=false)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A <a class="el" href="namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. <a href="#a631c2896887d90e8fa13ac8132c9f5db"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p><a class="el" href="classGio_1_1UnixInputStream.html" title="UnixInputStream implements InputStream for reading from a unix file descriptor, including...">UnixInputStream</a> implements <a class="el" href="classGio_1_1InputStream.html" title="Base class for implementing streaming input.">InputStream</a> for reading from a unix file descriptor, including asynchronous operations. </p>
<p>The file descriptor must be selectable, so it doesn't work with opened files.</p>
<dl class="since_2_16"><dt><b><a class="el" href="since_2_16.html#_since_2_16000047">Since glibmm 2.16:</a></b></dt><dd></dd></dl>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a21a51896fece91ec2034dea1a47f659b"></a><!-- doxytag: member="Gio::UnixInputStream::~UnixInputStream" ref="a21a51896fece91ec2034dea1a47f659b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual Gio::UnixInputStream::~UnixInputStream </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a0238ab9e774980521c79ec866352a429"></a><!-- doxytag: member="Gio::UnixInputStream::UnixInputStream" ref="a0238ab9e774980521c79ec866352a429" args="(int fd, bool close_fd_at_close)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Gio::UnixInputStream::UnixInputStream </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>fd</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>close_fd_at_close</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [explicit, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a70e7a49b38c8b8b93c47635cb3a193b8"></a><!-- doxytag: member="Gio::UnixInputStream::create" ref="a70e7a49b38c8b8b93c47635cb3a193b8" args="(int fd, bool close_fd_at_close)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGio_1_1UnixInputStream.html">UnixInputStream</a>> Gio::UnixInputStream::create </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>fd</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>close_fd_at_close</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a110e2c9201e53065f2140053ebb442c5"></a><!-- doxytag: member="Gio::UnixInputStream::get_close_fd" ref="a110e2c9201e53065f2140053ebb442c5" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Gio::UnixInputStream::get_close_fd </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return value: <code>true</code> if the file descriptor is closed when done. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if the file descriptor is closed when done</dd></dl>
<dl class="since_2_20"><dt><b><a class="el" href="since_2_20.html#_since_2_20000016">Since glibmm 2.20:</a></b></dt><dd></dd></dl>
</div>
</div>
<a class="anchor" id="a6bf398ce16adca31b594e0f4fad40a76"></a><!-- doxytag: member="Gio::UnixInputStream::get_fd" ref="a6bf398ce16adca31b594e0f4fad40a76" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Gio::UnixInputStream::get_fd </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the UNIX file descriptor that the stream reads from. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The file descriptor of <em>stream</em> </dd></dl>
<dl class="since_2_20"><dt><b><a class="el" href="since_2_20.html#_since_2_20000017">Since glibmm 2.20:</a></b></dt><dd></dd></dl>
</div>
</div>
<a class="anchor" id="adc7b87c43606f90378a521df99220971"></a><!-- doxytag: member="Gio::UnixInputStream::gobj" ref="adc7b87c43606f90378a521df99220971" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const GUnixInputStream* Gio::UnixInputStream::gobj </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Provides access to the underlying C GObject. </p>
<p>Reimplemented from <a class="el" href="classGio_1_1InputStream.html#a1b0ef82ab81b3ded607584c7029fe1e9">Gio::InputStream</a>.</p>
</div>
</div>
<a class="anchor" id="aa0b863b654d38a9e10f7d7d49b82c5ea"></a><!-- doxytag: member="Gio::UnixInputStream::gobj" ref="aa0b863b654d38a9e10f7d7d49b82c5ea" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GUnixInputStream* Gio::UnixInputStream::gobj </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Provides access to the underlying C GObject. </p>
<p>Reimplemented from <a class="el" href="classGio_1_1InputStream.html#a2ed1120b3d03a12086e7f0ed3946aba1">Gio::InputStream</a>.</p>
</div>
</div>
<a class="anchor" id="a5f05de3f98b2dd8e7f0f2c5038fbc69f"></a><!-- doxytag: member="Gio::UnixInputStream::gobj_copy" ref="a5f05de3f98b2dd8e7f0f2c5038fbc69f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GUnixInputStream* Gio::UnixInputStream::gobj_copy </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. </p>
<p>Reimplemented from <a class="el" href="classGio_1_1InputStream.html#a28a9394b07e9183c0c79798ea344c65c">Gio::InputStream</a>.</p>
</div>
</div>
<a class="anchor" id="a136c4f6529c203b8aa613ebd9ac027af"></a><!-- doxytag: member="Gio::UnixInputStream::property_close_fd" ref="a136c4f6529c203b8aa613ebd9ac027af" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classGlib_1_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a><bool> Gio::UnixInputStream::property_close_fd </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Whether to close the file descriptor when the stream is closed. </p>
<p>You rarely need to use properties because there are get_ and set_ methods for almost all of them. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes. </dd></dl>
</div>
</div>
<a class="anchor" id="a1dd943a8606e68c30916b50f9c495d0b"></a><!-- doxytag: member="Gio::UnixInputStream::property_close_fd" ref="a1dd943a8606e68c30916b50f9c495d0b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classGlib_1_1PropertyProxy.html">Glib::PropertyProxy</a><bool> Gio::UnixInputStream::property_close_fd </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Whether to close the file descriptor when the stream is closed. </p>
<p>You rarely need to use properties because there are get_ and set_ methods for almost all of them. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes. </dd></dl>
</div>
</div>
<a class="anchor" id="a9fc70aa3eb7e8b9848bf0995351d51be"></a><!-- doxytag: member="Gio::UnixInputStream::property_fd" ref="a9fc70aa3eb7e8b9848bf0995351d51be" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classGlib_1_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a><int> Gio::UnixInputStream::property_fd </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The file descriptor to read from. </p>
<p>You rarely need to use properties because there are get_ and set_ methods for almost all of them. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes. </dd></dl>
</div>
</div>
<a class="anchor" id="a86e845ad209749c3358634a58be66023"></a><!-- doxytag: member="Gio::UnixInputStream::set_close_fd" ref="a86e845ad209749c3358634a58be66023" args="(bool close_fd=true)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gio::UnixInputStream::set_close_fd </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>close_fd</em> = <code>true</code></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets whether the file descriptor of <em>stream</em> shall be closed when the stream is closed. </p>
<dl class="since_2_20"><dt><b><a class="el" href="since_2_20.html#_since_2_20000015">Since glibmm 2.20:</a></b></dt><dd></dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>close_fd</em> </td><td><code>true</code> to close the file descriptor when done. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="a631c2896887d90e8fa13ac8132c9f5db"></a><!-- doxytag: member="Gio::UnixInputStream::wrap" ref="a631c2896887d90e8fa13ac8132c9f5db" args="(GUnixInputStream *object, bool take_copy=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGio_1_1UnixInputStream.html">Gio::UnixInputStream</a> > wrap </td>
<td>(</td>
<td class="paramtype">GUnixInputStream * </td>
<td class="paramname"> <em>object</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>take_copy</em> = <code>false</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [related]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A <a class="el" href="namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>object</em> </td><td>The C instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>take_copy</em> </td><td>False if the result should take ownership of the C instance. True if it should take a new copy or ref. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A C++ instance that wraps this C instance. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>giomm/unixinputstream.h</li>
</ul>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on Mon Sep 21 11:07:24 2009 for glibmm by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>
