libcommonc++  0.7
Pipe.h++
Go to the documentation of this file.
1 /* ---------------------------------------------------------------------------
2  commonc++ - A C++ Common Class Library
3  Copyright (C) 2005-2014 Mark A Lindner
4 
5  This file is part of commonc++.
6 
7  This library is free software; you can redistribute it and/or
8  modify it under the terms of the GNU Library General Public
9  License as published by the Free Software Foundation; either
10  version 2 of the License, or (at your option) any later version.
11 
12  This library is distributed in the hope that it will be useful,
13  but WITHOUT ANY WARRANTY; without even the implied warranty of
14  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15  Library General Public License for more details.
16 
17  You should have received a copy of the GNU Library General Public
18  License along with this library; if not, write to the Free
19  Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20  ---------------------------------------------------------------------------
21 */
22 
23 #ifndef __ccxx_Pipe_hxx
24 #define __ccxx_Pipe_hxx
25 
26 #include <commonc++/Common.h++>
28 
29 namespace ccxx {
30 
37 class Pipe
38 {
39  public:
40 
42  Pipe();
43 
45  ~Pipe();
46 
52  void open();
53 
55  void close();
56 
58  bool isOpen() const;
59 
68  ssize_t read(byte_t* buf, size_t count);
69 
78  ssize_t write(const byte_t* buf, size_t count);
79 
87  void setBlocking(bool blocking);
88 
91  { return(_fd[0]); }
92 
95  { return(_fd[1]); }
96 
97  private:
98 
99  FileHandle _fd[2];
100 };
101 
102 } // namespace ccxx
103 
104 #endif // __ccxx_Pipe_hxx
void setBlocking(bool blocking)
Set the blocking state of the pipe.
Definition: Pipe.c++:112
A unidirectional stream pipe.
Definition: Pipe.h++:37
Pipe()
Constructor.
Definition: Pipe.c++:42
~Pipe()
Destructor.
Definition: Pipe.c++:50
void open()
Create and open the pipe.
Definition: Pipe.c++:58
bool isOpen() const
Test if the pipe is open.
Definition: Pipe.c++:104
int FileHandle
Definition: Common.h++:225
ssize_t write(const byte_t *buf, size_t count)
Write raw data to the write end of the pipe.
Definition: Pipe.c++:157
FileHandle getWriteDescriptor() const
Get the file descriptor for the write end of the pipe.
Definition: Pipe.h++:94
void close()
Close the pipe.
Definition: Pipe.c++:81
ssize_t read(byte_t *buf, size_t count)
Read raw data from the read end of the pipe.
Definition: Pipe.c++:136
FileHandle getReadDescriptor() const
Get the file descriptor for the read end of the pipe.
Definition: Pipe.h++:90
Definition: AllocationMap.c++:25
unsigned char byte_t
An unsigned 8-bit value.
Definition: Integers.h++:68