<!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::UnixFDList 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.7.2 -->
<div class="navigation" id="top">
<div class="tabs">
<ul class="tablist">
<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="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</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">
<ul>
<li><a class="el" href="namespaceGio.html">Gio</a> </li>
<li><a class="el" href="classGio_1_1UnixFDList.html">UnixFDList</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#related">Related Functions</a> </div>
<div class="headertitle">
<h1>Gio::UnixFDList Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="Gio::UnixFDList" --><!-- doxytag: inherits="Glib::Object" -->
<p><a class="el" href="classGio_1_1UnixFDList.html" title="UnixFDList - An object containing a set of UNIX file descriptors.">UnixFDList</a> - An object containing a set of UNIX file descriptors. <a href="#_details">More...</a></p>
<p><code>#include <giomm/unixfdlist.h></code></p>
<!-- startSectionHeader --><div class="dynheader">
Inheritance diagram for Gio::UnixFDList:<!-- endSectionHeader --></div>
<!-- startSectionSummary --><!-- endSectionSummary --><!-- startSectionContent --><div class="dyncontent">
<div class="center"><img src="classGio_1_1UnixFDList__inherit__graph.png" border="0" usemap="#Gio_1_1UnixFDList_inherit__map" alt="Inheritance graph"/></div>
<map name="Gio_1_1UnixFDList_inherit__map" id="Gio_1_1UnixFDList_inherit__map">
<area shape="rect" id="node2" href="classGlib_1_1Object.html" title="Glib::Object" alt="" coords="21,160,115,189"/><area shape="rect" id="node4" href="classGlib_1_1ObjectBase.html" title="Glib::ObjectBase is a common base class for Objects and Interfaces." alt="" coords="5,83,131,112"/><area shape="rect" id="node6" href="../../../libsigc++-2.0/reference/html/structsigc_1_1trackable.html" title="sigc::trackable" alt="" coords="11,5,125,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center><!-- endSectionContent --></div>
<p><a href="classGio_1_1UnixFDList-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
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_1UnixFDList.html#aede85e064f0dd4c5eb8d3157793cd799">~UnixFDList</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">GUnixFDList* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1UnixFDList.html#a13369401ffc5804f1d08f21f8767efb3">gobj</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#a13369401ffc5804f1d08f21f8767efb3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const GUnixFDList* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1UnixFDList.html#af1eeeaeadc809eba2061eaa6c22d9107">gobj</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#af1eeeaeadc809eba2061eaa6c22d9107"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">GUnixFDList* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1UnixFDList.html#aa584b34d376383010cbf72c999a39442">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="#aa584b34d376383010cbf72c999a39442"></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_1UnixFDList.html#a509aef6d94ac576341436e97073a6cca">get_length</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the length of <em>list</em> (ie: the number of file descriptors contained within). <a href="#a509aef6d94ac576341436e97073a6cca"></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_1UnixFDList.html#abee8d9542776283f7e621fdfcc03badb">get</a> (int index) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets a file descriptor out of <em>list</em>. <a href="#abee8d9542776283f7e621fdfcc03badb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classGlib_1_1ArrayHandle.html">Glib::ArrayHandle</a>< int > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1UnixFDList.html#a3a649024e1da34de1c0659338e7df07c">peek_fds</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the array of file descriptors that is contained in this object. <a href="#a3a649024e1da34de1c0659338e7df07c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classGlib_1_1ArrayHandle.html">Glib::ArrayHandle</a>< int > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1UnixFDList.html#a9167e4e9d3adf8f06405d4928b15b614">steal_fds</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the array of file descriptors that is contained in this object. <a href="#a9167e4e9d3adf8f06405d4928b15b614"></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_1UnixFDList.html#a8e99c050949497a05a6e65e8b2548101">append</a> (int fd)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds a file descriptor to <em>list</em>. <a href="#a8e99c050949497a05a6e65e8b2548101"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
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>< <a class="el" href="classGio_1_1UnixFDList.html">UnixFDList</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1UnixFDList.html#ad8865d446428f2590a7393c54e655307">create</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a new <a class="el" href="classGio_1_1UnixFDList.html" title="UnixFDList - An object containing a set of UNIX file descriptors.">UnixFDList</a> containing no file descriptors. <a href="#ad8865d446428f2590a7393c54e655307"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGio_1_1UnixFDList.html">UnixFDList</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1UnixFDList.html#a7095f1477818fa6cce563e1260933c5c">create</a> (const <a class="el" href="classGlib_1_1ArrayHandle.html">Glib::ArrayHandle</a>< int >& fds)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a new <a class="el" href="classGio_1_1UnixFDList.html" title="UnixFDList - An object containing a set of UNIX file descriptors.">UnixFDList</a> containing the file descriptors given in <em>fds</em>. <a href="#a7095f1477818fa6cce563e1260933c5c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGio_1_1UnixFDList.html">UnixFDList</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1UnixFDList.html#aee6c787908674c69e6d39a859c08b7fb">create</a> (const <a class="el" href="classGlib_1_1ArrayHandle.html">Glib::ArrayHandle</a>< int >& fds, int n_fds)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a new <a class="el" href="classGio_1_1UnixFDList.html" title="UnixFDList - An object containing a set of UNIX file descriptors.">UnixFDList</a> containing the file descriptors given in <em>fds</em>. <a href="#aee6c787908674c69e6d39a859c08b7fb"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
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_1UnixFDList.html#af994190fe054980701789befb81bbbc8">UnixFDList</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1UnixFDList.html#a5b668c1766c02bb0a2661384695942cb">UnixFDList</a> (const <a class="el" href="classGlib_1_1ArrayHandle.html">Glib::ArrayHandle</a>< int >& fds)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1UnixFDList.html#a24759393f0445985fd7ddadbc9acd41d">UnixFDList</a> (const <a class="el" href="classGlib_1_1ArrayHandle.html">Glib::ArrayHandle</a>< int >& fds, int n_fds)</td></tr>
<tr><td colspan="2"><h2><a name="related"></a>
Related Functions</h2></td></tr>
<tr><td colspan="2"><p>(Note that these are not member functions.) </p>
<br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGio_1_1UnixFDList.html">Gio::UnixFDList</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1UnixFDList.html#ac7c943cb9e8b46bfa4f6bae95569b7c7">wrap</a> (GUnixFDList* 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="#ac7c943cb9e8b46bfa4f6bae95569b7c7"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p><a class="el" href="classGio_1_1UnixFDList.html" title="UnixFDList - An object containing a set of UNIX file descriptors.">UnixFDList</a> - An object containing a set of UNIX file descriptors. </p>
<p>A <a class="el" href="classGio_1_1UnixFDList.html" title="UnixFDList - An object containing a set of UNIX file descriptors.">UnixFDList</a> contains a list of file descriptors. It owns the file descriptors that it contains, closing them when finalized.</p>
<p>It may be wrapped in a <a class="el" href="classGio_1_1UnixFDMessage.html" title="UnixFDMessage — A GSocketControlMessage containing a GUnixFDList.">UnixFDMessage</a> and sent over a <a class="el" href="classGio_1_1Socket.html" title="Low-level socket object.">Socket</a> in the G_SOCKET_ADDRESS_UNIX family by using <a class="el" href="classGio_1_1Socket.html#adc5c3145109841e0406150ad0b7f547c" title="Tries to send size bytes from buffer on the socket.">Gio::Socket::send()</a> and received using <a class="el" href="classGio_1_1Socket.html#a742403f4d076ba9050a435d95fea5d1c" title="Receive data (up to size bytes) from a socket.">Gio::Socket::receive()</a>.</p>
<dl class="since_2_28"><dt><b><a class="el" href="since_2_28.html#_since_2_28000129">Since glibmm 2.28:</a></b></dt><dd></dd></dl>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="aede85e064f0dd4c5eb8d3157793cd799"></a><!-- doxytag: member="Gio::UnixFDList::~UnixFDList" ref="aede85e064f0dd4c5eb8d3157793cd799" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual Gio::UnixFDList::~UnixFDList </td>
<td>(</td>
<td class="paramname"> )</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="af994190fe054980701789befb81bbbc8"></a><!-- doxytag: member="Gio::UnixFDList::UnixFDList" ref="af994190fe054980701789befb81bbbc8" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Gio::UnixFDList::UnixFDList </td>
<td>(</td>
<td class="paramname"> )</td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a5b668c1766c02bb0a2661384695942cb"></a><!-- doxytag: member="Gio::UnixFDList::UnixFDList" ref="a5b668c1766c02bb0a2661384695942cb" args="(const Glib::ArrayHandle< int > &fds)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Gio::UnixFDList::UnixFDList </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classGlib_1_1ArrayHandle.html">Glib::ArrayHandle</a>< int >& </td>
<td class="paramname"> <em>fds</em> )</td>
<td><code> [explicit, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a24759393f0445985fd7ddadbc9acd41d"></a><!-- doxytag: member="Gio::UnixFDList::UnixFDList" ref="a24759393f0445985fd7ddadbc9acd41d" args="(const Glib::ArrayHandle< int > &fds, int n_fds)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Gio::UnixFDList::UnixFDList </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classGlib_1_1ArrayHandle.html">Glib::ArrayHandle</a>< int >& </td>
<td class="paramname"> <em>fds</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>n_fds</em> </td>
</tr>
<tr>
<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="a8e99c050949497a05a6e65e8b2548101"></a><!-- doxytag: member="Gio::UnixFDList::append" ref="a8e99c050949497a05a6e65e8b2548101" args="(int fd)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Gio::UnixFDList::append </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>fd</em> )</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Adds a file descriptor to <em>list</em>. </p>
<p>The file descriptor is duplicated using dup(). You keep your copy of the descriptor and the copy contained in <em>list</em> will be closed when <em>list</em> is finalized.</p>
<p>A possible cause of failure is exceeding the per-process or system-wide file descriptor limit.</p>
<p>The index of the file descriptor in the list is returned. If you use this index with g_unix_fd_list_get() then you will receive back a duplicated copy of the same file descriptor.</p>
<dl class="since_2_24"><dt><b><a class="el" href="since_2_24.html#_since_2_24000045">Since glibmm 2.24:</a></b></dt><dd></dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">fd</td><td>A valid open file descriptor. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The index of the appended fd in case of success, else -1 (and <em>error</em> is set).</dd></dl>
<dl><dt><b>Exceptions:</b></dt><dd>
<table class="exception">
<tr><td class="paramname">Glib::Error.</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ad8865d446428f2590a7393c54e655307"></a><!-- doxytag: member="Gio::UnixFDList::create" ref="ad8865d446428f2590a7393c54e655307" args="()" -->
<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_1UnixFDList.html">UnixFDList</a>> Gio::UnixFDList::create </td>
<td>(</td>
<td class="paramname"> )</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates a new <a class="el" href="classGio_1_1UnixFDList.html" title="UnixFDList - An object containing a set of UNIX file descriptors.">UnixFDList</a> containing no file descriptors. </p>
<dl class="since_2_24"><dt><b><a class="el" href="since_2_24.html#_since_2_24000041">Since glibmm 2.24:</a></b></dt><dd></dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A new <a class="el" href="classGio_1_1UnixFDList.html" title="UnixFDList - An object containing a set of UNIX file descriptors.">UnixFDList</a>. </dd></dl>
</div>
</div>
<a class="anchor" id="a7095f1477818fa6cce563e1260933c5c"></a><!-- doxytag: member="Gio::UnixFDList::create" ref="a7095f1477818fa6cce563e1260933c5c" args="(const Glib::ArrayHandle< int > &fds)" -->
<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_1UnixFDList.html">UnixFDList</a>> Gio::UnixFDList::create </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classGlib_1_1ArrayHandle.html">Glib::ArrayHandle</a>< int >& </td>
<td class="paramname"> <em>fds</em> )</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates a new <a class="el" href="classGio_1_1UnixFDList.html" title="UnixFDList - An object containing a set of UNIX file descriptors.">UnixFDList</a> containing the file descriptors given in <em>fds</em>. </p>
<p>The file descriptors become the property of the new list and may no longer be used by the caller. The array itself is owned by the caller.</p>
<p>Each file descriptor in the array should be set to close-on-exec. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">fds</td><td>The list of file descriptors to use for creation. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A new <a class="el" href="classGio_1_1UnixFDList.html" title="UnixFDList - An object containing a set of UNIX file descriptors.">UnixFDList</a>. </dd></dl>
</div>
</div>
<a class="anchor" id="aee6c787908674c69e6d39a859c08b7fb"></a><!-- doxytag: member="Gio::UnixFDList::create" ref="aee6c787908674c69e6d39a859c08b7fb" args="(const Glib::ArrayHandle< int > &fds, int n_fds)" -->
<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_1UnixFDList.html">UnixFDList</a>> Gio::UnixFDList::create </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classGlib_1_1ArrayHandle.html">Glib::ArrayHandle</a>< int >& </td>
<td class="paramname"> <em>fds</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>n_fds</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates a new <a class="el" href="classGio_1_1UnixFDList.html" title="UnixFDList - An object containing a set of UNIX file descriptors.">UnixFDList</a> containing the file descriptors given in <em>fds</em>. </p>
<p>The file descriptors become the property of the new list and may no longer be used by the caller. The array itself is owned by the caller.</p>
<p>Each file descriptor in the array should be set to close-on-exec.</p>
<p>If <em>n_fds</em> is -1 then <em>fds</em> must be terminated with -1.</p>
<dl class="since_2_24"><dt><b><a class="el" href="since_2_24.html#_since_2_24000042">Since glibmm 2.24:</a></b></dt><dd></dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">fds</td><td>The initial list of file descriptors. </td></tr>
<tr><td class="paramname">n_fds</td><td>The length of fds, or -1. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A new <a class="el" href="classGio_1_1UnixFDList.html" title="UnixFDList - An object containing a set of UNIX file descriptors.">UnixFDList</a>. </dd></dl>
</div>
</div>
<a class="anchor" id="abee8d9542776283f7e621fdfcc03badb"></a><!-- doxytag: member="Gio::UnixFDList::get" ref="abee8d9542776283f7e621fdfcc03badb" args="(int index) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Gio::UnixFDList::get </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>index</em> )</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets a file descriptor out of <em>list</em>. </p>
<p><em>index</em> specifies the index of the file descriptor to get. It is a programmer error for <em>index</em> to be out of range; see g_unix_fd_list_get_length().</p>
<p>The file descriptor is duplicated using dup() and set as close-on-exec before being returned. You must call close() on it when you are done.</p>
<p>A possible cause of failure is exceeding the per-process or system-wide file descriptor limit.</p>
<dl class="since_2_24"><dt><b><a class="el" href="since_2_24.html#_since_2_24000044">Since glibmm 2.24:</a></b></dt><dd></dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">index</td><td>The index into the list. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The file descriptor, or -1 in case of error. </dd></dl>
</div>
</div>
<a class="anchor" id="a509aef6d94ac576341436e97073a6cca"></a><!-- doxytag: member="Gio::UnixFDList::get_length" ref="a509aef6d94ac576341436e97073a6cca" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Gio::UnixFDList::get_length </td>
<td>(</td>
<td class="paramname"> )</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the length of <em>list</em> (ie: the number of file descriptors contained within). </p>
<dl class="since_2_24"><dt><b><a class="el" href="since_2_24.html#_since_2_24000043">Since glibmm 2.24:</a></b></dt><dd></dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The length of <em>list</em>. </dd></dl>
</div>
</div>
<a class="anchor" id="af1eeeaeadc809eba2061eaa6c22d9107"></a><!-- doxytag: member="Gio::UnixFDList::gobj" ref="af1eeeaeadc809eba2061eaa6c22d9107" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const GUnixFDList* Gio::UnixFDList::gobj </td>
<td>(</td>
<td class="paramname"> )</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="classGlib_1_1ObjectBase.html#a778a94181132976bbfb0519793f3b32e">Glib::ObjectBase</a>.</p>
</div>
</div>
<a class="anchor" id="a13369401ffc5804f1d08f21f8767efb3"></a><!-- doxytag: member="Gio::UnixFDList::gobj" ref="a13369401ffc5804f1d08f21f8767efb3" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GUnixFDList* Gio::UnixFDList::gobj </td>
<td>(</td>
<td class="paramname"> )</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="classGlib_1_1ObjectBase.html#a4c6efc18be8cb9c56e58fc0bd20fafbe">Glib::ObjectBase</a>.</p>
</div>
</div>
<a class="anchor" id="aa584b34d376383010cbf72c999a39442"></a><!-- doxytag: member="Gio::UnixFDList::gobj_copy" ref="aa584b34d376383010cbf72c999a39442" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GUnixFDList* Gio::UnixFDList::gobj_copy </td>
<td>(</td>
<td class="paramname"> )</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>
</div>
</div>
<a class="anchor" id="a3a649024e1da34de1c0659338e7df07c"></a><!-- doxytag: member="Gio::UnixFDList::peek_fds" ref="a3a649024e1da34de1c0659338e7df07c" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classGlib_1_1ArrayHandle.html">Glib::ArrayHandle</a><int> Gio::UnixFDList::peek_fds </td>
<td>(</td>
<td class="paramname"> )</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the array of file descriptors that is contained in this object. </p>
<p>After this call, the descriptors remain the property of the list. The caller must not close them. The array is valid only until list is changed in any way. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The list of file descriptors.</dd></dl>
<dl class="since_2_28"><dt><b><a class="el" href="since_2_28.html#_since_2_28000130">Since glibmm 2.28:</a></b></dt><dd></dd></dl>
</div>
</div>
<a class="anchor" id="a9167e4e9d3adf8f06405d4928b15b614"></a><!-- doxytag: member="Gio::UnixFDList::steal_fds" ref="a9167e4e9d3adf8f06405d4928b15b614" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classGlib_1_1ArrayHandle.html">Glib::ArrayHandle</a><int> Gio::UnixFDList::steal_fds </td>
<td>(</td>
<td class="paramname"> )</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the array of file descriptors that is contained in this object. </p>
<p>After this call, the descriptors are no longer contained in the list. Further calls will return an empty list (unless more descriptors have been added).</p>
<p>The caller is responsible for closing all of the file descriptors. The file descriptors in the array are set to close-on-exec. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The list of file descriptors.</dd></dl>
<dl class="since_2_28"><dt><b><a class="el" href="since_2_28.html#_since_2_28000131">Since glibmm 2.28:</a></b></dt><dd></dd></dl>
</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="ac7c943cb9e8b46bfa4f6bae95569b7c7"></a><!-- doxytag: member="Gio::UnixFDList::wrap" ref="ac7c943cb9e8b46bfa4f6bae95569b7c7" args="(GUnixFDList *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_1UnixFDList.html">Gio::UnixFDList</a> > wrap </td>
<td>(</td>
<td class="paramtype">GUnixFDList * </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>
</tr>
<tr>
<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 class="params">
<tr><td class="paramname">object</td><td>The C instance. </td></tr>
<tr><td class="paramname">take_copy</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>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Tue Apr 5 2011 16:07:13 for glibmm by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.2 </small></address>
</body>
</html>
