<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.4"/>
<title>c++-gtk-utils: io_watch.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">c++-gtk-utils
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.4 -->
<div id="navrow1" 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><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_101f02d72531e1268e20029abbed11e1.html">c++-gtk-utils</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">io_watch.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="io__watch_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/* Copyright (C) 2005 to 2013 Chris Vine</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"></span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">The library comprised in this file or of which this file is part is</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">distributed by Chris Vine under the GNU Lesser General Public</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">License as follows:</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"></span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> This library is free software; you can redistribute it and/or</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> modify it under the terms of the GNU Lesser General Public License</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> as published by the Free Software Foundation; either version 2.1 of</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> the License, or (at your option) any later version.</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"></span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> This library is distributed in the hope that it will be useful, but</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> WITHOUT ANY WARRANTY; without even the implied warranty of</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> Lesser General Public License, version 2.1, for more details.</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"></span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> You should have received a copy of the GNU Lesser General Public</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> License, version 2.1, along with this library (see the file LGPL.TXT</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> which came with this source code package in the c++-gtk-utils</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> sub-directory); if not, write to the Free Software Foundation, Inc.,</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"></span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment">*/</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#ifndef CGU_IO_WATCH_H</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor"></span><span class="preprocessor">#define CGU_IO_WATCH_H</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor"></span><span class="comment"></span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"></span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"> * @defgroup io_watch io_watch</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"> * \#include <c++-gtk-utils/io_watch.h></span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"> * The start_iowatch() function connects a Unix file descriptor to an</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"> * event loop owned by a GMainContext object (normally the main</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> * program loop). It both saves the overhead of having to construct a</span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"> * GIOChannel object where the only thing wanted is to execute a</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"> * callback when there is something to be read from a pipe, fifo or</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"> * socket or a pipe or fifo can be written to, and it also provides</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"> * for automatic disconnection when an object whose function the</span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"> * callback represents or calls into is destroyed.</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"> * For the GIOCondition argument of start_iowatch(), G_IO_IN can be</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"> * bitwise-ORed with G_IO_HUP, and should be if the callback has the</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"> * task of cleaning up if EOF is reached (see</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> * http://www.greenend.org.uk/rjk/2001/06/poll.html ), which is</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"> * detected by read() returning 0. A cast will be required to do this</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"> * for the third argument of start_iowatch() (that is, pass</span></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"> * GIOCondition(G_IO_IN | G_IO_HUP)). In addition, G_IO_IN and</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment"> * G_IO_OUT can be bitwise-ORed with G_IO_ERR (and passed as</span></div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment"> * GIOCondition(G_IO_IN | G_IO_HUP | G_IO_ERR) or</span></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"> * GIOCondition(G_IO_OUT | G_IO_ERR)), which would be detected in the</span></div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"> * callback by read() or write() returning -1.</span></div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"> * The start_iowatch() function has a number of overloads for the</span></div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"> * callback to be executed when the file descriptor becomes available</span></div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"> * for reading or writing. The simplest to use take an ordinary</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"> * callable object, such as a lambda expression or the return value of</span></div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"> * std::bind. For these, the callable object should take two unbound</span></div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"> * arguments, the first a GIOCondition type and the second a bool&</span></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"> * type. When the callable object is executed, the GIOCondition</span></div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"> * argument is passed a value representing the bitwise-ORed events</span></div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"> * which caused the call: this enables a single watch to be provided</span></div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"> * for both reading and writing (if the file descriptor has been</span></div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"> * opened for reading and writing), by testing for G_IO_IN and</span></div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"> * G_IO_OUT on that argument in the callback function. It also</span></div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment"> * enables, by testing for G_IO_HUP and G_IO_ERR, a hang-up or error</span></div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment"> * condition to be detected without having to inspect the return value</span></div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment"> * of read() or write() (but note the test results referred to in</span></div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment"> * http://www.greenend.org.uk/rjk/2001/06/poll.html , which show that</span></div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment"> * the ending of a connection can only reliably be determined by</span></div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment"> * testing whether read() returns 0, or whether the iostream wrapper</span></div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment"> * on top of it reports end of file after attempting a read.)</span></div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment"> * The second bool& argument can be used to end the watch. If it is</span></div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment"> * set by the callable object when executed to false, say because</span></div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment"> * end-of-file has been reached, then the watch will be ended and all</span></div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment"> * resources connected with it deleted without further user action</span></div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment"> * being required (there is no need for the callable object to set it</span></div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment"> * to true if the watch is to continue, as that is the default).</span></div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="comment"> * Other overloads of start_iowatch() take the more explicitly typed</span></div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="comment"> * Callback::CallbackArg<GIOCondition, bool&> callback object (as</span></div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment"> * constructed with Callback::lambda(), Callback::make() or</span></div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment"> * Callback::make_ref()) instead of a simple callable object, and</span></div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="comment"> * others take a Callback::CallbackArg<bool&> object for cases where a</span></div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment"> * GIOCondition argument is unnecessary (although there is nothing</span></div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment"> * stopping the other overloads being used and that argument being</span></div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="comment"> * ignored, and that version is mainly kept to retain compatibility</span></div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="comment"> * with the 1.2 and 2.0 series of the library).</span></div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment"> * All of the start_iowatch() overloads have an option to take a</span></div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment"> * Callback::Releaser object as their third argument, which provides</span></div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="comment"> * for automatic ceasing of the watch if the target object which has</span></div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="comment"> * the Releaser as a member is destroyed. (Note that for this to be</span></div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment"> * race free, the lifetime of the remote target object whose method is</span></div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment"> * to be invoked must be determined by the thread to whose main loop</span></div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="comment"> * the watch has been attached. When the main loop begins invoking</span></div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="comment"> * the execution of the watch callback, the remote object must either</span></div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="comment"> * wholly exist, in which case the callback will be invoked, or have</span></div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="comment"> * been destroyed, in which case the callback will be ignored, and not</span></div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="comment"> * be in some transient half-state governed by another thread.)</span></div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment"> * start_iowatch() is thread-safe (it may be called in any thread)</span></div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="comment"> * provided that, if glib < 2.32 is used, the glib main loop has been</span></div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="comment"> * made thread-safe by a call to g_thread_init(). glib >= 2.32 does</span></div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment"> * not require g_thread_init() to be called in order to be</span></div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="comment"> * thread-safe.</span></div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="comment"> * </span></div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="comment"> * As mentioned above, the connected callback passed to</span></div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="comment"> * start_iowatch() has an unbound bool& argument. The watch will be</span></div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="comment"> * ended if that argument is set by the connected callback to false,</span></div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="comment"> * say because end-of-file has been reached. In addition, the watch</span></div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="comment"> * will be ended automatically and resources deleted if (i) as</span></div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="comment"> * mentioned above, the callback passed to start_iowatch() is</span></div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="comment"> * protected by a Releaser object and the target object having the</span></div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="comment"> * Releaser as a member is destroyed, or (ii) g_source_remove() is</span></div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="comment"> * called on the source id returned by start_iowatch() (where the</span></div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="comment"> * watch is attached to the default main context) or</span></div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="comment"> * g_source_destroy() is called on the GSource object obtained from</span></div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="comment"> * that id with g_main_context_find_source_by_id() (where the watch</span></div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="comment"> * has been attached to a non-default main context). If the source</span></div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="comment"> * has been removed automatically by virtue of the bool& argument</span></div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="comment"> * being set to false or by virtue of a Releaser object releasing,</span></div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span> <span class="comment"> * g_source_remove() or g_source_destroy() should not afterwards be</span></div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="comment"> * called in respect of the id value returned by start_iowatch() in</span></div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="comment"> * case it has been reused by the main context concerned in the</span></div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span> <span class="comment"> * meantime.</span></div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span> </div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="preprocessor">#include <glib.h></span></div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="preprocessor">#include <<a class="code" href="callback_8h.html" title="This file provides classes for type erasure. ">c++-gtk-utils/callback.h</a>></span></div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span> <span class="preprocessor">#include <<a class="code" href="cgu__config_8h.html">c++-gtk-utils/cgu_config.h</a>></span></div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span> </div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span> <span class="keyword">namespace </span>Cgu {</div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span> </div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span> <span class="keyword">class </span>Releaser;</div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span> <span class="comment"></span></div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="comment"> * Starts an io watch in the glib main loop on a file descriptor, and</span></div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span> <span class="comment"> * executes the callback if the condition in io_condition is met. It</span></div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span> <span class="comment"> * is thread-safe (it may be called in any thread) provided that, if</span></div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span> <span class="comment"> * glib < 2.32 is used, g_thread_init() has been called. glib >= 2.32</span></div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <span class="comment"> * does not require g_thread_init() to be called to be thread-safe.</span></div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span> <span class="comment"> * @param fd The file descriptor.</span></div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span> <span class="comment"> * @param cb The callback object. Ownership is taken of this object,</span></div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span> <span class="comment"> * and it will be deleted when it has been finished with</span></div>
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span> <span class="comment"> * @param io_condition The condition to be watched for (G_IO_IN may be</span></div>
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span> <span class="comment"> * bitwise-ored with G_IO_HUP, and G_IO_IN and G_IO_OUT may be</span></div>
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span> <span class="comment"> * bitwise-ored with G_IO_ERR).</span></div>
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span> <span class="comment"> * @param priority The priority to be given to the watch in the main</span></div>
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span> <span class="comment"> * loop. In ascending order of priorities, priorities are</span></div>
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span> <span class="comment"> * G_PRIORITY_LOW, G_PRIORITY_DEFAULT_IDLE, G_PRIORITY_HIGH_IDLE,</span></div>
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span> <span class="comment"> * G_PRIORITY_DEFAULT and G_PRIORITY_HIGH. The default is</span></div>
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span> <span class="comment"> * G_PRIORITY_DEFAULT. This determines the order in which the</span></div>
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span> <span class="comment"> * callback will appear in the event list in the main loop, not the</span></div>
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span> <span class="comment"> * priority which the OS will adopt</span></div>
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span> <span class="comment"> * @param context The glib main context to which the watch is to be</span></div>
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span> <span class="comment"> * attached (the default of NULL will cause the watch to be attached</span></div>
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span> <span class="comment"> * to the main program loop, and this is almost always what is</span></div>
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span> <span class="comment"> * wanted).</span></div>
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span> <span class="comment"> * @return The glib source id of the watch.</span></div>
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span> <span class="comment"> * @exception std::bad_alloc The function might throw std::bad_alloc</span></div>
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span> <span class="comment"> * if memory is exhausted and the system throws in that case. If it</span></div>
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span> <span class="comment"> * does so, the CallbackArg object will be disposed of.</span></div>
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span> <span class="comment"> * @exception Cgu::Thread::MutexError This function might throw</span></div>
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span> <span class="comment"> * Cgu:Thread::MutexError if initialisation of the mutex in a</span></div>
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span> <span class="comment"> * SafeEmitterArg object constructed by this method fails. If it does</span></div>
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span> <span class="comment"> * so, the CallbackArg object will be disposed of. (It is often not</span></div>
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span> <span class="comment"> * worth checking for this exception, as it means either memory is</span></div>
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span> <span class="comment"> * exhausted or pthread has run out of other resources to create new</span></div>
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span> <span class="comment"> * mutexes.)</span></div>
<div class="line"><a name="l00175"></a><span class="lineno"> 175</span> <span class="comment"> * @note Cancellation of the thread to which the watch is attached is</span></div>
<div class="line"><a name="l00176"></a><span class="lineno"> 176</span> <span class="comment"> * blocked during execution of the callback.</span></div>
<div class="line"><a name="l00177"></a><span class="lineno"> 177</span> <span class="comment"> * @ingroup io_watch</span></div>
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span> guint <a class="code" href="group__io__watch.html#gaa908dd5f3e3fd9e0d2cd9403884cad40">start_iowatch</a>(<span class="keywordtype">int</span> fd, <span class="keyword">const</span> Callback::CallbackArg<bool&>* cb,</div>
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span>  GIOCondition io_condition, gint priority = G_PRIORITY_DEFAULT,</div>
<div class="line"><a name="l00181"></a><span class="lineno"> 181</span>  GMainContext* context = 0);</div>
<div class="line"><a name="l00182"></a><span class="lineno"> 182</span> <span class="comment"></span></div>
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span> <span class="comment"> * Starts an io watch in the glib main loop on a file descriptor, and</span></div>
<div class="line"><a name="l00185"></a><span class="lineno"> 185</span> <span class="comment"> * executes the callback if the condition in io_condition is met.</span></div>
<div class="line"><a name="l00186"></a><span class="lineno"> 186</span> <span class="comment"> * This version provides for automatic watch disconnection when the</span></div>
<div class="line"><a name="l00187"></a><span class="lineno"> 187</span> <span class="comment"> * object whose function the callback represents is destroyed, via the</span></div>
<div class="line"><a name="l00188"></a><span class="lineno"> 188</span> <span class="comment"> * Releaser object. It is thread-safe (it may be called in any</span></div>
<div class="line"><a name="l00189"></a><span class="lineno"> 189</span> <span class="comment"> * thread) provided that, if glib < 2.32 is used, g_thread_init() has</span></div>
<div class="line"><a name="l00190"></a><span class="lineno"> 190</span> <span class="comment"> * been called. glib >= 2.32 does not require g_thread_init() to be</span></div>
<div class="line"><a name="l00191"></a><span class="lineno"> 191</span> <span class="comment"> * called to be thread-safe.</span></div>
<div class="line"><a name="l00192"></a><span class="lineno"> 192</span> <span class="comment"> * @param fd The file descriptor.</span></div>
<div class="line"><a name="l00193"></a><span class="lineno"> 193</span> <span class="comment"> * @param cb The callback object. Ownership is taken of this object,</span></div>
<div class="line"><a name="l00194"></a><span class="lineno"> 194</span> <span class="comment"> * and it will be deleted when it has been finished with.</span></div>
<div class="line"><a name="l00195"></a><span class="lineno"> 195</span> <span class="comment"> * @param r A Releaser object which the protected object has as a</span></div>
<div class="line"><a name="l00196"></a><span class="lineno"> 196</span> <span class="comment"> * public member.</span></div>
<div class="line"><a name="l00197"></a><span class="lineno"> 197</span> <span class="comment"> * @param io_condition The condition to be watched for (G_IO_IN may be</span></div>
<div class="line"><a name="l00198"></a><span class="lineno"> 198</span> <span class="comment"> * bitwise-ored with G_IO_HUP, and G_IO_IN and G_IO_OUT may be</span></div>
<div class="line"><a name="l00199"></a><span class="lineno"> 199</span> <span class="comment"> * bitwise-ored with G_IO_ERR).</span></div>
<div class="line"><a name="l00200"></a><span class="lineno"> 200</span> <span class="comment"> * @param priority The priority to be given to the watch in the main</span></div>
<div class="line"><a name="l00201"></a><span class="lineno"> 201</span> <span class="comment"> * loop. In ascending order of priorities, priorities are</span></div>
<div class="line"><a name="l00202"></a><span class="lineno"> 202</span> <span class="comment"> * G_PRIORITY_LOW, G_PRIORITY_DEFAULT_IDLE, G_PRIORITY_HIGH_IDLE,</span></div>
<div class="line"><a name="l00203"></a><span class="lineno"> 203</span> <span class="comment"> * G_PRIORITY_DEFAULT and G_PRIORITY_HIGH. The default is</span></div>
<div class="line"><a name="l00204"></a><span class="lineno"> 204</span> <span class="comment"> * G_PRIORITY_DEFAULT. This determines the order in which the</span></div>
<div class="line"><a name="l00205"></a><span class="lineno"> 205</span> <span class="comment"> * callback will appear in the event list in the main loop, not the</span></div>
<div class="line"><a name="l00206"></a><span class="lineno"> 206</span> <span class="comment"> * priority which the OS will adopt</span></div>
<div class="line"><a name="l00207"></a><span class="lineno"> 207</span> <span class="comment"> * @param context The glib main context to which the watch is to be</span></div>
<div class="line"><a name="l00208"></a><span class="lineno"> 208</span> <span class="comment"> * attached (the default of NULL will cause the watch to be attached</span></div>
<div class="line"><a name="l00209"></a><span class="lineno"> 209</span> <span class="comment"> * to the main program loop, and this is almost always what is</span></div>
<div class="line"><a name="l00210"></a><span class="lineno"> 210</span> <span class="comment"> * wanted).</span></div>
<div class="line"><a name="l00211"></a><span class="lineno"> 211</span> <span class="comment"> * @return The glib source id of the watch.</span></div>
<div class="line"><a name="l00212"></a><span class="lineno"> 212</span> <span class="comment"> * @exception std::bad_alloc The function might throw std::bad_alloc</span></div>
<div class="line"><a name="l00213"></a><span class="lineno"> 213</span> <span class="comment"> * if memory is exhausted and the system throws in that case. If it</span></div>
<div class="line"><a name="l00214"></a><span class="lineno"> 214</span> <span class="comment"> * does so, the CallbackArg object will be disposed of.</span></div>
<div class="line"><a name="l00215"></a><span class="lineno"> 215</span> <span class="comment"> * @exception Cgu::Thread::MutexError This function might throw</span></div>
<div class="line"><a name="l00216"></a><span class="lineno"> 216</span> <span class="comment"> * Cgu:Thread::MutexError if initialisation of the mutex in a</span></div>
<div class="line"><a name="l00217"></a><span class="lineno"> 217</span> <span class="comment"> * SafeEmitterArg object constructed by this method fails. If it does</span></div>
<div class="line"><a name="l00218"></a><span class="lineno"> 218</span> <span class="comment"> * so, the CallbackArg object will be disposed of. (It is often not</span></div>
<div class="line"><a name="l00219"></a><span class="lineno"> 219</span> <span class="comment"> * worth checking for this exception, as it means either memory is</span></div>
<div class="line"><a name="l00220"></a><span class="lineno"> 220</span> <span class="comment"> * exhausted or pthread has run out of other resources to create new</span></div>
<div class="line"><a name="l00221"></a><span class="lineno"> 221</span> <span class="comment"> * mutexes.)</span></div>
<div class="line"><a name="l00222"></a><span class="lineno"> 222</span> <span class="comment"> * @note Cancellation of the thread to which the watch is attached is</span></div>
<div class="line"><a name="l00223"></a><span class="lineno"> 223</span> <span class="comment"> * blocked during execution of the callback.</span></div>
<div class="line"><a name="l00224"></a><span class="lineno"> 224</span> <span class="comment"> * @ingroup io_watch</span></div>
<div class="line"><a name="l00225"></a><span class="lineno"> 225</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00226"></a><span class="lineno"> 226</span> guint <a class="code" href="group__io__watch.html#gaa908dd5f3e3fd9e0d2cd9403884cad40">start_iowatch</a>(<span class="keywordtype">int</span> fd, <span class="keyword">const</span> Callback::CallbackArg<bool&>* cb, Releaser& r,</div>
<div class="line"><a name="l00227"></a><span class="lineno"> 227</span>  GIOCondition io_condition, gint priority = G_PRIORITY_DEFAULT,</div>
<div class="line"><a name="l00228"></a><span class="lineno"> 228</span>  GMainContext* context = 0);</div>
<div class="line"><a name="l00229"></a><span class="lineno"> 229</span> <span class="comment"></span></div>
<div class="line"><a name="l00230"></a><span class="lineno"> 230</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00231"></a><span class="lineno"> 231</span> <span class="comment"> * Starts an io watch in the glib main loop on a file descriptor, and</span></div>
<div class="line"><a name="l00232"></a><span class="lineno"> 232</span> <span class="comment"> * executes the callback if the condition in io_condition is met.</span></div>
<div class="line"><a name="l00233"></a><span class="lineno"> 233</span> <span class="comment"> * This version provides the GIOCondition status which caused the</span></div>
<div class="line"><a name="l00234"></a><span class="lineno"> 234</span> <span class="comment"> * callback to be invoked as the first unbound argument of the</span></div>
<div class="line"><a name="l00235"></a><span class="lineno"> 235</span> <span class="comment"> * callback object. It is thread-safe (it may be called in any</span></div>
<div class="line"><a name="l00236"></a><span class="lineno"> 236</span> <span class="comment"> * thread) provided that, if glib < 2.32 is used, g_thread_init() has</span></div>
<div class="line"><a name="l00237"></a><span class="lineno"> 237</span> <span class="comment"> * been called. glib >= 2.32 does not require g_thread_init() to be</span></div>
<div class="line"><a name="l00238"></a><span class="lineno"> 238</span> <span class="comment"> * called to be thread-safe.</span></div>
<div class="line"><a name="l00239"></a><span class="lineno"> 239</span> <span class="comment"> * @param fd The file descriptor.</span></div>
<div class="line"><a name="l00240"></a><span class="lineno"> 240</span> <span class="comment"> * @param cb The callback object. Ownership is taken of this object,</span></div>
<div class="line"><a name="l00241"></a><span class="lineno"> 241</span> <span class="comment"> * and it will be deleted when it has been finished with.</span></div>
<div class="line"><a name="l00242"></a><span class="lineno"> 242</span> <span class="comment"> * @param io_condition The condition(s) to be watched for (G_IO_IN,</span></div>
<div class="line"><a name="l00243"></a><span class="lineno"> 243</span> <span class="comment"> * G_IO_OUT, G_IO_HUP and G_IO_ERR may all be bitwise-ored).</span></div>
<div class="line"><a name="l00244"></a><span class="lineno"> 244</span> <span class="comment"> * @param priority The priority to be given to the watch in the main</span></div>
<div class="line"><a name="l00245"></a><span class="lineno"> 245</span> <span class="comment"> * loop. In ascending order of priorities, priorities are</span></div>
<div class="line"><a name="l00246"></a><span class="lineno"> 246</span> <span class="comment"> * G_PRIORITY_LOW, G_PRIORITY_DEFAULT_IDLE, G_PRIORITY_HIGH_IDLE,</span></div>
<div class="line"><a name="l00247"></a><span class="lineno"> 247</span> <span class="comment"> * G_PRIORITY_DEFAULT and G_PRIORITY_HIGH. The default is</span></div>
<div class="line"><a name="l00248"></a><span class="lineno"> 248</span> <span class="comment"> * G_PRIORITY_DEFAULT. This determines the order in which the</span></div>
<div class="line"><a name="l00249"></a><span class="lineno"> 249</span> <span class="comment"> * callback will appear in the event list in the main loop, not the</span></div>
<div class="line"><a name="l00250"></a><span class="lineno"> 250</span> <span class="comment"> * priority which the OS will adopt</span></div>
<div class="line"><a name="l00251"></a><span class="lineno"> 251</span> <span class="comment"> * @param context The glib main context to which the watch is to be</span></div>
<div class="line"><a name="l00252"></a><span class="lineno"> 252</span> <span class="comment"> * attached (the default of NULL will cause the watch to be attached</span></div>
<div class="line"><a name="l00253"></a><span class="lineno"> 253</span> <span class="comment"> * to the main program loop, and this is almost always what is</span></div>
<div class="line"><a name="l00254"></a><span class="lineno"> 254</span> <span class="comment"> * wanted).</span></div>
<div class="line"><a name="l00255"></a><span class="lineno"> 255</span> <span class="comment"> * @return The glib source id of the watch.</span></div>
<div class="line"><a name="l00256"></a><span class="lineno"> 256</span> <span class="comment"> * @exception std::bad_alloc The function might throw std::bad_alloc</span></div>
<div class="line"><a name="l00257"></a><span class="lineno"> 257</span> <span class="comment"> * if memory is exhausted and the system throws in that case. If it</span></div>
<div class="line"><a name="l00258"></a><span class="lineno"> 258</span> <span class="comment"> * does so, the CallbackArg object will be disposed of.</span></div>
<div class="line"><a name="l00259"></a><span class="lineno"> 259</span> <span class="comment"> * @exception Cgu::Thread::MutexError This function might throw</span></div>
<div class="line"><a name="l00260"></a><span class="lineno"> 260</span> <span class="comment"> * Cgu:Thread::MutexError if initialisation of the mutex in a</span></div>
<div class="line"><a name="l00261"></a><span class="lineno"> 261</span> <span class="comment"> * SafeEmitterArg object constructed by this method fails. If it does</span></div>
<div class="line"><a name="l00262"></a><span class="lineno"> 262</span> <span class="comment"> * so, the CallbackArg object will be disposed of. (It is often not</span></div>
<div class="line"><a name="l00263"></a><span class="lineno"> 263</span> <span class="comment"> * worth checking for this exception, as it means either memory is</span></div>
<div class="line"><a name="l00264"></a><span class="lineno"> 264</span> <span class="comment"> * exhausted or pthread has run out of other resources to create new</span></div>
<div class="line"><a name="l00265"></a><span class="lineno"> 265</span> <span class="comment"> * mutexes.)</span></div>
<div class="line"><a name="l00266"></a><span class="lineno"> 266</span> <span class="comment"> * @note Cancellation of the thread to which the watch is attached is</span></div>
<div class="line"><a name="l00267"></a><span class="lineno"> 267</span> <span class="comment"> * blocked during execution of the callback.</span></div>
<div class="line"><a name="l00268"></a><span class="lineno"> 268</span> <span class="comment"> * @ingroup io_watch</span></div>
<div class="line"><a name="l00269"></a><span class="lineno"> 269</span> <span class="comment"> * </span></div>
<div class="line"><a name="l00270"></a><span class="lineno"> 270</span> <span class="comment"> * Since 2.0.0-rc2</span></div>
<div class="line"><a name="l00271"></a><span class="lineno"> 271</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00272"></a><span class="lineno"> 272</span> guint <a class="code" href="group__io__watch.html#gaa908dd5f3e3fd9e0d2cd9403884cad40">start_iowatch</a>(<span class="keywordtype">int</span> fd, <span class="keyword">const</span> Callback::CallbackArg<GIOCondition, bool&>* cb,</div>
<div class="line"><a name="l00273"></a><span class="lineno"> 273</span>  GIOCondition io_condition, gint priority = G_PRIORITY_DEFAULT,</div>
<div class="line"><a name="l00274"></a><span class="lineno"> 274</span>  GMainContext* context = 0);</div>
<div class="line"><a name="l00275"></a><span class="lineno"> 275</span> <span class="comment"></span></div>
<div class="line"><a name="l00276"></a><span class="lineno"> 276</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00277"></a><span class="lineno"> 277</span> <span class="comment"> * Starts an io watch in the glib main loop on a file descriptor, and</span></div>
<div class="line"><a name="l00278"></a><span class="lineno"> 278</span> <span class="comment"> * executes the callback if the condition in io_condition is met.</span></div>
<div class="line"><a name="l00279"></a><span class="lineno"> 279</span> <span class="comment"> * This version provides both automatic watch disconnection when the</span></div>
<div class="line"><a name="l00280"></a><span class="lineno"> 280</span> <span class="comment"> * object whose function the callback represents is destroyed, via the</span></div>
<div class="line"><a name="l00281"></a><span class="lineno"> 281</span> <span class="comment"> * Releaser object, and provides the GIOCondition status which caused</span></div>
<div class="line"><a name="l00282"></a><span class="lineno"> 282</span> <span class="comment"> * the callback to be invoked as the first unbound argument of the</span></div>
<div class="line"><a name="l00283"></a><span class="lineno"> 283</span> <span class="comment"> * callback object. It is thread-safe (it may be called in any</span></div>
<div class="line"><a name="l00284"></a><span class="lineno"> 284</span> <span class="comment"> * thread) provided that, if glib < 2.32 is used, g_thread_init() has</span></div>
<div class="line"><a name="l00285"></a><span class="lineno"> 285</span> <span class="comment"> * been called. glib >= 2.32 does not require g_thread_init() to be</span></div>
<div class="line"><a name="l00286"></a><span class="lineno"> 286</span> <span class="comment"> * called to be thread-safe.</span></div>
<div class="line"><a name="l00287"></a><span class="lineno"> 287</span> <span class="comment"> * @param fd The file descriptor.</span></div>
<div class="line"><a name="l00288"></a><span class="lineno"> 288</span> <span class="comment"> * @param cb The callback object. Ownership is taken of this object,</span></div>
<div class="line"><a name="l00289"></a><span class="lineno"> 289</span> <span class="comment"> * and it will be deleted when it has been finished with.</span></div>
<div class="line"><a name="l00290"></a><span class="lineno"> 290</span> <span class="comment"> * @param r A Releaser object which the protected object has as a</span></div>
<div class="line"><a name="l00291"></a><span class="lineno"> 291</span> <span class="comment"> * public member.</span></div>
<div class="line"><a name="l00292"></a><span class="lineno"> 292</span> <span class="comment"> * @param io_condition The condition(s) to be watched for (G_IO_IN,</span></div>
<div class="line"><a name="l00293"></a><span class="lineno"> 293</span> <span class="comment"> * G_IO_OUT, G_IO_HUP and G_IO_ERR may all be bitwise-ored).</span></div>
<div class="line"><a name="l00294"></a><span class="lineno"> 294</span> <span class="comment"> * @param priority The priority to be given to the watch in the main</span></div>
<div class="line"><a name="l00295"></a><span class="lineno"> 295</span> <span class="comment"> * loop. In ascending order of priorities, priorities are</span></div>
<div class="line"><a name="l00296"></a><span class="lineno"> 296</span> <span class="comment"> * G_PRIORITY_LOW, G_PRIORITY_DEFAULT_IDLE, G_PRIORITY_HIGH_IDLE,</span></div>
<div class="line"><a name="l00297"></a><span class="lineno"> 297</span> <span class="comment"> * G_PRIORITY_DEFAULT and G_PRIORITY_HIGH. The default is</span></div>
<div class="line"><a name="l00298"></a><span class="lineno"> 298</span> <span class="comment"> * G_PRIORITY_DEFAULT. This determines the order in which the</span></div>
<div class="line"><a name="l00299"></a><span class="lineno"> 299</span> <span class="comment"> * callback will appear in the event list in the main loop, not the</span></div>
<div class="line"><a name="l00300"></a><span class="lineno"> 300</span> <span class="comment"> * priority which the OS will adopt</span></div>
<div class="line"><a name="l00301"></a><span class="lineno"> 301</span> <span class="comment"> * @param context The glib main context to which the watch is to be</span></div>
<div class="line"><a name="l00302"></a><span class="lineno"> 302</span> <span class="comment"> * attached (the default of NULL will cause the watch to be attached</span></div>
<div class="line"><a name="l00303"></a><span class="lineno"> 303</span> <span class="comment"> * to the main program loop, and this is almost always what is</span></div>
<div class="line"><a name="l00304"></a><span class="lineno"> 304</span> <span class="comment"> * wanted).</span></div>
<div class="line"><a name="l00305"></a><span class="lineno"> 305</span> <span class="comment"> * @return The glib source id of the watch.</span></div>
<div class="line"><a name="l00306"></a><span class="lineno"> 306</span> <span class="comment"> * @exception std::bad_alloc The function might throw std::bad_alloc</span></div>
<div class="line"><a name="l00307"></a><span class="lineno"> 307</span> <span class="comment"> * if memory is exhausted and the system throws in that case. If it</span></div>
<div class="line"><a name="l00308"></a><span class="lineno"> 308</span> <span class="comment"> * does so, the CallbackArg object will be disposed of.</span></div>
<div class="line"><a name="l00309"></a><span class="lineno"> 309</span> <span class="comment"> * @exception Cgu::Thread::MutexError This function might throw</span></div>
<div class="line"><a name="l00310"></a><span class="lineno"> 310</span> <span class="comment"> * Cgu:Thread::MutexError if initialisation of the mutex in a</span></div>
<div class="line"><a name="l00311"></a><span class="lineno"> 311</span> <span class="comment"> * SafeEmitterArg object constructed by this method fails. If it does</span></div>
<div class="line"><a name="l00312"></a><span class="lineno"> 312</span> <span class="comment"> * so, the CallbackArg object will be disposed of. (It is often not</span></div>
<div class="line"><a name="l00313"></a><span class="lineno"> 313</span> <span class="comment"> * worth checking for this exception, as it means either memory is</span></div>
<div class="line"><a name="l00314"></a><span class="lineno"> 314</span> <span class="comment"> * exhausted or pthread has run out of other resources to create new</span></div>
<div class="line"><a name="l00315"></a><span class="lineno"> 315</span> <span class="comment"> * mutexes.)</span></div>
<div class="line"><a name="l00316"></a><span class="lineno"> 316</span> <span class="comment"> * @note Cancellation of the thread to which the watch is attached is</span></div>
<div class="line"><a name="l00317"></a><span class="lineno"> 317</span> <span class="comment"> * blocked during execution of the callback.</span></div>
<div class="line"><a name="l00318"></a><span class="lineno"> 318</span> <span class="comment"> * @ingroup io_watch</span></div>
<div class="line"><a name="l00319"></a><span class="lineno"> 319</span> <span class="comment"> * </span></div>
<div class="line"><a name="l00320"></a><span class="lineno"> 320</span> <span class="comment"> * Since 2.0.0-rc2</span></div>
<div class="line"><a name="l00321"></a><span class="lineno"> 321</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00322"></a><span class="lineno"> 322</span> guint <a class="code" href="group__io__watch.html#gaa908dd5f3e3fd9e0d2cd9403884cad40">start_iowatch</a>(<span class="keywordtype">int</span> fd, <span class="keyword">const</span> Callback::CallbackArg<GIOCondition, bool&>* cb,</div>
<div class="line"><a name="l00323"></a><span class="lineno"> 323</span>  Releaser& r, GIOCondition io_condition, gint priority = G_PRIORITY_DEFAULT,</div>
<div class="line"><a name="l00324"></a><span class="lineno"> 324</span>  GMainContext* context = 0);</div>
<div class="line"><a name="l00325"></a><span class="lineno"> 325</span> <span class="comment"></span></div>
<div class="line"><a name="l00326"></a><span class="lineno"> 326</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00327"></a><span class="lineno"> 327</span> <span class="comment"> * Starts an io watch in the glib main loop on a file descriptor, and</span></div>
<div class="line"><a name="l00328"></a><span class="lineno"> 328</span> <span class="comment"> * executes a callable object if the condition in io_condition is met.</span></div>
<div class="line"><a name="l00329"></a><span class="lineno"> 329</span> <span class="comment"> * It provides the GIOCondition status which caused the callback to be</span></div>
<div class="line"><a name="l00330"></a><span class="lineno"> 330</span> <span class="comment"> * invoked as the first unbound argument of the callable object, and</span></div>
<div class="line"><a name="l00331"></a><span class="lineno"> 331</span> <span class="comment"> * the second is a bool& argument which if set to 'true' will cause</span></div>
<div class="line"><a name="l00332"></a><span class="lineno"> 332</span> <span class="comment"> * the io watch to end. It is thread-safe (it may be called in any</span></div>
<div class="line"><a name="l00333"></a><span class="lineno"> 333</span> <span class="comment"> * thread) provided that, if glib < 2.32 is used, g_thread_init() has</span></div>
<div class="line"><a name="l00334"></a><span class="lineno"> 334</span> <span class="comment"> * been called. glib >= 2.32 does not require g_thread_init() to be</span></div>
<div class="line"><a name="l00335"></a><span class="lineno"> 335</span> <span class="comment"> * called to be thread-safe.</span></div>
<div class="line"><a name="l00336"></a><span class="lineno"> 336</span> <span class="comment"> * @param fd The file descriptor.</span></div>
<div class="line"><a name="l00337"></a><span class="lineno"> 337</span> <span class="comment"> * @param func A callable object, such as formed by a lambda</span></div>
<div class="line"><a name="l00338"></a><span class="lineno"> 338</span> <span class="comment"> * expression or the result of std::bind. It should take two unbound</span></div>
<div class="line"><a name="l00339"></a><span class="lineno"> 339</span> <span class="comment"> * arguments of type 'GIOCondition' and 'bool&'.</span></div>
<div class="line"><a name="l00340"></a><span class="lineno"> 340</span> <span class="comment"> * @param io_condition The condition to be watched for (G_IO_IN may be</span></div>
<div class="line"><a name="l00341"></a><span class="lineno"> 341</span> <span class="comment"> * bitwise-ored with G_IO_HUP, and G_IO_IN and G_IO_OUT may be</span></div>
<div class="line"><a name="l00342"></a><span class="lineno"> 342</span> <span class="comment"> * bitwise-ored with G_IO_ERR).</span></div>
<div class="line"><a name="l00343"></a><span class="lineno"> 343</span> <span class="comment"> * @param priority The priority to be given to the watch in the main</span></div>
<div class="line"><a name="l00344"></a><span class="lineno"> 344</span> <span class="comment"> * loop. In ascending order of priorities, priorities are</span></div>
<div class="line"><a name="l00345"></a><span class="lineno"> 345</span> <span class="comment"> * G_PRIORITY_LOW, G_PRIORITY_DEFAULT_IDLE, G_PRIORITY_HIGH_IDLE,</span></div>
<div class="line"><a name="l00346"></a><span class="lineno"> 346</span> <span class="comment"> * G_PRIORITY_DEFAULT and G_PRIORITY_HIGH. The default is</span></div>
<div class="line"><a name="l00347"></a><span class="lineno"> 347</span> <span class="comment"> * G_PRIORITY_DEFAULT. This determines the order in which the</span></div>
<div class="line"><a name="l00348"></a><span class="lineno"> 348</span> <span class="comment"> * callback will appear in the event list in the main loop, not the</span></div>
<div class="line"><a name="l00349"></a><span class="lineno"> 349</span> <span class="comment"> * priority which the OS will adopt</span></div>
<div class="line"><a name="l00350"></a><span class="lineno"> 350</span> <span class="comment"> * @param context The glib main context to which the watch is to be</span></div>
<div class="line"><a name="l00351"></a><span class="lineno"> 351</span> <span class="comment"> * attached (the default of NULL will cause the watch to be attached</span></div>
<div class="line"><a name="l00352"></a><span class="lineno"> 352</span> <span class="comment"> * to the main program loop, and this is almost always what is</span></div>
<div class="line"><a name="l00353"></a><span class="lineno"> 353</span> <span class="comment"> * wanted).</span></div>
<div class="line"><a name="l00354"></a><span class="lineno"> 354</span> <span class="comment"> * @return The glib source id of the watch.</span></div>
<div class="line"><a name="l00355"></a><span class="lineno"> 355</span> <span class="comment"> * @exception std::bad_alloc The function might throw std::bad_alloc</span></div>
<div class="line"><a name="l00356"></a><span class="lineno"> 356</span> <span class="comment"> * if memory is exhausted and the system throws in that case.</span></div>
<div class="line"><a name="l00357"></a><span class="lineno"> 357</span> <span class="comment"> * @exception Cgu::Thread::MutexError This function might throw</span></div>
<div class="line"><a name="l00358"></a><span class="lineno"> 358</span> <span class="comment"> * Cgu:Thread::MutexError if initialisation of the mutex in a</span></div>
<div class="line"><a name="l00359"></a><span class="lineno"> 359</span> <span class="comment"> * SafeEmitterArg object constructed by this method fails. (It is</span></div>
<div class="line"><a name="l00360"></a><span class="lineno"> 360</span> <span class="comment"> * often not worth checking for this exception, as it means either</span></div>
<div class="line"><a name="l00361"></a><span class="lineno"> 361</span> <span class="comment"> * memory is exhausted or pthread has run out of other resources to</span></div>
<div class="line"><a name="l00362"></a><span class="lineno"> 362</span> <span class="comment"> * create new mutexes.)</span></div>
<div class="line"><a name="l00363"></a><span class="lineno"> 363</span> <span class="comment"> * @note 1. This function may also throw if the copy or move</span></div>
<div class="line"><a name="l00364"></a><span class="lineno"> 364</span> <span class="comment"> * constructor of the callable object throws.</span></div>
<div class="line"><a name="l00365"></a><span class="lineno"> 365</span> <span class="comment"> * @note 2. Cancellation of the thread to which the watch is attached</span></div>
<div class="line"><a name="l00366"></a><span class="lineno"> 366</span> <span class="comment"> * is blocked during execution of the callback.</span></div>
<div class="line"><a name="l00367"></a><span class="lineno"> 367</span> <span class="comment"> * @ingroup io_watch</span></div>
<div class="line"><a name="l00368"></a><span class="lineno"> 368</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00369"></a><span class="lineno"> 369</span> <span class="comment"> * Since 2.1.0</span></div>
<div class="line"><a name="l00370"></a><span class="lineno"> 370</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00371"></a><span class="lineno"> 371</span> <span class="comment">// we need to use enable_if so that where this function is passed a</span></div>
<div class="line"><a name="l00372"></a><span class="lineno"> 372</span> <span class="comment">// pointer to non-const Callback::CallbackArg, or some other</span></div>
<div class="line"><a name="l00373"></a><span class="lineno"> 373</span> <span class="comment">// convertible pointer, this templated overload is dropped from the</span></div>
<div class="line"><a name="l00374"></a><span class="lineno"> 374</span> <span class="comment">// overload set, in order to support the Callback::CallbackArg pointer</span></div>
<div class="line"><a name="l00375"></a><span class="lineno"> 375</span> <span class="comment">// overloads of this function. This overload calls into the version</span></div>
<div class="line"><a name="l00376"></a><span class="lineno"> 376</span> <span class="comment">// of this function taking a pointer to const Callback::CallbackArg in</span></div>
<div class="line"><a name="l00377"></a><span class="lineno"> 377</span> <span class="comment">// order to perform type erasure.</span></div>
<div class="line"><a name="l00378"></a><span class="lineno"> 378</span> <span class="keyword">template</span> <<span class="keyword">class </span>F,</div>
<div class="line"><a name="l00379"></a><span class="lineno"> 379</span>  <span class="keyword">class </span>= <span class="keyword">typename</span> std::enable_if<!std::is_convertible<typename std::remove_reference<F>::type,</div>
<div class="line"><a name="l00380"></a><span class="lineno"> 380</span>  <span class="keyword">const</span> Callback::CallbackArg<GIOCondition, bool&>*>::value</div>
<div class="line"><a name="l00381"></a><span class="lineno"> 381</span>  && !std::is_convertible<typename std::remove_reference<F>::type,</div>
<div class="line"><a name="l00382"></a><span class="lineno"> 382</span>  <span class="keyword">const</span> Callback::CallbackArg<bool&>*>::value>::type></div>
<div class="line"><a name="l00383"></a><span class="lineno"><a class="code" href="group__io__watch.html#ga329248433390b3e82aaf4fe3369a40a5"> 383</a></span> guint <a class="code" href="group__io__watch.html#gaa908dd5f3e3fd9e0d2cd9403884cad40">start_iowatch</a>(<span class="keywordtype">int</span> fd, F&& func,</div>
<div class="line"><a name="l00384"></a><span class="lineno"> 384</span>  GIOCondition io_condition, gint priority = G_PRIORITY_DEFAULT,</div>
<div class="line"><a name="l00385"></a><span class="lineno"> 385</span>  GMainContext* context = 0) {</div>
<div class="line"><a name="l00386"></a><span class="lineno"> 386</span>  <span class="keywordflow">return</span> <a class="code" href="group__io__watch.html#gaa908dd5f3e3fd9e0d2cd9403884cad40">start_iowatch</a>(fd, Callback::lambda<GIOCondition, bool&>(std::forward<F>(func)),</div>
<div class="line"><a name="l00387"></a><span class="lineno"> 387</span>  io_condition, priority,</div>
<div class="line"><a name="l00388"></a><span class="lineno"> 388</span>  context);</div>
<div class="line"><a name="l00389"></a><span class="lineno"> 389</span> }</div>
<div class="line"><a name="l00390"></a><span class="lineno"> 390</span> <span class="comment"></span></div>
<div class="line"><a name="l00391"></a><span class="lineno"> 391</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00392"></a><span class="lineno"> 392</span> <span class="comment"> * Starts an io watch in the glib main loop on a file descriptor, and</span></div>
<div class="line"><a name="l00393"></a><span class="lineno"> 393</span> <span class="comment"> * executes a callable object if the condition in io_condition is met.</span></div>
<div class="line"><a name="l00394"></a><span class="lineno"> 394</span> <span class="comment"> * It provides the GIOCondition status which caused the callback to be</span></div>
<div class="line"><a name="l00395"></a><span class="lineno"> 395</span> <span class="comment"> * invoked as the first unbound argument of the callable object, and</span></div>
<div class="line"><a name="l00396"></a><span class="lineno"> 396</span> <span class="comment"> * the second is a bool& argument which if set to 'true' will cause</span></div>
<div class="line"><a name="l00397"></a><span class="lineno"> 397</span> <span class="comment"> * the io watch to end. This version provides for automatic watch</span></div>
<div class="line"><a name="l00398"></a><span class="lineno"> 398</span> <span class="comment"> * disconnection if an object whose function the callback represents</span></div>
<div class="line"><a name="l00399"></a><span class="lineno"> 399</span> <span class="comment"> * or calls into is destroyed, via the Releaser object. It is</span></div>
<div class="line"><a name="l00400"></a><span class="lineno"> 400</span> <span class="comment"> * thread-safe (it may be called in any thread) provided that, if glib</span></div>
<div class="line"><a name="l00401"></a><span class="lineno"> 401</span> <span class="comment"> * < 2.32 is used, g_thread_init() has been called. glib >= 2.32 does</span></div>
<div class="line"><a name="l00402"></a><span class="lineno"> 402</span> <span class="comment"> * not require g_thread_init() to be called to be thread-safe.</span></div>
<div class="line"><a name="l00403"></a><span class="lineno"> 403</span> <span class="comment"> * @param fd The file descriptor.</span></div>
<div class="line"><a name="l00404"></a><span class="lineno"> 404</span> <span class="comment"> * @param func A callable object, such as formed by a lambda</span></div>
<div class="line"><a name="l00405"></a><span class="lineno"> 405</span> <span class="comment"> * expression or the result of std::bind. It should take two unbound</span></div>
<div class="line"><a name="l00406"></a><span class="lineno"> 406</span> <span class="comment"> * arguments of type 'GIOCondition' and 'bool&'.</span></div>
<div class="line"><a name="l00407"></a><span class="lineno"> 407</span> <span class="comment"> * @param r A Releaser object which the protected object has as a</span></div>
<div class="line"><a name="l00408"></a><span class="lineno"> 408</span> <span class="comment"> * public member.</span></div>
<div class="line"><a name="l00409"></a><span class="lineno"> 409</span> <span class="comment"> * @param io_condition The condition to be watched for (G_IO_IN may be</span></div>
<div class="line"><a name="l00410"></a><span class="lineno"> 410</span> <span class="comment"> * bitwise-ored with G_IO_HUP, and G_IO_IN and G_IO_OUT may be</span></div>
<div class="line"><a name="l00411"></a><span class="lineno"> 411</span> <span class="comment"> * bitwise-ored with G_IO_ERR).</span></div>
<div class="line"><a name="l00412"></a><span class="lineno"> 412</span> <span class="comment"> * @param priority The priority to be given to the watch in the main</span></div>
<div class="line"><a name="l00413"></a><span class="lineno"> 413</span> <span class="comment"> * loop. In ascending order of priorities, priorities are</span></div>
<div class="line"><a name="l00414"></a><span class="lineno"> 414</span> <span class="comment"> * G_PRIORITY_LOW, G_PRIORITY_DEFAULT_IDLE, G_PRIORITY_HIGH_IDLE,</span></div>
<div class="line"><a name="l00415"></a><span class="lineno"> 415</span> <span class="comment"> * G_PRIORITY_DEFAULT and G_PRIORITY_HIGH. The default is</span></div>
<div class="line"><a name="l00416"></a><span class="lineno"> 416</span> <span class="comment"> * G_PRIORITY_DEFAULT. This determines the order in which the</span></div>
<div class="line"><a name="l00417"></a><span class="lineno"> 417</span> <span class="comment"> * callback will appear in the event list in the main loop, not the</span></div>
<div class="line"><a name="l00418"></a><span class="lineno"> 418</span> <span class="comment"> * priority which the OS will adopt</span></div>
<div class="line"><a name="l00419"></a><span class="lineno"> 419</span> <span class="comment"> * @param context The glib main context to which the watch is to be</span></div>
<div class="line"><a name="l00420"></a><span class="lineno"> 420</span> <span class="comment"> * attached (the default of NULL will cause the watch to be attached</span></div>
<div class="line"><a name="l00421"></a><span class="lineno"> 421</span> <span class="comment"> * to the main program loop, and this is almost always what is</span></div>
<div class="line"><a name="l00422"></a><span class="lineno"> 422</span> <span class="comment"> * wanted).</span></div>
<div class="line"><a name="l00423"></a><span class="lineno"> 423</span> <span class="comment"> * @return The glib source id of the watch.</span></div>
<div class="line"><a name="l00424"></a><span class="lineno"> 424</span> <span class="comment"> * @exception std::bad_alloc The function might throw std::bad_alloc</span></div>
<div class="line"><a name="l00425"></a><span class="lineno"> 425</span> <span class="comment"> * if memory is exhausted and the system throws in that case.</span></div>
<div class="line"><a name="l00426"></a><span class="lineno"> 426</span> <span class="comment"> * @exception Cgu::Thread::MutexError This function might throw</span></div>
<div class="line"><a name="l00427"></a><span class="lineno"> 427</span> <span class="comment"> * Cgu:Thread::MutexError if initialisation of the mutex in a</span></div>
<div class="line"><a name="l00428"></a><span class="lineno"> 428</span> <span class="comment"> * SafeEmitterArg object constructed by this method fails. (It is</span></div>
<div class="line"><a name="l00429"></a><span class="lineno"> 429</span> <span class="comment"> * often not worth checking for this exception, as it means either</span></div>
<div class="line"><a name="l00430"></a><span class="lineno"> 430</span> <span class="comment"> * memory is exhausted or pthread has run out of other resources to</span></div>
<div class="line"><a name="l00431"></a><span class="lineno"> 431</span> <span class="comment"> * create new mutexes.)</span></div>
<div class="line"><a name="l00432"></a><span class="lineno"> 432</span> <span class="comment"> * @note 1. This function may also throw if the copy or move</span></div>
<div class="line"><a name="l00433"></a><span class="lineno"> 433</span> <span class="comment"> * constructor of the callable object throws.</span></div>
<div class="line"><a name="l00434"></a><span class="lineno"> 434</span> <span class="comment"> * @note 2. Cancellation of the thread to which the watch is attached</span></div>
<div class="line"><a name="l00435"></a><span class="lineno"> 435</span> <span class="comment"> * is blocked during execution of the callback.</span></div>
<div class="line"><a name="l00436"></a><span class="lineno"> 436</span> <span class="comment"> * @ingroup io_watch</span></div>
<div class="line"><a name="l00437"></a><span class="lineno"> 437</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00438"></a><span class="lineno"> 438</span> <span class="comment"> * Since 2.1.0</span></div>
<div class="line"><a name="l00439"></a><span class="lineno"> 439</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00440"></a><span class="lineno"> 440</span> <span class="comment">// we need to use enable_if so that where this function is passed a</span></div>
<div class="line"><a name="l00441"></a><span class="lineno"> 441</span> <span class="comment">// pointer to non-const Callback::CallbackArg, or some other</span></div>
<div class="line"><a name="l00442"></a><span class="lineno"> 442</span> <span class="comment">// convertible pointer, this templated overload is dropped from the</span></div>
<div class="line"><a name="l00443"></a><span class="lineno"> 443</span> <span class="comment">// overload set, in order to support the Callback::CallbackArg pointer</span></div>
<div class="line"><a name="l00444"></a><span class="lineno"> 444</span> <span class="comment">// overloads of this function. This overload calls into the version</span></div>
<div class="line"><a name="l00445"></a><span class="lineno"> 445</span> <span class="comment">// of this function taking a pointer to const Callback::CallbackArg in</span></div>
<div class="line"><a name="l00446"></a><span class="lineno"> 446</span> <span class="comment">// order to perform type erasure.</span></div>
<div class="line"><a name="l00447"></a><span class="lineno"> 447</span> <span class="keyword">template</span> <<span class="keyword">class </span>F,</div>
<div class="line"><a name="l00448"></a><span class="lineno"> 448</span>  <span class="keyword">class </span>= <span class="keyword">typename</span> std::enable_if<!std::is_convertible<typename std::remove_reference<F>::type,</div>
<div class="line"><a name="l00449"></a><span class="lineno"> 449</span>  <span class="keyword">const</span> Callback::CallbackArg<GIOCondition, bool&>*>::value</div>
<div class="line"><a name="l00450"></a><span class="lineno"> 450</span>  && !std::is_convertible<typename std::remove_reference<F>::type,</div>
<div class="line"><a name="l00451"></a><span class="lineno"> 451</span>  <span class="keyword">const</span> Callback::CallbackArg<bool&>*>::value>::type></div>
<div class="line"><a name="l00452"></a><span class="lineno"><a class="code" href="group__io__watch.html#gaca6e9357ba9557d1e2edaebae009c5fe"> 452</a></span> guint <a class="code" href="group__io__watch.html#gaa908dd5f3e3fd9e0d2cd9403884cad40">start_iowatch</a>(<span class="keywordtype">int</span> fd, F&& func, <a class="code" href="classCgu_1_1Releaser.html" title="A class used for tracking EmitterArg and SafeEmitterArg connections. ">Releaser</a>& r,</div>
<div class="line"><a name="l00453"></a><span class="lineno"> 453</span>  GIOCondition io_condition, gint priority = G_PRIORITY_DEFAULT,</div>
<div class="line"><a name="l00454"></a><span class="lineno"> 454</span>  GMainContext* context = 0) {</div>
<div class="line"><a name="l00455"></a><span class="lineno"> 455</span>  <span class="keywordflow">return</span> <a class="code" href="group__io__watch.html#gaa908dd5f3e3fd9e0d2cd9403884cad40">start_iowatch</a>(fd, Callback::lambda<GIOCondition, bool&>(std::forward<F>(func)), r,</div>
<div class="line"><a name="l00456"></a><span class="lineno"> 456</span>  io_condition, priority,</div>
<div class="line"><a name="l00457"></a><span class="lineno"> 457</span>  context);</div>
<div class="line"><a name="l00458"></a><span class="lineno"> 458</span> }</div>
<div class="line"><a name="l00459"></a><span class="lineno"> 459</span> </div>
<div class="line"><a name="l00460"></a><span class="lineno"> 460</span> } <span class="comment">// namespace Cgu</span></div>
<div class="line"><a name="l00461"></a><span class="lineno"> 461</span> </div>
<div class="line"><a name="l00462"></a><span class="lineno"> 462</span> <span class="preprocessor">#endif</span></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Sep 16 2013 20:45:30 for c++-gtk-utils by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.4
</small></address>
</body>
</html>
