xref: /freebsd/contrib/kyua/utils/process/systembuf.hpp (revision dd41de95a84d979615a2ef11df6850622bf6184e)
1 // Copyright 2010 The Kyua Authors.
2 // All rights reserved.
3 //
4 // Redistribution and use in source and binary forms, with or without
5 // modification, are permitted provided that the following conditions are
6 // met:
7 //
8 // * Redistributions of source code must retain the above copyright
9 //   notice, this list of conditions and the following disclaimer.
10 // * Redistributions in binary form must reproduce the above copyright
11 //   notice, this list of conditions and the following disclaimer in the
12 //   documentation and/or other materials provided with the distribution.
13 // * Neither the name of Google Inc. nor the names of its contributors
14 //   may be used to endorse or promote products derived from this software
15 //   without specific prior written permission.
16 //
17 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 
29 /// \file utils/process/systembuf.hpp
30 /// Provides the utils::process::systembuf class.
31 
32 #if !defined(UTILS_PROCESS_SYSTEMBUF_HPP)
33 #define UTILS_PROCESS_SYSTEMBUF_HPP
34 
35 #include "utils/process/systembuf_fwd.hpp"
36 
37 #include <cstddef>
38 #include <memory>
39 #include <streambuf>
40 
41 #include "utils/noncopyable.hpp"
42 
43 namespace utils {
44 namespace process {
45 
46 
47 /// A std::streambuf implementation for raw file descriptors.
48 ///
49 /// This class grabs ownership of the file descriptor.  I.e. when the class is
50 /// destroyed, the file descriptor is closed unconditionally.
51 class systembuf : public std::streambuf, noncopyable {
52     struct impl;
53 
54     /// Pointer to the shared internal implementation.
55     std::auto_ptr< impl > _pimpl;
56 
57 protected:
58     int_type underflow(void);
59     int_type overflow(int);
60     int sync(void);
61 
62 public:
63     explicit systembuf(const int, std::size_t = 8192);
64     ~systembuf(void);
65 };
66 
67 
68 }  // namespace process
69 }  // namespace utils
70 
71 #endif  // !defined(UTILS_PROCESS_SYSTEMBUF_HPP)
72