libbobcat-dev 2.20.01-1 / usr / share / doc / libbobcat2-dev / man / pipe.3.html

This file is indexed.

/usr/share/doc/libbobcat2-dev/man/pipe.3.html is in libbobcat-dev 2.20.01-1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  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
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
<html><head>
<title>FBB::Pipe</title>
<link rev="made" href="mailto:Frank B. Brokken: f.b.brokken@rug.nl">
</head>
<body text="#27408B" bgcolor="#FFFAF0">
<hr>
<h1>FBB::Pipe</h1>
<h2>libbobcat1-dev_2.20.01-x.tar.gz</h2>
<h2>2005-2011</h2>

<html><head>
<link rev="made" href="mailto:Frank B. Brokken: f.b.brokken@rug.nl">
</head>
<body text="#27408B" bgcolor="#FFFAF0">
<hr>
<h1></h1>

<html><head>
<title>FBB::Pipe(3bobcat)</title>
<link rev="made" href="mailto:Frank B. Brokken: f.b.brokken@rug.nl">
</head>
<body text="#27408B" bgcolor="#FFFAF0">
<hr>
<h1>FBB::Pipe(3bobcat)</h1>
<h2>libbobcat1-dev_2.20.01-x.tar.gz Error handler</h2>
<h2>2005-2011</h2>


<p>
<h2>NAME</h2>FBB::Pipe - Defines a system level pipe
<p>
<h2>SYNOPSIS</h2>
    <strong>#include &lt;bobcat/pipe&gt;</strong><br>
    Linking option: <em>-lbobcat</em> 
<p>
<h2>DESCRIPTION</h2>
    <strong>FBB::Pipe</strong> objects may be used to construct a <em>pipe</em>. <strong>FBB::Pipe</strong>
objects offer a simple interface to the reading and writing ends of
pipes. <strong>FBB::Pipe</strong> objects are object-wrappers around the <strong>pipe</strong>(2) system
call.
<p>
<h2>NAMESPACE</h2>
    <strong>FBB</strong><br>
    All constructors, members, operators and manipulators, mentioned in this
man-page, are defined in the namespace <strong>FBB</strong>.
<p>
<h2>INHERITS FROM</h2>
    -
<p>
<h2>CONSTRUCTORS</h2>
    <ul>
    <li> <strong>Pipe()</strong>:<br>
        The default <strong>Pipe()</strong> constructor constructs a basic pipe, calling
<strong>pipe</strong>(2). 
<p>
This constructor throws an <em>Errno</em> exception if the default <strong>Pipe</strong>
constructor did not properly complete.  The thrown <strong>Errno</strong> object's
<em>which()</em> member shows the system's <em>errno</em> value set by the failing
<strong>pipe</strong>(2) function.
<p>
<li> <strong>Pipe(int const *fd)</strong>:<br>
        This constructor expects two file descriptors, which already define a
pipe, stored at <em>fd</em>. Following the construction of the <em>Pipe</em> object 
the array at by <em>fd</em> is no longer used by the <em>Pipe</em> object.
    </ul>
        The copy constructor is available.
<p>
Note that when the pipe goes out of scope, no <strong>close</strong>(2) operation is
performed on the pipe's ends. If the pipe should be closed by the desctructor,
derive a class from <strong>Pipe</strong>(3bobcat), whose destructor performs the required
closing-operation.
<p>
<h2>MEMBER FUNCTIONS</h2>
    <ul>
    <li> <strong>int readFd() const</strong>:<br>
        Returns the pipe's file descriptor that is used for reading
    <li> <strong>void readFrom(int filedescriptor)</strong>:<br>
        Sets up redirection from the internal <em>read</em> filedescriptor to the
given filedescriptor: information is read from the <strong>FBB::Pipe</strong> object when
reading from the provided filedescriptor.
    <li> <strong>void readFrom(int const *filedescriptors, size_t n)</strong>:<br>
        Sets up redirection from the internal <em>read</em> filedescriptor to the
given filedescriptors: information is read from the <strong>FBB::Pipe</strong> object when
reading from any of the <strong>n</strong> provided filedescriptors (experimental).
    <li> <strong>int readOnly()</strong>:<br>
        Closes the writing end of the pipe, returns the reading end's file
descriptor. 
    <li> <strong>void verify() const</strong>:<br>
        Obsoleted, will be removed in a future Bobcat release.
    <li> <strong>int writeFd() const</strong>:<br>
        Returns the pipe's file descriptor that is used for writing
    <li> <strong>void writtenBy(int filedescriptor)</strong>:<br>
        Sets up redirection from the internal <em>write</em> filedescriptor to the
given filedescriptor: information is  written to the <strong>FBB::Pipe</strong> object when
writing to the provided filedescriptor.
    <li> <strong>void writtenBy(int const *filedescriptors, size_t n)</strong>:<br>
        Sets up redirection from the internal <em>write</em> filedescriptor to the
given filedescriptors: information is written to the <strong>FBB::Pipe</strong> object
when writing to each of the <strong>n</strong> provided filedescriptors.
    <li> <strong>int writeOnly()</strong>:<br>
        Closes the reading end of the pipe, returns the writing end's file
descriptor. 
    </ul>
<p>
<h2>PROTECTED ENUMERATION</h2>
    The <strong>RW</strong> protected enumeration has the following elements:
    <ul>
    <li> <strong>READ</strong>:<br>
        The index in <strong>d_fd[]</strong> (see below) of the element holding the pipe's
reading file descriptor;
    <li> <strong>WRITE</strong>:<br>
        The index in <strong>d_fd[]</strong> (see below) of the element holding the pipe's
writing file descriptor
    </ul>
<p>
<h2>PROTECTED DATA</h2>
    <ul>
    <li> <strong>int d_fd[2]</strong>:<br> 
        The array holding the pipe's file descriptors. The <strong>READ</strong> element
contains the pipe's reading file descriptor, the <strong>WRITE</strong> element
contains the pipe's writing file descriptor,
    </ul>
<p>
<h2>EXAMPLE</h2>
        <pre>

    #include &lt;bobcat/pipe&gt;
    #include &lt;sys/types.h&gt;
    #include &lt;sys/wait.h&gt;
    #include &lt;unistd.h&gt;
    #include &lt;iostream&gt;
    #include &lt;string&gt;
    
    using namespace std;
    using namespace FBB;
    
    int main()
    {
        Pipe p;                         // construct a pipe
    
        cout &lt;&lt; "Read file descriptor: " &lt;&lt; p.getReadFd() &lt;&lt; endl;
        cout &lt;&lt; "Write file descriptor: " &lt;&lt; p.getWriteFd() &lt;&lt; endl;
    
        int pid = fork();
    
        if (pid == -1)
            return 1;
    
        if (!pid)                       //child
        {
            p.readFrom(STDIN_FILENO);   // read what goes into the pipe
    
            string s;

            getline(cin, s);
            cout &lt;&lt; "CHILD: Got `" &lt;&lt; s &lt;&lt; "'" &lt;&lt; endl;    
    
            getline(cin, s);
            cout &lt;&lt; "CHILD: Got `" &lt;&lt; s &lt;&lt; "'" &lt;&lt; endl;    
    
            return 0;
        }
    
        p.writtenBy(STDOUT_FILENO);      // write to the pipe via cout
    
        cout &lt;&lt; "first line" &lt;&lt; endl;
        cout &lt;&lt; "second line" &lt;&lt; endl;
    
        waitpid(pid, 0, 0);
    
        return 0;
    }
        
</pre>

<p>
<h2>FILES</h2>
    <em>bobcat/pipe</em> - defines the class interface
<p>
<h2>SEE ALSO</h2>
    <strong>bobcat</strong>(7), <strong>pipe</strong>(2), <strong>mkfifo</strong>(3)
<p>
<h2>BUGS</h2>
    Note that when the pipe goes out of scope, no <strong>close</strong>(2) operation is
performed on the pipe's ends. If the pipe should be closed by the desctructor,
derive a class from <strong>Pipe</strong>(3bobcat), whose destructor performs the required
closing-operation.
<p>

<h2>DISTRIBUTION FILES</h2>
    <ul>
    <li> <em>bobcat_2.20.01-x.dsc</em>: detached signature;
    <li> <em>bobcat_2.20.01-x.tar.gz</em>: source archive;
    <li> <em>bobcat_2.20.01-x_i386.changes</em>: change log;
    <li> <em>libbobcat1_2.20.01-x_*.deb</em>: debian package holding the
            libraries;
    <li> <em>libbobcat1-dev_2.20.01-x_*.deb</em>: debian package holding the
            libraries, headers and manual pages;
    <li> <em>http://sourceforge.net/projects/bobcat</em>: public archive location;
    </ul>
<p>
<h2>BOBCAT</h2>
    Bobcat is an acronym of `Brokken's Own Base Classes And Templates'.
<p>
<h2>COPYRIGHT</h2>
    This is free software, distributed under the terms of the 
    GNU General Public License (GPL).
<p>
<h2>AUTHOR</h2>
    Frank B. Brokken (<strong>f.b.brokken@rug.nl</strong>).
<p>

APT Browse - Built by Thomas Orozco.