<!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: pipes.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">pipes.h</div> </div> </div><!--header--> <div class="contents"> <a href="pipes_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) 1999 to 2004, and 2009 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_PIPES_H</span></div> <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor"></span><span class="preprocessor">#define CGU_PIPES_H</span></div> <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include <unistd.h></span></div> <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div> <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#include <exception></span></div> <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div> <div class="line"><a name="l00032"></a><span class="lineno"> 32</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="l00033"></a><span class="lineno"> 33</span> </div> <div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="keyword">namespace </span>Cgu {</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">/**</span></div> <div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"> * @class PipeFifo pipes.h c++-gtk-utils/pipes.h</span></div> <div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> * @brief A wrapper for unix anonymous pipes.</span></div> <div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"> * @sa SyncPipe</span></div> <div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"> *</span></div> <div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"> * This class provides a simplified front end for anonymous fifo pipes</span></div> <div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"> * (as created by the pipe() system call). The constructor of the</span></div> <div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"> * class may be passed an enumerator to indicate whether the pipe is</span></div> <div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"> * to read in non-blocking mode.</span></div> <div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"> *</span></div> <div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"> * With the write(const char*, int) method, taking an array and int</span></div> <div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"> * arguments, the value of int (indicating the number of chars in the</span></div> <div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> * array to be written) should usually be less than PIPE_BUF, as POSIX</span></div> <div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"> * write() guarantees that if it is less than PIPE_BUF, either all</span></div> <div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"> * will be written or, if the pipe is too full, none will be written.</span></div> <div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"> * This prevents data interleaving if a number of independent writes</span></div> <div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment"> * to the fifo are made. The same is true of the write (const char*)</span></div> <div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment"> * method taking a string - if the string is longer than PIPE_BUF in</span></div> <div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"> * size, data interleaving may occur.</span></div> <div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"> *</span></div> <div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"> * The pipe is set to read in non-blocking mode if the constructor of</span></div> <div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"> * PipeFifo, or PipeFifo::open(), is passed the value</span></div> <div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"> * PipeFifo::non_block. If constructed in this way, the pipe can also</span></div> <div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"> * be set to write in non-block mode (eg to minimise the impact on</span></div> <div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"> * another program running in a child process to which the child</span></div> <div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"> * process has exec()ed when monitoring its stdin or stderr) by</span></div> <div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"> * calling make_write_non_block(). However use this very sparingly --</span></div> <div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"> * when set in this way write() will always try to write something.</span></div> <div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"> * The atomic guarantees mentioned in the preceding paragraph do not</span></div> <div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"> * apply and data can be interleaved or lost.</span></div> <div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"> *</span></div> <div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"> * PIPE_BUF is defined in limits.h, and is at least 512 bytes, and</span></div> <div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"> * usually 4096 bytes, but may be calculated from other files included</span></div> <div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment"> * by limits.h.</span></div> <div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment"> *</span></div> <div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment"> * Where a pipe is used to communicate between parent and child after</span></div> <div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment"> * a call to fork(), the pipe will normally be used unidirectionally</span></div> <div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment"> * unless guards or semaphores are used to prevent a process reading</span></div> <div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment"> * data intended for the other. However, because each process</span></div> <div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment"> * inherits its own duplicate of the file descriptors, this cannot be</span></div> <div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment"> * enforced without closing the read or write file descriptor for the</span></div> <div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment"> * process for which the reading or writing is to be prohibited. This</span></div> <div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment"> * can be done by the process concerned calling the methods</span></div> <div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment"> * PipeFifo::make_writeonly() or PipeFifo::make_readonly() after the</span></div> <div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment"> * fork. If an attempt is made to read or write to a descriptor</span></div> <div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment"> * closed in this way, the PipeFifo::read() or PipeFifo::write()</span></div> <div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment"> * method will ensure that no read or write will take place, and</span></div> <div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment"> * instead -2 will be returned.</span></div> <div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="comment"> *</span></div> <div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="comment"> * The methods PipeFifo::connect_to_stdin(),</span></div> <div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment"> * PipeFifo::connect_to_stdout() and PipeFifo::connect_to_stderr() are</span></div> <div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment"> * available to be used in the child process before it exec()s another</span></div> <div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="comment"> * program so as to connect the pipe to that program's stdin, stdout</span></div> <div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment"> * or stderr. PipeFifo::connect_to_stdin() cannot be used by a</span></div> <div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment"> * process after that process has called PipeFifo::make_writeonly(),</span></div> <div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="comment"> * and PipeFifo::connect_to_stdout() and PipeFifo::connect_to_stderr()</span></div> <div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="comment"> * cannot be used after the process has called</span></div> <div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment"> * PipeFifo::make_readonly(), nor can a pipe in any one process be</span></div> <div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment"> * connected to more than one of stdin, stdout or stderr. If that is</span></div> <div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment"> * attempted the methods will return -2. Furthermore, they should</span></div> <div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="comment"> * only be used after the process creating the pipe has forked. If</span></div> <div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="comment"> * the connection to stdin, stdout or stderr is to be made before the</span></div> <div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment"> * fork, this must be done by hand using dup2(),</span></div> <div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment"> * PipeFifo::get_write_fd()/ PipeFifo::get_read_fd() and</span></div> <div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="comment"> * PipeFifo::make_read_only()/ PipeFifo::make_write_only().</span></div> <div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="comment"> *</span></div> <div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="comment"> * If PipeFifo::connect_to_stdin() is called by a method,</span></div> <div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="comment"> * PipeFifo::make_readonly() will also be called, and if</span></div> <div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="comment"> * PipeFifo::connect_to_stdout() or PipeFifo::connect_to_stderr() are</span></div> <div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment"> * called, PipeFifo::make_writeonly() will also be called. This will</span></div> <div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment"> * isolate the use of the pipe by the child process to stdin, stdout</span></div> <div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="comment"> * or stderr, as appropriate.</span></div> <div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="comment"> *</span></div> <div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment"> * It uses no static members, so is thread safe as between different</span></div> <div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="comment"> * objects, but its methods are not thread safe as regards any one</span></div> <div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="comment"> * object in the sense that the read() and write() methods check the</span></div> <div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="comment"> * value of read_fd and write_fd respectively (and get_read_fd() and</span></div> <div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="comment"> * get_write_fd() return them), and make_writeonly(), make_readonly(),</span></div> <div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="comment"> * close(), connect_to_stdin(), open(), connect_to_stdout() and</span></div> <div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="comment"> * connect_to_stderr() change those values. Likewise the read() and</span></div> <div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="comment"> * write() methods access read_blocking_mode and write_blocking_mode</span></div> <div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="comment"> * respectively, and these are changed by open() and</span></div> <div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="comment"> * make_write_non_block(). Provided there is no concurrent use of</span></div> <div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="comment"> * read(), write(), get_read_fd() or get_write_fd() in one thread with</span></div> <div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="comment"> * a call of a method which changes read_fd, write_fd,</span></div> <div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="comment"> * read_blocking_mode or write_blocking_mode as described above in</span></div> <div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="comment"> * another thread then no mutex is required to ensure thread safety.</span></div> <div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="comment"> *</span></div> <div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="comment"> * All the read() and write() methods check for an interruption of the</span></div> <div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="comment"> * system call from a signal (EINTR is checked), and will continue to</span></div> <div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="comment"> * read() or write() where necessary. Users do not need to check</span></div> <div class="line"><a name="l00127"></a><span class="lineno"> 127</span> <span class="comment"> * EINTR themselves. Where the write file descriptor is flagged as</span></div> <div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="comment"> * blocking (that is, where PipeFifo::make_write_non_block() has not</span></div> <div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="comment"> * been called), then in the absence of some other error, everything</span></div> <div class="line"><a name="l00130"></a><span class="lineno"> 130</span> <span class="comment"> * passed to PipeFifo::write() will be written (but as mentioned above</span></div> <div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="comment"> * there may be data interleaving if this is greater than PIPE_BUF in</span></div> <div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="comment"> * size). Where the write file descriptor is flagged as non-blocking,</span></div> <div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="comment"> * then the result of Unix write is returned, and less bytes than</span></div> <div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="comment"> * those passed to PipeFifo::write() may have been written, or -1 may</span></div> <div class="line"><a name="l00135"></a><span class="lineno"> 135</span> <span class="comment"> * be returned with errno set to EAGAIN - it is for the user to check</span></div> <div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="comment"> * this.</span></div> <div class="line"><a name="l00137"></a><span class="lineno"> 137</span> <span class="comment"> *</span></div> <div class="line"><a name="l00138"></a><span class="lineno"> 138</span> <span class="comment"> * If you are using pipes to write and read between processes, you</span></div> <div class="line"><a name="l00139"></a><span class="lineno"> 139</span> <span class="comment"> * will probably want to call sigaction() to cause the SIGPIPE signal</span></div> <div class="line"><a name="l00140"></a><span class="lineno"> 140</span> <span class="comment"> * to be ignored. SIGPIPE has little use in most programming: if</span></div> <div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="comment"> * SIGPIPE is ignored, and an attempt is made to write to a pipe which</span></div> <div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="comment"> * has been closed at the read end, then the write will return -1 and</span></div> <div class="line"><a name="l00143"></a><span class="lineno"> 143</span> <span class="comment"> * errno will be set to EPIPE.</span></div> <div class="line"><a name="l00144"></a><span class="lineno"> 144</span> <span class="comment"> */</span></div> <div class="line"><a name="l00145"></a><span class="lineno"> 145</span> </div> <div class="line"><a name="l00146"></a><span class="lineno"><a class="code" href="structCgu_1_1PipeError.html"> 146</a></span> <span class="keyword">struct </span><a class="code" href="structCgu_1_1PipeError.html">PipeError</a>: <span class="keyword">public</span> std::exception {</div> <div class="line"><a name="l00147"></a><span class="lineno"><a class="code" href="structCgu_1_1PipeError.html#ac1d2af374cd3a3031d3e021135cc3d05"> 147</a></span>  <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="structCgu_1_1PipeError.html#ac1d2af374cd3a3031d3e021135cc3d05">what</a>() <span class="keyword">const</span> throw() {<span class="keywordflow">return</span> <span class="stringliteral">"PipeError: error opening pipe\n"</span>;}</div> <div class="line"><a name="l00148"></a><span class="lineno"> 148</span> };</div> <div class="line"><a name="l00149"></a><span class="lineno"> 149</span> </div> <div class="line"><a name="l00150"></a><span class="lineno"><a class="code" href="classCgu_1_1PipeFifo.html"> 150</a></span> <span class="keyword">class </span><a class="code" href="classCgu_1_1PipeFifo.html" title="A wrapper for unix anonymous pipes. ">PipeFifo</a> {</div> <div class="line"><a name="l00151"></a><span class="lineno"> 151</span> <span class="keyword">public</span>:</div> <div class="line"><a name="l00152"></a><span class="lineno"><a class="code" href="classCgu_1_1PipeFifo.html#acb41a1e4ea6cb5d2733f41d91f8df1bca542743e3f2662abb9679019c05c7928e"> 152</a></span>  <span class="keyword">enum</span> <a class="code" href="classCgu_1_1PipeFifo.html#acb41a1e4ea6cb5d2733f41d91f8df1bc">Fifo_mode</a>{<a class="code" href="classCgu_1_1PipeFifo.html#acb41a1e4ea6cb5d2733f41d91f8df1bca167bf6b62f67560f2f96c376bf117c96">block</a>, <a class="code" href="classCgu_1_1PipeFifo.html#acb41a1e4ea6cb5d2733f41d91f8df1bca542743e3f2662abb9679019c05c7928e">non_block</a>};</div> <div class="line"><a name="l00153"></a><span class="lineno"> 153</span> <span class="keyword">private</span>:</div> <div class="line"><a name="l00154"></a><span class="lineno"> 154</span>  <span class="keywordtype">int</span> read_fd;</div> <div class="line"><a name="l00155"></a><span class="lineno"> 155</span>  <span class="keywordtype">int</span> write_fd;</div> <div class="line"><a name="l00156"></a><span class="lineno"> 156</span>  <a class="code" href="classCgu_1_1PipeFifo.html#acb41a1e4ea6cb5d2733f41d91f8df1bc">Fifo_mode</a> read_blocking_mode;</div> <div class="line"><a name="l00157"></a><span class="lineno"> 157</span>  <a class="code" href="classCgu_1_1PipeFifo.html#acb41a1e4ea6cb5d2733f41d91f8df1bc">Fifo_mode</a> write_blocking_mode;</div> <div class="line"><a name="l00158"></a><span class="lineno"> 158</span> </div> <div class="line"><a name="l00159"></a><span class="lineno"> 159</span> <span class="keyword">public</span>:<span class="comment"></span></div> <div class="line"><a name="l00160"></a><span class="lineno"> 160</span> <span class="comment">/**</span></div> <div class="line"><a name="l00161"></a><span class="lineno"> 161</span> <span class="comment"> * This class cannot be copied. The copy constructor is deleted.</span></div> <div class="line"><a name="l00162"></a><span class="lineno"> 162</span> <span class="comment"> */</span></div> <div class="line"><a name="l00163"></a><span class="lineno"> 163</span>  <a class="code" href="classCgu_1_1PipeFifo.html#a0ad29a1c5d598be1cfeb8393e431b0a7">PipeFifo</a>(<span class="keyword">const</span> <a class="code" href="classCgu_1_1PipeFifo.html" title="A wrapper for unix anonymous pipes. ">PipeFifo</a>&) = <span class="keyword">delete</span>;</div> <div class="line"><a name="l00164"></a><span class="lineno"> 164</span> <span class="comment"></span></div> <div class="line"><a name="l00165"></a><span class="lineno"> 165</span> <span class="comment">/**</span></div> <div class="line"><a name="l00166"></a><span class="lineno"> 166</span> <span class="comment"> * This class cannot be copied. The assignment operator is deleted.</span></div> <div class="line"><a name="l00167"></a><span class="lineno"> 167</span> <span class="comment"> */</span></div> <div class="line"><a name="l00168"></a><span class="lineno"> 168</span>  <a class="code" href="classCgu_1_1PipeFifo.html" title="A wrapper for unix anonymous pipes. ">PipeFifo</a>& <a class="code" href="classCgu_1_1PipeFifo.html#a524040aff8303df0f40ee7acbb9b5570">operator=</a>(<span class="keyword">const</span> <a class="code" href="classCgu_1_1PipeFifo.html" title="A wrapper for unix anonymous pipes. ">PipeFifo</a>&) = <span class="keyword">delete</span>;</div> <div class="line"><a name="l00169"></a><span class="lineno"> 169</span> <span class="comment"></span></div> <div class="line"><a name="l00170"></a><span class="lineno"> 170</span> <span class="comment">/**</span></div> <div class="line"><a name="l00171"></a><span class="lineno"> 171</span> <span class="comment"> * Opens read and write file descriptors for the pipe. If the pipe is</span></div> <div class="line"><a name="l00172"></a><span class="lineno"> 172</span> <span class="comment"> * already open, it will close the existing file descriptors. This</span></div> <div class="line"><a name="l00173"></a><span class="lineno"> 173</span> <span class="comment"> * function call is thread-safe to the extent that all the system</span></div> <div class="line"><a name="l00174"></a><span class="lineno"> 174</span> <span class="comment"> * calls made in its implementation are async-signal-safe, so it may</span></div> <div class="line"><a name="l00175"></a><span class="lineno"> 175</span> <span class="comment"> * safely be called in a multi-threaded program after a fork() and</span></div> <div class="line"><a name="l00176"></a><span class="lineno"> 176</span> <span class="comment"> * before an exec(). However, the manipulation of the file</span></div> <div class="line"><a name="l00177"></a><span class="lineno"> 177</span> <span class="comment"> * descriptors and related variables is not protected by a mutex, so</span></div> <div class="line"><a name="l00178"></a><span class="lineno"> 178</span> <span class="comment"> * if different threads in the same process are to manipulate the same</span></div> <div class="line"><a name="l00179"></a><span class="lineno"> 179</span> <span class="comment"> * pipe object with this method, close(), connect_to_stdin(),</span></div> <div class="line"><a name="l00180"></a><span class="lineno"> 180</span> <span class="comment"> * connect_to_stdout() or connect_to_stderr() (which manipulate both</span></div> <div class="line"><a name="l00181"></a><span class="lineno"> 181</span> <span class="comment"> * descriptors), make_readonly() or make_write_non_block() (which</span></div> <div class="line"><a name="l00182"></a><span class="lineno"> 182</span> <span class="comment"> * manipulate the write file descriptor), or make_writeonly() (which</span></div> <div class="line"><a name="l00183"></a><span class="lineno"> 183</span> <span class="comment"> * manipulates the read file descriptor), or read the value of the</span></div> <div class="line"><a name="l00184"></a><span class="lineno"> 184</span> <span class="comment"> * file descriptor with get_read_fd() or read() (which access the read</span></div> <div class="line"><a name="l00185"></a><span class="lineno"> 185</span> <span class="comment"> * file descriptor) or get_write_fd() or write() (which access the</span></div> <div class="line"><a name="l00186"></a><span class="lineno"> 186</span> <span class="comment"> * write file descriptor) concurrently with such a manipulation, then</span></div> <div class="line"><a name="l00187"></a><span class="lineno"> 187</span> <span class="comment"> * the user should provide appropriate synchronisation.</span></div> <div class="line"><a name="l00188"></a><span class="lineno"> 188</span> <span class="comment"> * @param mode The mode in which the read file descriptor of the pipe</span></div> <div class="line"><a name="l00189"></a><span class="lineno"> 189</span> <span class="comment"> * is to be opened - either Cgu::PipeFifo::block or</span></div> <div class="line"><a name="l00190"></a><span class="lineno"> 190</span> <span class="comment"> * Cgu::PipeFifo::non_block.</span></div> <div class="line"><a name="l00191"></a><span class="lineno"> 191</span> <span class="comment"> * @exception Cgu::PipeError This exception is thrown if the opening</span></div> <div class="line"><a name="l00192"></a><span class="lineno"> 192</span> <span class="comment"> * of the pipe fails. No other exceptions will be thrown.</span></div> <div class="line"><a name="l00193"></a><span class="lineno"> 193</span> <span class="comment"> */</span></div> <div class="line"><a name="l00194"></a><span class="lineno"> 194</span>  <span class="keywordtype">void</span> <a class="code" href="classCgu_1_1PipeFifo.html#abc5ff3649425f430137a5f313b5ae960">open</a>(<a class="code" href="classCgu_1_1PipeFifo.html#acb41a1e4ea6cb5d2733f41d91f8df1bc">Fifo_mode</a> mode);</div> <div class="line"><a name="l00195"></a><span class="lineno"> 195</span> <span class="comment"></span></div> <div class="line"><a name="l00196"></a><span class="lineno"> 196</span> <span class="comment">/**</span></div> <div class="line"><a name="l00197"></a><span class="lineno"> 197</span> <span class="comment"> * Closes the read and write file descriptors of the pipe (if they are</span></div> <div class="line"><a name="l00198"></a><span class="lineno"> 198</span> <span class="comment"> * open). This function call is thread-safe to the extent that all</span></div> <div class="line"><a name="l00199"></a><span class="lineno"> 199</span> <span class="comment"> * the system calls made in its implementation are async-signal-safe,</span></div> <div class="line"><a name="l00200"></a><span class="lineno"> 200</span> <span class="comment"> * so it may safely be called in a multi-threaded program after a</span></div> <div class="line"><a name="l00201"></a><span class="lineno"> 201</span> <span class="comment"> * fork() and before an exec(). However, the manipulation of the file</span></div> <div class="line"><a name="l00202"></a><span class="lineno"> 202</span> <span class="comment"> * descriptors and related variables is not protected by a mutex, so</span></div> <div class="line"><a name="l00203"></a><span class="lineno"> 203</span> <span class="comment"> * if different threads in the same process are to manipulate the same</span></div> <div class="line"><a name="l00204"></a><span class="lineno"> 204</span> <span class="comment"> * pipe object with this method, open(), connect_to_stdin(),</span></div> <div class="line"><a name="l00205"></a><span class="lineno"> 205</span> <span class="comment"> * connect_to_stdout() or connect_to_stderr() (which manipulate both</span></div> <div class="line"><a name="l00206"></a><span class="lineno"> 206</span> <span class="comment"> * descriptors), make_readonly() or make_write_non_block() (which</span></div> <div class="line"><a name="l00207"></a><span class="lineno"> 207</span> <span class="comment"> * manipulate the write file descriptor), or make_writeonly() (which</span></div> <div class="line"><a name="l00208"></a><span class="lineno"> 208</span> <span class="comment"> * manipulates the read file descriptor), or read the value of the</span></div> <div class="line"><a name="l00209"></a><span class="lineno"> 209</span> <span class="comment"> * file descriptor with get_read_fd() or read() (which access the read</span></div> <div class="line"><a name="l00210"></a><span class="lineno"> 210</span> <span class="comment"> * file descriptor) or get_write_fd() or write() (which access the</span></div> <div class="line"><a name="l00211"></a><span class="lineno"> 211</span> <span class="comment"> * write file descriptor) concurrently with such a manipulation, then</span></div> <div class="line"><a name="l00212"></a><span class="lineno"> 212</span> <span class="comment"> * the user should provide appropriate synchronisation. No exceptions</span></div> <div class="line"><a name="l00213"></a><span class="lineno"> 213</span> <span class="comment"> * will be thrown.</span></div> <div class="line"><a name="l00214"></a><span class="lineno"> 214</span> <span class="comment"> */</span></div> <div class="line"><a name="l00215"></a><span class="lineno"> 215</span>  <span class="keywordtype">void</span> <a class="code" href="classCgu_1_1PipeFifo.html#a1d376e8a1a17071d3257a4e60516d211">close</a>();</div> <div class="line"><a name="l00216"></a><span class="lineno"> 216</span> <span class="comment"></span></div> <div class="line"><a name="l00217"></a><span class="lineno"> 217</span> <span class="comment">/**</span></div> <div class="line"><a name="l00218"></a><span class="lineno"> 218</span> <span class="comment"> * Reads up to max_num characters from the pipe. This read does not</span></div> <div class="line"><a name="l00219"></a><span class="lineno"> 219</span> <span class="comment"> * carry on blocking until the read request is met: unless there is an</span></div> <div class="line"><a name="l00220"></a><span class="lineno"> 220</span> <span class="comment"> * interrupt, it just calls POSIX read() once and takes what is</span></div> <div class="line"><a name="l00221"></a><span class="lineno"> 221</span> <span class="comment"> * available. If a specific number of characters is required, the</span></div> <div class="line"><a name="l00222"></a><span class="lineno"> 222</span> <span class="comment"> * user should provide an appropriate do/while loop. It does not</span></div> <div class="line"><a name="l00223"></a><span class="lineno"> 223</span> <span class="comment"> * throw. Any reasonable POSIX implementation will do an atomic read</span></div> <div class="line"><a name="l00224"></a><span class="lineno"> 224</span> <span class="comment"> * as between threads if max_num is PIPE_BUF or less in size, but the</span></div> <div class="line"><a name="l00225"></a><span class="lineno"> 225</span> <span class="comment"> * POSIX standard only requires such atomic reads as between processes</span></div> <div class="line"><a name="l00226"></a><span class="lineno"> 226</span> <span class="comment"> * rather than as between threads. The user does not need to check</span></div> <div class="line"><a name="l00227"></a><span class="lineno"> 227</span> <span class="comment"> * for EINTR and an interrupt: this method deals with that</span></div> <div class="line"><a name="l00228"></a><span class="lineno"> 228</span> <span class="comment"> * automatically. All the system calls made in its implementation are</span></div> <div class="line"><a name="l00229"></a><span class="lineno"> 229</span> <span class="comment"> * async-signal-safe, and it is re-entrant subject to errno being</span></div> <div class="line"><a name="l00230"></a><span class="lineno"> 230</span> <span class="comment"> * saved. This method does not throw.</span></div> <div class="line"><a name="l00231"></a><span class="lineno"> 231</span> <span class="comment"> * @param buf A buffer into which the characters will be placed.</span></div> <div class="line"><a name="l00232"></a><span class="lineno"> 232</span> <span class="comment"> * @param max_num The maximum number of characters to be read</span></div> <div class="line"><a name="l00233"></a><span class="lineno"> 233</span> <span class="comment"> * (normally the size of the buffer).</span></div> <div class="line"><a name="l00234"></a><span class="lineno"> 234</span> <span class="comment"> * @return -2 if the read file descriptor is invalid, otherwise the</span></div> <div class="line"><a name="l00235"></a><span class="lineno"> 235</span> <span class="comment"> * result of unix read() - that is, the number of characters read, or</span></div> <div class="line"><a name="l00236"></a><span class="lineno"> 236</span> <span class="comment"> * 0 if end of file is reached (ie the write descriptor has been</span></div> <div class="line"><a name="l00237"></a><span class="lineno"> 237</span> <span class="comment"> * closed), or -1 if there has been an error (but EINTR never returns</span></div> <div class="line"><a name="l00238"></a><span class="lineno"> 238</span> <span class="comment"> * as an error as the implementation handles that). In the event of</span></div> <div class="line"><a name="l00239"></a><span class="lineno"> 239</span> <span class="comment"> * an error, errno is set.</span></div> <div class="line"><a name="l00240"></a><span class="lineno"> 240</span> <span class="comment"> */</span></div> <div class="line"><a name="l00241"></a><span class="lineno"> 241</span>  ssize_t <a class="code" href="classCgu_1_1PipeFifo.html#a9c71bf38cf22b6b4197cd0da453e6bcf">read</a>(<span class="keywordtype">char</span>* buf, <span class="keywordtype">size_t</span> max_num);</div> <div class="line"><a name="l00242"></a><span class="lineno"> 242</span> <span class="comment"></span></div> <div class="line"><a name="l00243"></a><span class="lineno"> 243</span> <span class="comment">/**</span></div> <div class="line"><a name="l00244"></a><span class="lineno"> 244</span> <span class="comment"> * Extracts a character from the pipe. This method does not throw.</span></div> <div class="line"><a name="l00245"></a><span class="lineno"> 245</span> <span class="comment"> * All the system calls made in its implementation are</span></div> <div class="line"><a name="l00246"></a><span class="lineno"> 246</span> <span class="comment"> * async-signal-safe and it is re-entrant subject to errno being</span></div> <div class="line"><a name="l00247"></a><span class="lineno"> 247</span> <span class="comment"> * saved. It is thread safe.</span></div> <div class="line"><a name="l00248"></a><span class="lineno"> 248</span> <span class="comment"> * @return The character at the front of the pipe if available,</span></div> <div class="line"><a name="l00249"></a><span class="lineno"> 249</span> <span class="comment"> * otherwise -2 if the read file descriptor is invalid, 0 if end of</span></div> <div class="line"><a name="l00250"></a><span class="lineno"> 250</span> <span class="comment"> * file is reached (ie the write descriptor has been closed), or -1 if</span></div> <div class="line"><a name="l00251"></a><span class="lineno"> 251</span> <span class="comment"> * there has been an error (but EINTR never returns as an error as the</span></div> <div class="line"><a name="l00252"></a><span class="lineno"> 252</span> <span class="comment"> * implementation handles that). In the event of an error, errno is</span></div> <div class="line"><a name="l00253"></a><span class="lineno"> 253</span> <span class="comment"> * set.</span></div> <div class="line"><a name="l00254"></a><span class="lineno"> 254</span> <span class="comment"> */</span></div> <div class="line"><a name="l00255"></a><span class="lineno"> 255</span>  <span class="keywordtype">int</span> <a class="code" href="classCgu_1_1PipeFifo.html#a9c71bf38cf22b6b4197cd0da453e6bcf">read</a>(); </div> <div class="line"><a name="l00256"></a><span class="lineno"> 256</span> <span class="comment"></span></div> <div class="line"><a name="l00257"></a><span class="lineno"> 257</span> <span class="comment">/**</span></div> <div class="line"><a name="l00258"></a><span class="lineno"> 258</span> <span class="comment"> * Write a NUL terminated C string to the pipe, excluding the</span></div> <div class="line"><a name="l00259"></a><span class="lineno"> 259</span> <span class="comment"> * terminating NUL character. If the write file descriptor is set as</span></div> <div class="line"><a name="l00260"></a><span class="lineno"> 260</span> <span class="comment"> * blocking (the default) then this method will carry on blocking</span></div> <div class="line"><a name="l00261"></a><span class="lineno"> 261</span> <span class="comment"> * until everything is sent, even if it exceeds PIPE_BUF in size. Any</span></div> <div class="line"><a name="l00262"></a><span class="lineno"> 262</span> <span class="comment"> * reasonable POSIX implementation will do an atomic write (with no</span></div> <div class="line"><a name="l00263"></a><span class="lineno"> 263</span> <span class="comment"> * interleaving) as between threads if the number of characters in the</span></div> <div class="line"><a name="l00264"></a><span class="lineno"> 264</span> <span class="comment"> * string is PIPE_BUF or less in size, but the POSIX standard only</span></div> <div class="line"><a name="l00265"></a><span class="lineno"> 265</span> <span class="comment"> * requires such atomic writes as between processes rather than as</span></div> <div class="line"><a name="l00266"></a><span class="lineno"> 266</span> <span class="comment"> * between threads. All the system calls made in its implementation</span></div> <div class="line"><a name="l00267"></a><span class="lineno"> 267</span> <span class="comment"> * are async-signal-safe and it is re-entrant subject to errno being</span></div> <div class="line"><a name="l00268"></a><span class="lineno"> 268</span> <span class="comment"> * saved. This method does not throw.</span></div> <div class="line"><a name="l00269"></a><span class="lineno"> 269</span> <span class="comment"> * @param str The string to be written.</span></div> <div class="line"><a name="l00270"></a><span class="lineno"> 270</span> <span class="comment"> * @return -2 if write file descriptor invalid, otherwise it returns</span></div> <div class="line"><a name="l00271"></a><span class="lineno"> 271</span> <span class="comment"> * the number of bytes written or -1 if there has been an error (but</span></div> <div class="line"><a name="l00272"></a><span class="lineno"> 272</span> <span class="comment"> * EINTR never returns as an error as the implementation handles</span></div> <div class="line"><a name="l00273"></a><span class="lineno"> 273</span> <span class="comment"> * that). In the event of an error, errno is set.</span></div> <div class="line"><a name="l00274"></a><span class="lineno"> 274</span> <span class="comment"> */</span></div> <div class="line"><a name="l00275"></a><span class="lineno"> 275</span>  ssize_t <a class="code" href="classCgu_1_1PipeFifo.html#a4f2b456a83d722b2850a9c74a35fadef">write</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* str); </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">/**</span></div> <div class="line"><a name="l00278"></a><span class="lineno"> 278</span> <span class="comment"> * Write a buffer of characters to the pipe. If the write file</span></div> <div class="line"><a name="l00279"></a><span class="lineno"> 279</span> <span class="comment"> * descriptor is set as blocking (the default) then this method will</span></div> <div class="line"><a name="l00280"></a><span class="lineno"> 280</span> <span class="comment"> * carry on blocking until everything is sent, even if it exceeds</span></div> <div class="line"><a name="l00281"></a><span class="lineno"> 281</span> <span class="comment"> * PIPE_BUF in size. Any reasonable POSIX implementation will do an</span></div> <div class="line"><a name="l00282"></a><span class="lineno"> 282</span> <span class="comment"> * atomic write (with no interleaving) as between threads if num is</span></div> <div class="line"><a name="l00283"></a><span class="lineno"> 283</span> <span class="comment"> * PIPE_BUF or less in size, but the POSIX standard only requires such</span></div> <div class="line"><a name="l00284"></a><span class="lineno"> 284</span> <span class="comment"> * atomic writes as between processes rather than as between threads.</span></div> <div class="line"><a name="l00285"></a><span class="lineno"> 285</span> <span class="comment"> * All the system calls made in its implementation are</span></div> <div class="line"><a name="l00286"></a><span class="lineno"> 286</span> <span class="comment"> * async-signal-safe and it is re-entrant subject to errno being</span></div> <div class="line"><a name="l00287"></a><span class="lineno"> 287</span> <span class="comment"> * saved. This method does not throw.</span></div> <div class="line"><a name="l00288"></a><span class="lineno"> 288</span> <span class="comment"> * @param buf The buffer to be written.</span></div> <div class="line"><a name="l00289"></a><span class="lineno"> 289</span> <span class="comment"> * @param num The number of characters in the buffer.</span></div> <div class="line"><a name="l00290"></a><span class="lineno"> 290</span> <span class="comment"> * @return -2 if write file descriptor invalid, otherwise it returns</span></div> <div class="line"><a name="l00291"></a><span class="lineno"> 291</span> <span class="comment"> * the number of bytes written or -1 if there has been an error (but</span></div> <div class="line"><a name="l00292"></a><span class="lineno"> 292</span> <span class="comment"> * EINTR never returns as an error as the implementation handles</span></div> <div class="line"><a name="l00293"></a><span class="lineno"> 293</span> <span class="comment"> * that). In the event of an error, errno is set.</span></div> <div class="line"><a name="l00294"></a><span class="lineno"> 294</span> <span class="comment"> */</span></div> <div class="line"><a name="l00295"></a><span class="lineno"> 295</span>  ssize_t <a class="code" href="classCgu_1_1PipeFifo.html#a4f2b456a83d722b2850a9c74a35fadef">write</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* buf, <span class="keywordtype">size_t</span> num);</div> <div class="line"><a name="l00296"></a><span class="lineno"> 296</span> <span class="comment"></span></div> <div class="line"><a name="l00297"></a><span class="lineno"> 297</span> <span class="comment">/**</span></div> <div class="line"><a name="l00298"></a><span class="lineno"> 298</span> <span class="comment"> * Write a character to the pipe. All the system calls made in its</span></div> <div class="line"><a name="l00299"></a><span class="lineno"> 299</span> <span class="comment"> * implementation are async-signal-safe and it is re-entrant subject</span></div> <div class="line"><a name="l00300"></a><span class="lineno"> 300</span> <span class="comment"> * to errno being saved. This method does not throw. It is thread</span></div> <div class="line"><a name="l00301"></a><span class="lineno"> 301</span> <span class="comment"> * safe.</span></div> <div class="line"><a name="l00302"></a><span class="lineno"> 302</span> <span class="comment"> * @param item The character to be written.</span></div> <div class="line"><a name="l00303"></a><span class="lineno"> 303</span> <span class="comment"> * @return 1 if the character was written, -2 if the write file</span></div> <div class="line"><a name="l00304"></a><span class="lineno"> 304</span> <span class="comment"> * descriptor is invalid, or -1 if there has been an error (but EINTR</span></div> <div class="line"><a name="l00305"></a><span class="lineno"> 305</span> <span class="comment"> * never returns as an error as the implementation handles that). In</span></div> <div class="line"><a name="l00306"></a><span class="lineno"> 306</span> <span class="comment"> * the event of an error, errno is set.</span></div> <div class="line"><a name="l00307"></a><span class="lineno"> 307</span> <span class="comment"> */</span></div> <div class="line"><a name="l00308"></a><span class="lineno"><a class="code" href="classCgu_1_1PipeFifo.html#a449a24f3743c219805a4f7ce71430b7c"> 308</a></span>  <span class="keywordtype">int</span> <a class="code" href="classCgu_1_1PipeFifo.html#a449a24f3743c219805a4f7ce71430b7c">write</a>(<span class="keywordtype">char</span> item) {<span class="keywordflow">return</span> <a class="code" href="classCgu_1_1PipeFifo.html#a449a24f3743c219805a4f7ce71430b7c">write</a>(&item, 1);}</div> <div class="line"><a name="l00309"></a><span class="lineno"> 309</span> <span class="comment"></span></div> <div class="line"><a name="l00310"></a><span class="lineno"> 310</span> <span class="comment">/**</span></div> <div class="line"><a name="l00311"></a><span class="lineno"> 311</span> <span class="comment"> * Make the pipe only available for writing in the calling process, by</span></div> <div class="line"><a name="l00312"></a><span class="lineno"> 312</span> <span class="comment"> * closing the read file descriptor. This function call is thread</span></div> <div class="line"><a name="l00313"></a><span class="lineno"> 313</span> <span class="comment"> * safe to the extent that all the system calls made in its</span></div> <div class="line"><a name="l00314"></a><span class="lineno"> 314</span> <span class="comment"> * implementation are async-signal-safe, so it may safely be called in</span></div> <div class="line"><a name="l00315"></a><span class="lineno"> 315</span> <span class="comment"> * a multi-threaded program after a fork() and before an exec().</span></div> <div class="line"><a name="l00316"></a><span class="lineno"> 316</span> <span class="comment"> * However, the manipulation of the file descriptor and related</span></div> <div class="line"><a name="l00317"></a><span class="lineno"> 317</span> <span class="comment"> * variables is not protected by a mutex, so if different threads in</span></div> <div class="line"><a name="l00318"></a><span class="lineno"> 318</span> <span class="comment"> * the same process are to manipulate the same pipe object with</span></div> <div class="line"><a name="l00319"></a><span class="lineno"> 319</span> <span class="comment"> * open(), close(), connect_to_stdin(), connect_to_stdout() or</span></div> <div class="line"><a name="l00320"></a><span class="lineno"> 320</span> <span class="comment"> * connect_to_stderr() (which manipulate both descriptors), or this</span></div> <div class="line"><a name="l00321"></a><span class="lineno"> 321</span> <span class="comment"> * method (which manipulates the read file descriptor), or read the</span></div> <div class="line"><a name="l00322"></a><span class="lineno"> 322</span> <span class="comment"> * value of the read file descriptor with get_read_fd() or read()</span></div> <div class="line"><a name="l00323"></a><span class="lineno"> 323</span> <span class="comment"> * concurrently with such a manipulation, then the user should provide</span></div> <div class="line"><a name="l00324"></a><span class="lineno"> 324</span> <span class="comment"> * appropriate synchronisation. No exceptions will be thrown.</span></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="keywordtype">void</span> <a class="code" href="classCgu_1_1PipeFifo.html#ab1f8fbc911e192191d1208f4ddad4247">make_writeonly</a>();</div> <div class="line"><a name="l00327"></a><span class="lineno"> 327</span> <span class="comment"></span></div> <div class="line"><a name="l00328"></a><span class="lineno"> 328</span> <span class="comment">/**</span></div> <div class="line"><a name="l00329"></a><span class="lineno"> 329</span> <span class="comment"> * Make the pipe only available for reading in the calling process, by</span></div> <div class="line"><a name="l00330"></a><span class="lineno"> 330</span> <span class="comment"> * closing the write file descriptor. This function call is</span></div> <div class="line"><a name="l00331"></a><span class="lineno"> 331</span> <span class="comment"> * thread-safe to the extent that all the system calls made in its</span></div> <div class="line"><a name="l00332"></a><span class="lineno"> 332</span> <span class="comment"> * implementation are async-signal-safe, so it may safely be called in</span></div> <div class="line"><a name="l00333"></a><span class="lineno"> 333</span> <span class="comment"> * a multi-threaded program after a fork() and before an exec().</span></div> <div class="line"><a name="l00334"></a><span class="lineno"> 334</span> <span class="comment"> * However, the manipulation of the file descriptor and related</span></div> <div class="line"><a name="l00335"></a><span class="lineno"> 335</span> <span class="comment"> * variables is not protected by a mutex, so if different threads in</span></div> <div class="line"><a name="l00336"></a><span class="lineno"> 336</span> <span class="comment"> * the same process are to manipulate the same pipe object with</span></div> <div class="line"><a name="l00337"></a><span class="lineno"> 337</span> <span class="comment"> * open(), close(), connect_to_stdin(), connect_to_stdout() or</span></div> <div class="line"><a name="l00338"></a><span class="lineno"> 338</span> <span class="comment"> * connect_to_stderr() (which manipulate both descriptors), or this</span></div> <div class="line"><a name="l00339"></a><span class="lineno"> 339</span> <span class="comment"> * method or make_write_non_block() (which manipulate the write file</span></div> <div class="line"><a name="l00340"></a><span class="lineno"> 340</span> <span class="comment"> * descriptor), or read the value of the write file descriptor with</span></div> <div class="line"><a name="l00341"></a><span class="lineno"> 341</span> <span class="comment"> * get_write_fd() or write() concurrently with such a manipulation,</span></div> <div class="line"><a name="l00342"></a><span class="lineno"> 342</span> <span class="comment"> * then the user should provide appropriate synchronisation. No</span></div> <div class="line"><a name="l00343"></a><span class="lineno"> 343</span> <span class="comment"> * exceptions will be thrown.</span></div> <div class="line"><a name="l00344"></a><span class="lineno"> 344</span> <span class="comment"> */</span></div> <div class="line"><a name="l00345"></a><span class="lineno"> 345</span>  <span class="keywordtype">void</span> <a class="code" href="classCgu_1_1PipeFifo.html#abe750ba5cb79f23cc01d06fa02a90785">make_readonly</a>();</div> <div class="line"><a name="l00346"></a><span class="lineno"> 346</span> <span class="comment"></span></div> <div class="line"><a name="l00347"></a><span class="lineno"> 347</span> <span class="comment">/**</span></div> <div class="line"><a name="l00348"></a><span class="lineno"> 348</span> <span class="comment"> * Makes the write file descriptor non-blocking. This is only very</span></div> <div class="line"><a name="l00349"></a><span class="lineno"> 349</span> <span class="comment"> * rarely needed. If the write file descriptor is set non-blocking,</span></div> <div class="line"><a name="l00350"></a><span class="lineno"> 350</span> <span class="comment"> * then there are no atomic write guarantees. This function call is</span></div> <div class="line"><a name="l00351"></a><span class="lineno"> 351</span> <span class="comment"> * thread safe to the extent that all the system calls made in its</span></div> <div class="line"><a name="l00352"></a><span class="lineno"> 352</span> <span class="comment"> * implementation are async-signal-safe, so it may safely be called in</span></div> <div class="line"><a name="l00353"></a><span class="lineno"> 353</span> <span class="comment"> * a multi-threaded program after a fork() and before an exec().</span></div> <div class="line"><a name="l00354"></a><span class="lineno"> 354</span> <span class="comment"> * However, the manipulation of the file descriptor and related</span></div> <div class="line"><a name="l00355"></a><span class="lineno"> 355</span> <span class="comment"> * variables is not protected by a mutex, so if different threads in</span></div> <div class="line"><a name="l00356"></a><span class="lineno"> 356</span> <span class="comment"> * the same process are to manipulate the same pipe object with</span></div> <div class="line"><a name="l00357"></a><span class="lineno"> 357</span> <span class="comment"> * open(), close(), connect_to_stdin(), connect_to_stdout() or</span></div> <div class="line"><a name="l00358"></a><span class="lineno"> 358</span> <span class="comment"> * connect_to_stderr() (which manipulate both descriptors), or this</span></div> <div class="line"><a name="l00359"></a><span class="lineno"> 359</span> <span class="comment"> * method or make_readonly() (which manipulate the write file</span></div> <div class="line"><a name="l00360"></a><span class="lineno"> 360</span> <span class="comment"> * descriptor), or read the value of the write file descriptor with</span></div> <div class="line"><a name="l00361"></a><span class="lineno"> 361</span> <span class="comment"> * get_write_fd() or write() concurrently with such a manipulation,</span></div> <div class="line"><a name="l00362"></a><span class="lineno"> 362</span> <span class="comment"> * then the user should provide appropriate synchronisation. No</span></div> <div class="line"><a name="l00363"></a><span class="lineno"> 363</span> <span class="comment"> * exceptions will be thrown.</span></div> <div class="line"><a name="l00364"></a><span class="lineno"> 364</span> <span class="comment"> * @return 0 if the write file descriptor is open, or -1 otherwise.</span></div> <div class="line"><a name="l00365"></a><span class="lineno"> 365</span> <span class="comment"> */</span></div> <div class="line"><a name="l00366"></a><span class="lineno"> 366</span>  <span class="keywordtype">int</span> <a class="code" href="classCgu_1_1PipeFifo.html#a0ce83319fdb28ce3b4d42eae9ba745dd">make_write_non_block</a>();</div> <div class="line"><a name="l00367"></a><span class="lineno"> 367</span> <span class="comment"></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"> * Get the read file descriptor (if any). The fetching of the file</span></div> <div class="line"><a name="l00370"></a><span class="lineno"> 370</span> <span class="comment"> * descriptor is not protected by a mutex, so if different threads in</span></div> <div class="line"><a name="l00371"></a><span class="lineno"> 371</span> <span class="comment"> * the same process are to manipulate the same pipe object with</span></div> <div class="line"><a name="l00372"></a><span class="lineno"> 372</span> <span class="comment"> * open(), close(), connect_to_stdin(), connect_to_stdout() or</span></div> <div class="line"><a name="l00373"></a><span class="lineno"> 373</span> <span class="comment"> * connect_to_stderr() (which manipulate both descriptors), or</span></div> <div class="line"><a name="l00374"></a><span class="lineno"> 374</span> <span class="comment"> * make_writeonly() (which manipulates the read file descriptor), or</span></div> <div class="line"><a name="l00375"></a><span class="lineno"> 375</span> <span class="comment"> * read the value of the file descriptor with this method or read()</span></div> <div class="line"><a name="l00376"></a><span class="lineno"> 376</span> <span class="comment"> * concurrently with such a manipulation, then the user should provide</span></div> <div class="line"><a name="l00377"></a><span class="lineno"> 377</span> <span class="comment"> * appropriate synchronisation. No exceptions will be thrown.</span></div> <div class="line"><a name="l00378"></a><span class="lineno"> 378</span> <span class="comment"> * @return The read file descriptor, or -1 is none is open. </span></div> <div class="line"><a name="l00379"></a><span class="lineno"> 379</span> <span class="comment"> */</span></div> <div class="line"><a name="l00380"></a><span class="lineno"><a class="code" href="classCgu_1_1PipeFifo.html#a45b11580c2224b18e11bd07f9b6625d3"> 380</a></span>  <span class="keywordtype">int</span> <a class="code" href="classCgu_1_1PipeFifo.html#a45b11580c2224b18e11bd07f9b6625d3">get_read_fd</a>()<span class="keyword"> const </span>{<span class="keywordflow">return</span> read_fd;}</div> <div class="line"><a name="l00381"></a><span class="lineno"> 381</span> <span class="comment"></span></div> <div class="line"><a name="l00382"></a><span class="lineno"> 382</span> <span class="comment">/**</span></div> <div class="line"><a name="l00383"></a><span class="lineno"> 383</span> <span class="comment"> * Get the write file descriptor (if any). The fetching of the file</span></div> <div class="line"><a name="l00384"></a><span class="lineno"> 384</span> <span class="comment"> * descriptor is not protected by a mutex, so if different threads in</span></div> <div class="line"><a name="l00385"></a><span class="lineno"> 385</span> <span class="comment"> * the same process are to manipulate the same pipe object with</span></div> <div class="line"><a name="l00386"></a><span class="lineno"> 386</span> <span class="comment"> * open(), close(), connect_to_stdin(), connect_to_stdout() or</span></div> <div class="line"><a name="l00387"></a><span class="lineno"> 387</span> <span class="comment"> * connect_to_stderr() (which manipulate both descriptors), or</span></div> <div class="line"><a name="l00388"></a><span class="lineno"> 388</span> <span class="comment"> * make_readonly() or make_write_non_block() (which manipulate the</span></div> <div class="line"><a name="l00389"></a><span class="lineno"> 389</span> <span class="comment"> * write file descriptor), or read the value of the file descriptor</span></div> <div class="line"><a name="l00390"></a><span class="lineno"> 390</span> <span class="comment"> * with this method or write() concurrently with such a manipulation,</span></div> <div class="line"><a name="l00391"></a><span class="lineno"> 391</span> <span class="comment"> * then the user should provide appropriate synchronisation. No</span></div> <div class="line"><a name="l00392"></a><span class="lineno"> 392</span> <span class="comment"> * exceptions will be thrown.</span></div> <div class="line"><a name="l00393"></a><span class="lineno"> 393</span> <span class="comment"> * @return The write file descriptor, or -1 is none is open.</span></div> <div class="line"><a name="l00394"></a><span class="lineno"> 394</span> <span class="comment"> */</span></div> <div class="line"><a name="l00395"></a><span class="lineno"><a class="code" href="classCgu_1_1PipeFifo.html#a9f1df4cad35d2726192f34a0c258ae78"> 395</a></span>  <span class="keywordtype">int</span> <a class="code" href="classCgu_1_1PipeFifo.html#a9f1df4cad35d2726192f34a0c258ae78">get_write_fd</a>()<span class="keyword"> const </span>{<span class="keywordflow">return</span> write_fd;}</div> <div class="line"><a name="l00396"></a><span class="lineno"> 396</span> <span class="comment"></span></div> <div class="line"><a name="l00397"></a><span class="lineno"> 397</span> <span class="comment">/**</span></div> <div class="line"><a name="l00398"></a><span class="lineno"> 398</span> <span class="comment"> * Connect the read file descriptor of the pipe to stdin. Once</span></div> <div class="line"><a name="l00399"></a><span class="lineno"> 399</span> <span class="comment"> * called, any read from stdin in the process which calls this method</span></div> <div class="line"><a name="l00400"></a><span class="lineno"> 400</span> <span class="comment"> * will be read from the pipe. It should only be called in a child</span></div> <div class="line"><a name="l00401"></a><span class="lineno"> 401</span> <span class="comment"> * process or parent process after a fork() where the PipeFifo object</span></div> <div class="line"><a name="l00402"></a><span class="lineno"> 402</span> <span class="comment"> * has been created in the parent process, and typically is called by</span></div> <div class="line"><a name="l00403"></a><span class="lineno"> 403</span> <span class="comment"> * the child process before one of the exec() functions is invoked by</span></div> <div class="line"><a name="l00404"></a><span class="lineno"> 404</span> <span class="comment"> * the child process. It should only be called once, and cannot be</span></div> <div class="line"><a name="l00405"></a><span class="lineno"> 405</span> <span class="comment"> * called after connect_to_stdout(), connect_to_stderr() or</span></div> <div class="line"><a name="l00406"></a><span class="lineno"> 406</span> <span class="comment"> * make_writeonly() has been called in the same process. Once called,</span></div> <div class="line"><a name="l00407"></a><span class="lineno"> 407</span> <span class="comment"> * the write file descriptor is no longer available to the process</span></div> <div class="line"><a name="l00408"></a><span class="lineno"> 408</span> <span class="comment"> * calling this method. Typically it would be used in order that when</span></div> <div class="line"><a name="l00409"></a><span class="lineno"> 409</span> <span class="comment"> * the new process image created by exec() reads from stdin, it reads</span></div> <div class="line"><a name="l00410"></a><span class="lineno"> 410</span> <span class="comment"> * from the pipe, and the parent process (or another child process)</span></div> <div class="line"><a name="l00411"></a><span class="lineno"> 411</span> <span class="comment"> * writes to the pipe. This function call is thread safe to the</span></div> <div class="line"><a name="l00412"></a><span class="lineno"> 412</span> <span class="comment"> * extent that all the system calls made in its implementation are</span></div> <div class="line"><a name="l00413"></a><span class="lineno"> 413</span> <span class="comment"> * async-signal-safe, so it may safely be called in a multi-threaded</span></div> <div class="line"><a name="l00414"></a><span class="lineno"> 414</span> <span class="comment"> * program after a fork() and before an exec(). However, the</span></div> <div class="line"><a name="l00415"></a><span class="lineno"> 415</span> <span class="comment"> * manipulation of the file descriptors and related variables is not</span></div> <div class="line"><a name="l00416"></a><span class="lineno"> 416</span> <span class="comment"> * protected by a mutex, so if different threads in the same process</span></div> <div class="line"><a name="l00417"></a><span class="lineno"> 417</span> <span class="comment"> * are to manipulate the same pipe object with this method, open(),</span></div> <div class="line"><a name="l00418"></a><span class="lineno"> 418</span> <span class="comment"> * close(), connect_to_stdout() or connect_to_stderr() (which</span></div> <div class="line"><a name="l00419"></a><span class="lineno"> 419</span> <span class="comment"> * manipulate both descriptors), make_readonly() or</span></div> <div class="line"><a name="l00420"></a><span class="lineno"> 420</span> <span class="comment"> * make_write_non_block() (which manipulate the write file</span></div> <div class="line"><a name="l00421"></a><span class="lineno"> 421</span> <span class="comment"> * descriptor), or make_writeonly() (which manipulates the read file</span></div> <div class="line"><a name="l00422"></a><span class="lineno"> 422</span> <span class="comment"> * descriptor), or read the value of the file descriptor with</span></div> <div class="line"><a name="l00423"></a><span class="lineno"> 423</span> <span class="comment"> * get_read_fd() or read() (which access the read file descriptor) or</span></div> <div class="line"><a name="l00424"></a><span class="lineno"> 424</span> <span class="comment"> * get_write_fd() or write() (which access the write file descriptor)</span></div> <div class="line"><a name="l00425"></a><span class="lineno"> 425</span> <span class="comment"> * concurrently with such a manipulation, then the user should provide</span></div> <div class="line"><a name="l00426"></a><span class="lineno"> 426</span> <span class="comment"> * appropriate synchronisation. It does not throw.</span></div> <div class="line"><a name="l00427"></a><span class="lineno"> 427</span> <span class="comment"> * @return -2 if the read file descriptor has previously been closed</span></div> <div class="line"><a name="l00428"></a><span class="lineno"> 428</span> <span class="comment"> * or this method, connect_to_stdout() or connect_to_stderr() has</span></div> <div class="line"><a name="l00429"></a><span class="lineno"> 429</span> <span class="comment"> * previously been called in the same process, otherwise it returns</span></div> <div class="line"><a name="l00430"></a><span class="lineno"> 430</span> <span class="comment"> * the value returned by dup2(), that is 0 if the operation succeeds,</span></div> <div class="line"><a name="l00431"></a><span class="lineno"> 431</span> <span class="comment"> * or -1 (with errno set) if not. It does not throw.</span></div> <div class="line"><a name="l00432"></a><span class="lineno"> 432</span> <span class="comment"> */</span></div> <div class="line"><a name="l00433"></a><span class="lineno"> 433</span>  <span class="keywordtype">int</span> <a class="code" href="classCgu_1_1PipeFifo.html#a8aa8ad5616e3bfe4068429e0c747b9ea">connect_to_stdin</a>();</div> <div class="line"><a name="l00434"></a><span class="lineno"> 434</span> <span class="comment"></span></div> <div class="line"><a name="l00435"></a><span class="lineno"> 435</span> <span class="comment">/**</span></div> <div class="line"><a name="l00436"></a><span class="lineno"> 436</span> <span class="comment"> * Connect the write file descriptor of the pipe to stdout. Once</span></div> <div class="line"><a name="l00437"></a><span class="lineno"> 437</span> <span class="comment"> * called, any write to stdout in the process which calls this method</span></div> <div class="line"><a name="l00438"></a><span class="lineno"> 438</span> <span class="comment"> * will be written to the pipe. It should only be called in a child</span></div> <div class="line"><a name="l00439"></a><span class="lineno"> 439</span> <span class="comment"> * or parent process after a fork() where the PipeFifo object has been</span></div> <div class="line"><a name="l00440"></a><span class="lineno"> 440</span> <span class="comment"> * created in the parent process, and typically is called by the child</span></div> <div class="line"><a name="l00441"></a><span class="lineno"> 441</span> <span class="comment"> * process before one of the exec() functions is invoked by the child</span></div> <div class="line"><a name="l00442"></a><span class="lineno"> 442</span> <span class="comment"> * process. It should only be called once, and cannot be called after</span></div> <div class="line"><a name="l00443"></a><span class="lineno"> 443</span> <span class="comment"> * connect_to_stdin(), connect_to_stderr() or make_readonly() has been</span></div> <div class="line"><a name="l00444"></a><span class="lineno"> 444</span> <span class="comment"> * called in the same process. Once called, the read file descriptor</span></div> <div class="line"><a name="l00445"></a><span class="lineno"> 445</span> <span class="comment"> * is no longer available to the process calling this method.</span></div> <div class="line"><a name="l00446"></a><span class="lineno"> 446</span> <span class="comment"> * Typically it would be used in order that when the new process image</span></div> <div class="line"><a name="l00447"></a><span class="lineno"> 447</span> <span class="comment"> * created by exec() writes to stdout, it writes to the pipe, and the</span></div> <div class="line"><a name="l00448"></a><span class="lineno"> 448</span> <span class="comment"> * parent process (or another child process) reads from the pipe.</span></div> <div class="line"><a name="l00449"></a><span class="lineno"> 449</span> <span class="comment"> * This function call is thread safe to the extent that all the system</span></div> <div class="line"><a name="l00450"></a><span class="lineno"> 450</span> <span class="comment"> * calls made in its implementation are async-signal-safe, so it may</span></div> <div class="line"><a name="l00451"></a><span class="lineno"> 451</span> <span class="comment"> * safely be called in a multi-threaded program after a fork() and</span></div> <div class="line"><a name="l00452"></a><span class="lineno"> 452</span> <span class="comment"> * before an exec(). However, the manipulation of the file</span></div> <div class="line"><a name="l00453"></a><span class="lineno"> 453</span> <span class="comment"> * descriptors and related variables is not protected by a mutex, so</span></div> <div class="line"><a name="l00454"></a><span class="lineno"> 454</span> <span class="comment"> * if different threads in the same process are to manipulate the same</span></div> <div class="line"><a name="l00455"></a><span class="lineno"> 455</span> <span class="comment"> * pipe object with this method, open(), close(), connect_to_stdin()</span></div> <div class="line"><a name="l00456"></a><span class="lineno"> 456</span> <span class="comment"> * or connect_to_stderr() (which manipulate both descriptors),</span></div> <div class="line"><a name="l00457"></a><span class="lineno"> 457</span> <span class="comment"> * make_readonly() or make_write_non_block() (which manipulate the</span></div> <div class="line"><a name="l00458"></a><span class="lineno"> 458</span> <span class="comment"> * write file descriptor), or make_writeonly() (which manipulates the</span></div> <div class="line"><a name="l00459"></a><span class="lineno"> 459</span> <span class="comment"> * read file descriptor), or read the value of the file descriptor</span></div> <div class="line"><a name="l00460"></a><span class="lineno"> 460</span> <span class="comment"> * with get_read_fd() or read() (which access the read file</span></div> <div class="line"><a name="l00461"></a><span class="lineno"> 461</span> <span class="comment"> * descriptor) or get_write_fd() or write() (which access the write</span></div> <div class="line"><a name="l00462"></a><span class="lineno"> 462</span> <span class="comment"> * file descriptor) concurrently with such a manipulation, then the</span></div> <div class="line"><a name="l00463"></a><span class="lineno"> 463</span> <span class="comment"> * user should provide appropriate synchronisation. It does not</span></div> <div class="line"><a name="l00464"></a><span class="lineno"> 464</span> <span class="comment"> * throw.</span></div> <div class="line"><a name="l00465"></a><span class="lineno"> 465</span> <span class="comment"> * @return -2 if the write file descriptor has previously been closed</span></div> <div class="line"><a name="l00466"></a><span class="lineno"> 466</span> <span class="comment"> * or this method, connect_to_stdin() or connect_to_stderr() has</span></div> <div class="line"><a name="l00467"></a><span class="lineno"> 467</span> <span class="comment"> * previously been called in the same process, otherwise it returns</span></div> <div class="line"><a name="l00468"></a><span class="lineno"> 468</span> <span class="comment"> * the value returned by dup2(), that is 0 if the operation succeeds,</span></div> <div class="line"><a name="l00469"></a><span class="lineno"> 469</span> <span class="comment"> * or -1 (with errno set) if not. It does not throw.</span></div> <div class="line"><a name="l00470"></a><span class="lineno"> 470</span> <span class="comment"> */</span></div> <div class="line"><a name="l00471"></a><span class="lineno"> 471</span>  <span class="keywordtype">int</span> <a class="code" href="classCgu_1_1PipeFifo.html#a691860d72a35998a99f18b17a38683b3">connect_to_stdout</a>();</div> <div class="line"><a name="l00472"></a><span class="lineno"> 472</span> <span class="comment"></span></div> <div class="line"><a name="l00473"></a><span class="lineno"> 473</span> <span class="comment">/**</span></div> <div class="line"><a name="l00474"></a><span class="lineno"> 474</span> <span class="comment"> * Connect the write file descriptor of the pipe to stderr. Once</span></div> <div class="line"><a name="l00475"></a><span class="lineno"> 475</span> <span class="comment"> * called, any write to stderr in the process which calls this method</span></div> <div class="line"><a name="l00476"></a><span class="lineno"> 476</span> <span class="comment"> * will be written to the pipe. It should only be called in a child</span></div> <div class="line"><a name="l00477"></a><span class="lineno"> 477</span> <span class="comment"> * or parent process after a fork() where the PipeFifo object has been</span></div> <div class="line"><a name="l00478"></a><span class="lineno"> 478</span> <span class="comment"> * created in the parent process, and typically is called by a child</span></div> <div class="line"><a name="l00479"></a><span class="lineno"> 479</span> <span class="comment"> * process before one of the exec() functions is invoked by the child</span></div> <div class="line"><a name="l00480"></a><span class="lineno"> 480</span> <span class="comment"> * process. It should only be called once, and cannot be called after</span></div> <div class="line"><a name="l00481"></a><span class="lineno"> 481</span> <span class="comment"> * connect_to_stdin(), connect_to_stdout() or make_readonly() has been</span></div> <div class="line"><a name="l00482"></a><span class="lineno"> 482</span> <span class="comment"> * called in the same process. Once called, the read file descriptor</span></div> <div class="line"><a name="l00483"></a><span class="lineno"> 483</span> <span class="comment"> * is no longer available to the process calling this method.</span></div> <div class="line"><a name="l00484"></a><span class="lineno"> 484</span> <span class="comment"> * Typically it would be used in order that when the new process image</span></div> <div class="line"><a name="l00485"></a><span class="lineno"> 485</span> <span class="comment"> * created by exec() writes to stderr, it writes to the pipe, and the</span></div> <div class="line"><a name="l00486"></a><span class="lineno"> 486</span> <span class="comment"> * parent process (or another child process) reads from the pipe.</span></div> <div class="line"><a name="l00487"></a><span class="lineno"> 487</span> <span class="comment"> * This function call is thread safe to the extent that all the system</span></div> <div class="line"><a name="l00488"></a><span class="lineno"> 488</span> <span class="comment"> * calls made in its implementation are async-signal-safe, so it may</span></div> <div class="line"><a name="l00489"></a><span class="lineno"> 489</span> <span class="comment"> * safely be called in a multi-threaded program after a fork() and</span></div> <div class="line"><a name="l00490"></a><span class="lineno"> 490</span> <span class="comment"> * before an exec(). However, the manipulation of the file</span></div> <div class="line"><a name="l00491"></a><span class="lineno"> 491</span> <span class="comment"> * descriptors and related variables is not protected by a mutex, so</span></div> <div class="line"><a name="l00492"></a><span class="lineno"> 492</span> <span class="comment"> * if different threads in the same process are to manipulate the same</span></div> <div class="line"><a name="l00493"></a><span class="lineno"> 493</span> <span class="comment"> * pipe object with this method, open(), close(), connect_to_stdin()</span></div> <div class="line"><a name="l00494"></a><span class="lineno"> 494</span> <span class="comment"> * or connect_to_stdout() (which manipulate both descriptors),</span></div> <div class="line"><a name="l00495"></a><span class="lineno"> 495</span> <span class="comment"> * make_readonly() or make_write_non_block() (which manipulate the</span></div> <div class="line"><a name="l00496"></a><span class="lineno"> 496</span> <span class="comment"> * write file descriptor), or make_writeonly() (which manipulates the</span></div> <div class="line"><a name="l00497"></a><span class="lineno"> 497</span> <span class="comment"> * read file descriptor), or read the value of the file descriptor</span></div> <div class="line"><a name="l00498"></a><span class="lineno"> 498</span> <span class="comment"> * with get_read_fd() or read() (which access the read file</span></div> <div class="line"><a name="l00499"></a><span class="lineno"> 499</span> <span class="comment"> * descriptor) or get_write_fd() or write() (which access the write</span></div> <div class="line"><a name="l00500"></a><span class="lineno"> 500</span> <span class="comment"> * file descriptor) concurrently with such a manipulation, then the</span></div> <div class="line"><a name="l00501"></a><span class="lineno"> 501</span> <span class="comment"> * user should provide appropriate synchronisation. It does not</span></div> <div class="line"><a name="l00502"></a><span class="lineno"> 502</span> <span class="comment"> * throw.</span></div> <div class="line"><a name="l00503"></a><span class="lineno"> 503</span> <span class="comment"> * @return -2 if the write file descriptor has previously been closed</span></div> <div class="line"><a name="l00504"></a><span class="lineno"> 504</span> <span class="comment"> * or this method, connect_to_stdin() or connect_to_stdout() has</span></div> <div class="line"><a name="l00505"></a><span class="lineno"> 505</span> <span class="comment"> * previously been called in the same process, otherwise it returns</span></div> <div class="line"><a name="l00506"></a><span class="lineno"> 506</span> <span class="comment"> * the value returned by dup2(), that is 0 if the operation succeeds,</span></div> <div class="line"><a name="l00507"></a><span class="lineno"> 507</span> <span class="comment"> * or -1 (with errno set) if not. It does not throw.</span></div> <div class="line"><a name="l00508"></a><span class="lineno"> 508</span> <span class="comment"> */</span></div> <div class="line"><a name="l00509"></a><span class="lineno"> 509</span>  <span class="keywordtype">int</span> <a class="code" href="classCgu_1_1PipeFifo.html#a07e8c9de2c32ae82f2f8c14fc89b0d54">connect_to_stderr</a>();</div> <div class="line"><a name="l00510"></a><span class="lineno"> 510</span> <span class="comment"></span></div> <div class="line"><a name="l00511"></a><span class="lineno"> 511</span> <span class="comment">/**</span></div> <div class="line"><a name="l00512"></a><span class="lineno"> 512</span> <span class="comment"> * This constructor opens read and write file descriptors for the</span></div> <div class="line"><a name="l00513"></a><span class="lineno"> 513</span> <span class="comment"> * pipe. All the system calls made in its implementation are</span></div> <div class="line"><a name="l00514"></a><span class="lineno"> 514</span> <span class="comment"> * async-signal-safe.</span></div> <div class="line"><a name="l00515"></a><span class="lineno"> 515</span> <span class="comment"> * @param mode The mode in which the read file descriptor of the pipe</span></div> <div class="line"><a name="l00516"></a><span class="lineno"> 516</span> <span class="comment"> * is to be opened - either Cgu::PipeFifo::block or</span></div> <div class="line"><a name="l00517"></a><span class="lineno"> 517</span> <span class="comment"> * Cgu::PipeFifo::non_block.</span></div> <div class="line"><a name="l00518"></a><span class="lineno"> 518</span> <span class="comment"> * @exception Cgu::PipeError This exception is thrown if the opening</span></div> <div class="line"><a name="l00519"></a><span class="lineno"> 519</span> <span class="comment"> * of the pipe fails. No other exceptions will be thrown.</span></div> <div class="line"><a name="l00520"></a><span class="lineno"> 520</span> <span class="comment"> */</span></div> <div class="line"><a name="l00521"></a><span class="lineno"> 521</span>  <a class="code" href="classCgu_1_1PipeFifo.html#a0ad29a1c5d598be1cfeb8393e431b0a7">PipeFifo</a>(<a class="code" href="classCgu_1_1PipeFifo.html#acb41a1e4ea6cb5d2733f41d91f8df1bc">Fifo_mode</a> mode);</div> <div class="line"><a name="l00522"></a><span class="lineno"> 522</span> <span class="comment"></span></div> <div class="line"><a name="l00523"></a><span class="lineno"> 523</span> <span class="comment">/**</span></div> <div class="line"><a name="l00524"></a><span class="lineno"> 524</span> <span class="comment"> * The default constructor does not open any descriptors. open() must</span></div> <div class="line"><a name="l00525"></a><span class="lineno"> 525</span> <span class="comment"> * be called before the PipeFifo object can be used, or it must be</span></div> <div class="line"><a name="l00526"></a><span class="lineno"> 526</span> <span class="comment"> * moved to. It is async-signal-safe. It does not throw.</span></div> <div class="line"><a name="l00527"></a><span class="lineno"> 527</span> <span class="comment"> */</span></div> <div class="line"><a name="l00528"></a><span class="lineno"> 528</span>  <a class="code" href="classCgu_1_1PipeFifo.html#a0ad29a1c5d598be1cfeb8393e431b0a7">PipeFifo</a>();</div> <div class="line"><a name="l00529"></a><span class="lineno"> 529</span> <span class="comment"></span></div> <div class="line"><a name="l00530"></a><span class="lineno"> 530</span> <span class="comment">/**</span></div> <div class="line"><a name="l00531"></a><span class="lineno"> 531</span> <span class="comment"> * The move constructor does not throw. It does not make any system</span></div> <div class="line"><a name="l00532"></a><span class="lineno"> 532</span> <span class="comment"> * calls.</span></div> <div class="line"><a name="l00533"></a><span class="lineno"> 533</span> <span class="comment"> *</span></div> <div class="line"><a name="l00534"></a><span class="lineno"> 534</span> <span class="comment"> * Since 2.0.19/2.2.2</span></div> <div class="line"><a name="l00535"></a><span class="lineno"> 535</span> <span class="comment"> */</span></div> <div class="line"><a name="l00536"></a><span class="lineno"> 536</span>  <a class="code" href="classCgu_1_1PipeFifo.html#a0ad29a1c5d598be1cfeb8393e431b0a7">PipeFifo</a>(<a class="code" href="classCgu_1_1PipeFifo.html" title="A wrapper for unix anonymous pipes. ">PipeFifo</a>&&);</div> <div class="line"><a name="l00537"></a><span class="lineno"> 537</span> <span class="comment"></span></div> <div class="line"><a name="l00538"></a><span class="lineno"> 538</span> <span class="comment">/**</span></div> <div class="line"><a name="l00539"></a><span class="lineno"> 539</span> <span class="comment"> * The move assignment operator does not throw. This function call is</span></div> <div class="line"><a name="l00540"></a><span class="lineno"> 540</span> <span class="comment"> * thread-safe to the extent that all the system calls made in its</span></div> <div class="line"><a name="l00541"></a><span class="lineno"> 541</span> <span class="comment"> * implementation are async-signal-safe, so it may safely be called in</span></div> <div class="line"><a name="l00542"></a><span class="lineno"> 542</span> <span class="comment"> * a multi-threaded program after a fork() and before an exec(), but</span></div> <div class="line"><a name="l00543"></a><span class="lineno"> 543</span> <span class="comment"> * no other synchronization is carried out. It will close the</span></div> <div class="line"><a name="l00544"></a><span class="lineno"> 544</span> <span class="comment"> * previously opened file descriptors (if any).</span></div> <div class="line"><a name="l00545"></a><span class="lineno"> 545</span> <span class="comment"> *</span></div> <div class="line"><a name="l00546"></a><span class="lineno"> 546</span> <span class="comment"> * Since 2.0.19/2.2.2</span></div> <div class="line"><a name="l00547"></a><span class="lineno"> 547</span> <span class="comment"> */</span></div> <div class="line"><a name="l00548"></a><span class="lineno"> 548</span>  <a class="code" href="classCgu_1_1PipeFifo.html" title="A wrapper for unix anonymous pipes. ">PipeFifo</a>& <a class="code" href="classCgu_1_1PipeFifo.html#a524040aff8303df0f40ee7acbb9b5570">operator=</a>(<a class="code" href="classCgu_1_1PipeFifo.html" title="A wrapper for unix anonymous pipes. ">PipeFifo</a>&&);</div> <div class="line"><a name="l00549"></a><span class="lineno"> 549</span> <span class="comment"></span></div> <div class="line"><a name="l00550"></a><span class="lineno"> 550</span> <span class="comment">/**</span></div> <div class="line"><a name="l00551"></a><span class="lineno"> 551</span> <span class="comment"> * The destructor does not throw. It is async-signal-safe.</span></div> <div class="line"><a name="l00552"></a><span class="lineno"> 552</span> <span class="comment"> */</span></div> <div class="line"><a name="l00553"></a><span class="lineno"><a class="code" href="classCgu_1_1PipeFifo.html#aee5bdc5e96a2fac54013f8c367ca6b7d"> 553</a></span>  <a class="code" href="classCgu_1_1PipeFifo.html#aee5bdc5e96a2fac54013f8c367ca6b7d">~PipeFifo</a>() {<a class="code" href="classCgu_1_1PipeFifo.html#a1d376e8a1a17071d3257a4e60516d211">close</a>();}</div> <div class="line"><a name="l00554"></a><span class="lineno"> 554</span> </div> <div class="line"><a name="l00555"></a><span class="lineno"> 555</span> <span class="comment">/* Only has effect if --with-glib-memory-slices-compat or</span></div> <div class="line"><a name="l00556"></a><span class="lineno"> 556</span> <span class="comment"> * --with-glib-memory-slices-no-compat option picked */</span></div> <div class="line"><a name="l00557"></a><span class="lineno"> 557</span>  <a class="code" href="cgu__config_8h.html#a13241741f6a47356f61508faea37c35a">CGU_GLIB_MEMORY_SLICES_FUNCS</a></div> <div class="line"><a name="l00558"></a><span class="lineno"> 558</span> };</div> <div class="line"><a name="l00559"></a><span class="lineno"> 559</span> </div> <div class="line"><a name="l00560"></a><span class="lineno"> 560</span> </div> <div class="line"><a name="l00561"></a><span class="lineno"> 561</span> <span class="comment"></span></div> <div class="line"><a name="l00562"></a><span class="lineno"> 562</span> <span class="comment">/**</span></div> <div class="line"><a name="l00563"></a><span class="lineno"> 563</span> <span class="comment"> * @class SyncPipe pipes.h c++-gtk-utils/pipes.h</span></div> <div class="line"><a name="l00564"></a><span class="lineno"> 564</span> <span class="comment"> * @brief A class which uses an anonymous pipe to synchronise between</span></div> <div class="line"><a name="l00565"></a><span class="lineno"> 565</span> <span class="comment"> * processes.</span></div> <div class="line"><a name="l00566"></a><span class="lineno"> 566</span> <span class="comment"> * @sa PipeFifo</span></div> <div class="line"><a name="l00567"></a><span class="lineno"> 567</span> <span class="comment"> *</span></div> <div class="line"><a name="l00568"></a><span class="lineno"> 568</span> <span class="comment"> * This class enables synchronisation between processes after</span></div> <div class="line"><a name="l00569"></a><span class="lineno"> 569</span> <span class="comment"> * fork()ing. The process to wait on the other one calls wait() at</span></div> <div class="line"><a name="l00570"></a><span class="lineno"> 570</span> <span class="comment"> * the point where it wishes to wait, and the other process calls</span></div> <div class="line"><a name="l00571"></a><span class="lineno"> 571</span> <span class="comment"> * release() when it wants to enable the other process to continue.</span></div> <div class="line"><a name="l00572"></a><span class="lineno"> 572</span> <span class="comment"> * It is one-shot only - once it has released, it cannot re-block</span></div> <div class="line"><a name="l00573"></a><span class="lineno"> 573</span> <span class="comment"> * again. It is typically for use when a child process is setting</span></div> <div class="line"><a name="l00574"></a><span class="lineno"> 574</span> <span class="comment"> * itself up, or has a specific task to achieve, and needs to</span></div> <div class="line"><a name="l00575"></a><span class="lineno"> 575</span> <span class="comment"> * co-ordinate with the parent process or tell the parent process when</span></div> <div class="line"><a name="l00576"></a><span class="lineno"> 576</span> <span class="comment"> * it has done this. In such a case, the parent would wait until the</span></div> <div class="line"><a name="l00577"></a><span class="lineno"> 577</span> <span class="comment"> * child releases it.</span></div> <div class="line"><a name="l00578"></a><span class="lineno"> 578</span> <span class="comment">*/</span></div> <div class="line"><a name="l00579"></a><span class="lineno"><a class="code" href="classCgu_1_1SyncPipe.html"> 579</a></span> <span class="keyword">class </span><a class="code" href="classCgu_1_1SyncPipe.html" title="A class which uses an anonymous pipe to synchronise between processes. ">SyncPipe</a> {</div> <div class="line"><a name="l00580"></a><span class="lineno"> 580</span>  <a class="code" href="classCgu_1_1PipeFifo.html" title="A wrapper for unix anonymous pipes. ">PipeFifo</a> pipe_fifo;</div> <div class="line"><a name="l00581"></a><span class="lineno"> 581</span> <span class="keyword">public</span>:<span class="comment"></span></div> <div class="line"><a name="l00582"></a><span class="lineno"> 582</span> <span class="comment">/**</span></div> <div class="line"><a name="l00583"></a><span class="lineno"> 583</span> <span class="comment"> * Releases another process waiting on this pipe. If the other</span></div> <div class="line"><a name="l00584"></a><span class="lineno"> 584</span> <span class="comment"> * process has not yet called wait(), when it does so wait() will</span></div> <div class="line"><a name="l00585"></a><span class="lineno"> 585</span> <span class="comment"> * immediately return. This may safely be called after a</span></div> <div class="line"><a name="l00586"></a><span class="lineno"> 586</span> <span class="comment"> * multi-threaded process forks() (all the system calls made in its</span></div> <div class="line"><a name="l00587"></a><span class="lineno"> 587</span> <span class="comment"> * implementation are async-signal-safe), but only one thread should</span></div> <div class="line"><a name="l00588"></a><span class="lineno"> 588</span> <span class="comment"> * call it. It does not throw.</span></div> <div class="line"><a name="l00589"></a><span class="lineno"> 589</span> <span class="comment"> */</span></div> <div class="line"><a name="l00590"></a><span class="lineno"><a class="code" href="classCgu_1_1SyncPipe.html#a68b87a4d41c512235d34f5850bbed2bc"> 590</a></span>  <span class="keywordtype">void</span> <a class="code" href="classCgu_1_1SyncPipe.html#a68b87a4d41c512235d34f5850bbed2bc">release</a>() {pipe_fifo.<a class="code" href="classCgu_1_1PipeFifo.html#ab1f8fbc911e192191d1208f4ddad4247">make_writeonly</a>(); pipe_fifo.<a class="code" href="classCgu_1_1PipeFifo.html#abe750ba5cb79f23cc01d06fa02a90785">make_readonly</a>();}</div> <div class="line"><a name="l00591"></a><span class="lineno"> 591</span> <span class="comment"></span></div> <div class="line"><a name="l00592"></a><span class="lineno"> 592</span> <span class="comment">/**</span></div> <div class="line"><a name="l00593"></a><span class="lineno"> 593</span> <span class="comment"> * Blocks until another process has called release() on this pipe. If</span></div> <div class="line"><a name="l00594"></a><span class="lineno"> 594</span> <span class="comment"> * the other process has already called release(), this function will</span></div> <div class="line"><a name="l00595"></a><span class="lineno"> 595</span> <span class="comment"> * immediately return. This may safely be called after a</span></div> <div class="line"><a name="l00596"></a><span class="lineno"> 596</span> <span class="comment"> * multi-threaded process forks() (all the system calls made in its</span></div> <div class="line"><a name="l00597"></a><span class="lineno"> 597</span> <span class="comment"> * implementation are async-signal-safe), but only one thread should</span></div> <div class="line"><a name="l00598"></a><span class="lineno"> 598</span> <span class="comment"> * call it. It does not throw.</span></div> <div class="line"><a name="l00599"></a><span class="lineno"> 599</span> <span class="comment"> */</span></div> <div class="line"><a name="l00600"></a><span class="lineno"> 600</span>  <span class="keywordtype">void</span> <a class="code" href="classCgu_1_1SyncPipe.html#a54fc53928c8284186cd58530613eed09">wait</a>();</div> <div class="line"><a name="l00601"></a><span class="lineno"> 601</span> <span class="comment"></span></div> <div class="line"><a name="l00602"></a><span class="lineno"> 602</span> <span class="comment">/**</span></div> <div class="line"><a name="l00603"></a><span class="lineno"> 603</span> <span class="comment"> * All the system calls made in the constructor are async-signal-safe.</span></div> <div class="line"><a name="l00604"></a><span class="lineno"> 604</span> <span class="comment"> * @exception Cgu::PipeError This exception is thrown if the opening</span></div> <div class="line"><a name="l00605"></a><span class="lineno"> 605</span> <span class="comment"> * of the pipe fails. No other exceptions will be thrown.</span></div> <div class="line"><a name="l00606"></a><span class="lineno"> 606</span> <span class="comment"> */</span></div> <div class="line"><a name="l00607"></a><span class="lineno"> 607</span>  <span class="comment">// using uniform initializer syntax here confuses doxygen</span></div> <div class="line"><a name="l00608"></a><span class="lineno"><a class="code" href="classCgu_1_1SyncPipe.html#aa8d0746ba8efb2b07638d11933c0ba32"> 608</a></span>  <a class="code" href="classCgu_1_1SyncPipe.html#aa8d0746ba8efb2b07638d11933c0ba32">SyncPipe</a>(): pipe_fifo(<a class="code" href="classCgu_1_1PipeFifo.html" title="A wrapper for unix anonymous pipes. ">PipeFifo</a>::block) {}</div> <div class="line"><a name="l00609"></a><span class="lineno"> 609</span> <span class="comment"></span></div> <div class="line"><a name="l00610"></a><span class="lineno"> 610</span> <span class="comment">/**</span></div> <div class="line"><a name="l00611"></a><span class="lineno"> 611</span> <span class="comment"> * The destructor does not throw. It is async-signal-safe.</span></div> <div class="line"><a name="l00612"></a><span class="lineno"> 612</span> <span class="comment"> */</span></div> <div class="line"><a name="l00613"></a><span class="lineno"><a class="code" href="classCgu_1_1SyncPipe.html#a7c87c39a9ed7956833c0efc32bb3521e"> 613</a></span>  <a class="code" href="classCgu_1_1SyncPipe.html#a7c87c39a9ed7956833c0efc32bb3521e">~SyncPipe</a>() {}</div> <div class="line"><a name="l00614"></a><span class="lineno"> 614</span> </div> <div class="line"><a name="l00615"></a><span class="lineno"> 615</span> <span class="comment">/* Only has effect if --with-glib-memory-slices-compat or</span></div> <div class="line"><a name="l00616"></a><span class="lineno"> 616</span> <span class="comment"> * --with-glib-memory-slices-no-compat option picked */</span></div> <div class="line"><a name="l00617"></a><span class="lineno"> 617</span>  <a class="code" href="cgu__config_8h.html#a13241741f6a47356f61508faea37c35a">CGU_GLIB_MEMORY_SLICES_FUNCS</a></div> <div class="line"><a name="l00618"></a><span class="lineno"> 618</span> };</div> <div class="line"><a name="l00619"></a><span class="lineno"> 619</span> </div> <div class="line"><a name="l00620"></a><span class="lineno"> 620</span> } <span class="comment">// namespace Cgu</span></div> <div class="line"><a name="l00621"></a><span class="lineno"> 621</span> </div> <div class="line"><a name="l00622"></a><span class="lineno"> 622</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>