pipe.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2007 Tommi Maekitalo
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2.1 of the License, or (at your option) any later version.
8  *
9  * As a special exception, you may use this file as part of a free
10  * software library without restriction. Specifically, if other files
11  * instantiate templates or use macros or inline functions from this
12  * file, or you compile this file and link it with other files to
13  * produce an executable, this file does not by itself cause the
14  * resulting executable to be covered by the GNU General Public
15  * License. This exception does not however invalidate any other
16  * reasons why the executable file might be covered by the GNU Library
17  * General Public License.
18  *
19  * This library is distributed in the hope that it will be useful,
20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
22  * Lesser General Public License for more details.
23  *
24  * You should have received a copy of the GNU Lesser General Public
25  * License along with this library; if not, write to the Free Software
26  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
27  */
28 
29 #ifndef CXXTOOLS_PIPE_H
30 #define CXXTOOLS_PIPE_H
31 
32 #include <cxxtools/noncopyable.h>
33 #include <cxxtools/api.h>
34 #include <cxxtools/iodevice.h>
35 #include <unistd.h>
36 
37 namespace cxxtools
38 {
39  class PipeImpl;
40 
41 class CXXTOOLS_API Pipe : private NonCopyable
42 {
43  private:
44  class PipeImpl* _impl;
45 
46  protected:
47  PipeImpl* impl() { return _impl; }
48  const PipeImpl* impl() const { return _impl; }
49 
50  public:
51  typedef int OpenMode;
52 
53  static const int Sync = 0;
54  static const int Async = 1;
55 
61  explicit Pipe(OpenMode mode = Sync);
62 
67  ~Pipe();
68 
73  IODevice& out();
74 
75  const IODevice& out() const;
76 
81  IODevice& in();
82 
83  const IODevice& in() const;
84 
85  size_t write(const char* buf, size_t count)
86  {
87  return in().write(buf, count);
88  }
89 
90  void write(char ch)
91  {
92  in().write(&ch, 1);
93  }
94 
95  size_t read(char* buf, size_t count)
96  {
97  return out().read(buf, count);
98  }
99 
100  char read()
101  {
102  char ch;
103  out().read(&ch, 1);
104  return ch;
105  }
106 
107 };
108 
109 }
110 
111 #endif // CXXTOOLS_PIPE_H