blob: 5b1261dd1382d42b44f5e4d23725219b4db6d1b9 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Class template basic_pipe</title>
<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
<link rel="up" href="../../process/reference.html#header.boost.process.pipe_hpp" title="Header <boost/process/pipe.hpp>">
<link rel="prev" href="std_err.html" title="Global std_err">
<link rel="next" href="basic_pipebuf.html" title="Struct template basic_pipebuf">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
<td align="center"><a href="../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="std_err.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../process/reference.html#header.boost.process.pipe_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="basic_pipebuf.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="refentry">
<a name="boost.process.basic_pipe"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Class template basic_pipe</span></h2>
<p>boost::process::basic_pipe</p>
</div>
<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../process/reference.html#header.boost.process.pipe_hpp" title="Header <boost/process/pipe.hpp>">boost/process/pipe.hpp</a>>
</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> CharT<span class="special">,</span> <span class="keyword">typename</span> Traits <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">char_traits</span><span class="special"><</span><span class="identifier">CharT</span><span class="special">></span> <span class="special">></span>
<span class="keyword">class</span> <a class="link" href="basic_pipe.html" title="Class template basic_pipe">basic_pipe</a> <span class="special">{</span>
<span class="keyword">public</span><span class="special">:</span>
<span class="comment">// types</span>
<span class="keyword">typedef</span> <span class="identifier">CharT</span> <a name="boost.process.basic_pipe.char_type"></a><span class="identifier">char_type</span><span class="special">;</span>
<span class="keyword">typedef</span> <span class="identifier">Traits</span> <a name="boost.process.basic_pipe.traits_type"></a><span class="identifier">traits_type</span><span class="special">;</span>
<span class="keyword">typedef</span> <span class="identifier">Traits</span><span class="special">::</span><span class="identifier">int_type</span> <a name="boost.process.basic_pipe.int_type"></a><span class="identifier">int_type</span><span class="special">;</span>
<span class="keyword">typedef</span> <span class="identifier">Traits</span><span class="special">::</span><span class="identifier">pos_type</span> <a name="boost.process.basic_pipe.pos_type"></a><span class="identifier">pos_type</span><span class="special">;</span>
<span class="keyword">typedef</span> <span class="identifier">Traits</span><span class="special">::</span><span class="identifier">off_type</span> <a name="boost.process.basic_pipe.off_type"></a><span class="identifier">off_type</span><span class="special">;</span>
<span class="keyword">typedef</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a name="boost.process.basic_pipe.native_handle"></a><span class="identifier">native_handle</span><span class="special">;</span>
<span class="comment">// <a class="link" href="basic_pipe.html#boost.process.basic_pipeconstruct-copy-destruct">construct/copy/destruct</a></span>
<a class="link" href="basic_pipe.html#idp40356896-bb"><span class="identifier">basic_pipe</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">explicit</span> <a class="link" href="basic_pipe.html#idp40357504-bb"><span class="identifier">basic_pipe</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span>
<a class="link" href="basic_pipe.html#idp40359056-bb"><span class="identifier">basic_pipe</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_pipe.html" title="Class template basic_pipe">basic_pipe</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span>
<a class="link" href="basic_pipe.html#idp40361504-bb"><span class="identifier">basic_pipe</span></a><span class="special">(</span><a class="link" href="basic_pipe.html" title="Class template basic_pipe">basic_pipe</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span>
<a class="link" href="basic_pipe.html" title="Class template basic_pipe">basic_pipe</a> <span class="special">&</span> <a class="link" href="basic_pipe.html#idp40363200-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_pipe.html" title="Class template basic_pipe">basic_pipe</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span>
<a class="link" href="basic_pipe.html" title="Class template basic_pipe">basic_pipe</a> <span class="special">&</span> <a class="link" href="basic_pipe.html#idp40366208-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="basic_pipe.html" title="Class template basic_pipe">basic_pipe</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span>
<a class="link" href="basic_pipe.html#idp40368464-bb"><span class="special">~</span><span class="identifier">basic_pipe</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
<span class="comment">// <a class="link" href="basic_pipe.html#idp40341792-bb">public member functions</a></span>
<span class="identifier">native_handle</span> <a class="link" href="basic_pipe.html#idp40342352-bb"><span class="identifier">native_source</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="identifier">native_handle</span> <a class="link" href="basic_pipe.html#idp40343904-bb"><span class="identifier">native_sink</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="keyword">void</span> <a class="link" href="basic_pipe.html#idp40345456-bb"><span class="identifier">assign_source</span></a><span class="special">(</span><span class="identifier">native_handle</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">void</span> <a class="link" href="basic_pipe.html#idp40347424-bb"><span class="identifier">assign_sink</span></a><span class="special">(</span><span class="identifier">native_handle</span><span class="special">)</span><span class="special">;</span>
<span class="identifier">int_type</span> <a class="link" href="basic_pipe.html#idp40349392-bb"><span class="identifier">write</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">char_type</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">int_type</span><span class="special">)</span><span class="special">;</span>
<span class="identifier">int_type</span> <a class="link" href="basic_pipe.html#idp40351920-bb"><span class="identifier">read</span></a><span class="special">(</span><span class="identifier">char_type</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">int_type</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">bool</span> <a class="link" href="basic_pipe.html#idp40354448-bb"><span class="identifier">is_open</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">void</span> <a class="link" href="basic_pipe.html#idp40355600-bb"><span class="identifier">close</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
<span class="special">}</span><span class="special">;</span></pre></div>
<div class="refsect1">
<a name="idp418118416"></a><h2>Description</h2>
<p>Class implementation of a pipe. </p>
<div class="refsect2">
<a name="idp418119136"></a><h3>
<a name="boost.process.basic_pipeconstruct-copy-destruct"></a><code class="computeroutput">basic_pipe</code>
public
construct/copy/destruct</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
<pre class="literallayout"><a name="idp40356896-bb"></a><span class="identifier">basic_pipe</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Default construct the pipe. Will be opened. </li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">explicit</span> <a name="idp40357504-bb"></a><span class="identifier">basic_pipe</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> name<span class="special">)</span><span class="special">;</span></pre>Construct a named pipe. </li>
<li class="listitem">
<pre class="literallayout"><a name="idp40359056-bb"></a><span class="identifier">basic_pipe</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_pipe.html" title="Class template basic_pipe">basic_pipe</a> <span class="special">&</span> p<span class="special">)</span><span class="special">;</span></pre>
<p>Copy construct the pipe. </p>
<div class="note"><table border="0" summary="Note">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../doc/src/images/note.png"></td>
<th align="left">Note</th>
</tr>
<tr><td align="left" valign="top"><p>Duplicated the handles. </p></td></tr>
</table></div>
<p>
</p>
</li>
<li class="listitem">
<pre class="literallayout"><a name="idp40361504-bb"></a><span class="identifier">basic_pipe</span><span class="special">(</span><a class="link" href="basic_pipe.html" title="Class template basic_pipe">basic_pipe</a> <span class="special">&&</span> lhs<span class="special">)</span><span class="special">;</span></pre>
<p>Move construct the pipe. </p>
</li>
<li class="listitem">
<pre class="literallayout"><a class="link" href="basic_pipe.html" title="Class template basic_pipe">basic_pipe</a> <span class="special">&</span> <a name="idp40363200-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_pipe.html" title="Class template basic_pipe">basic_pipe</a> <span class="special">&</span> p<span class="special">)</span><span class="special">;</span></pre>
<p>Copy assign the pipe. </p>
<div class="note"><table border="0" summary="Note">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../doc/src/images/note.png"></td>
<th align="left">Note</th>
</tr>
<tr><td align="left" valign="top"><p>Duplicated the handles. </p></td></tr>
</table></div>
<p>
</p>
</li>
<li class="listitem">
<pre class="literallayout"><a class="link" href="basic_pipe.html" title="Class template basic_pipe">basic_pipe</a> <span class="special">&</span> <a name="idp40366208-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="basic_pipe.html" title="Class template basic_pipe">basic_pipe</a> <span class="special">&&</span> lhs<span class="special">)</span><span class="special">;</span></pre>
<p>Move assign the pipe. </p>
</li>
<li class="listitem">
<pre class="literallayout"><a name="idp40368464-bb"></a><span class="special">~</span><span class="identifier">basic_pipe</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
<p>Destructor closes the handles. </p>
</li>
</ol></div>
</div>
<div class="refsect2">
<a name="idp418165568"></a><h3>
<a name="idp40341792-bb"></a><code class="computeroutput">basic_pipe</code> public member functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
<pre class="literallayout"><span class="identifier">native_handle</span> <a name="idp40342352-bb"></a><span class="identifier">native_source</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p>Get the native handle of the source. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="identifier">native_handle</span> <a name="idp40343904-bb"></a><span class="identifier">native_sink</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p>Get the native handle of the sink. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">void</span> <a name="idp40345456-bb"></a><span class="identifier">assign_source</span><span class="special">(</span><span class="identifier">native_handle</span> h<span class="special">)</span><span class="special">;</span></pre>
<p>Assign a new value to the source </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">void</span> <a name="idp40347424-bb"></a><span class="identifier">assign_sink</span><span class="special">(</span><span class="identifier">native_handle</span> h<span class="special">)</span><span class="special">;</span></pre>
<p>Assign a new value to the sink </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="identifier">int_type</span> <a name="idp40349392-bb"></a><span class="identifier">write</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">char_type</span> <span class="special">*</span> data<span class="special">,</span> <span class="identifier">int_type</span> count<span class="special">)</span><span class="special">;</span></pre>Write data to the pipe. </li>
<li class="listitem">
<pre class="literallayout"><span class="identifier">int_type</span> <a name="idp40351920-bb"></a><span class="identifier">read</span><span class="special">(</span><span class="identifier">char_type</span> <span class="special">*</span> data<span class="special">,</span> <span class="identifier">int_type</span> count<span class="special">)</span><span class="special">;</span></pre>Read data from the pipe. </li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">bool</span> <a name="idp40354448-bb"></a><span class="identifier">is_open</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Check if the pipe is open. </li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">void</span> <a name="idp40355600-bb"></a><span class="identifier">close</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Close the pipe. </li>
</ol></div>
</div>
</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright © 2006-2012 Julio M. Merino Vidal, Ilya Sokolov,
Felipe Tanus, Jeff Flinn, Boris Schaeling<br>Copyright © 2016 Klemens D. Morgenstern<p>
Distributed under the Boost Software License, Version 1.0. (See accompanying
file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
</p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="std_err.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../process/reference.html#header.boost.process.pipe_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="basic_pipebuf.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>
|
