systembuf.hpp

// Copyright 2010 The Kyua Authors.
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// * Redistributions of source code must retain the above copyright
//   notice, this list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above copyright
//   notice, this list of conditions and the following disclaimer in the
//   documentation and/or other materials provided with the distribution.
// * Neither the name of Google Inc. nor the names of its contributors
//   may be used to endorse or promote products derived from this software
//   without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

/// \file utils/process/systembuf.hpp
/// Provides the utils::process::systembuf class.

#if !defined(UTILS_PROCESS_SYSTEMBUF_HPP)
#define UTILS_PROCESS_SYSTEMBUF_HPP

#include "utils/process/systembuf_fwd.hpp"

#include <cstddef>
#include <memory>
#include <streambuf>

#include "utils/noncopyable.hpp"

namespace utils {
namespace process {


/// A std::streambuf implementation for raw file descriptors.
///
/// This class grabs ownership of the file descriptor.  I.e. when the class is
/// destroyed, the file descriptor is closed unconditionally.
class systembuf : public std::streambuf, noncopyable {
    struct impl;

    /// Pointer to the shared internal implementation.
    std::unique_ptr< impl > _pimpl;

protected:
    int_type underflow(void);
    int_type overflow(int);
    int sync(void);

public:
    explicit systembuf(const int, std::size_t = 8192);
    ~systembuf(void);
};


}  // namespace process
}  // namespace utils

#endif  // !defined(UTILS_PROCESS_SYSTEMBUF_HPP)