channel.hh

Go to the documentation of this file.

/* vim: set sw=4 sts=4 et foldmethod=syntax : */
 
/*
 * Copyright (c) 2006, 2007, 2010 Ciaran McCreesh
 * Copyright (c) 2009 David Leverton
 *
 * This file is part of the Paludis package manager. Paludis is free software;
 * you can redistribute it and/or modify it under the terms of the GNU General
 * Public License version 2, as published by the Free Software Foundation.
 *
 * Paludis is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License along with
 * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
 * Place, Suite 330, Boston, MA  02111-1307  USA
 */
 
#ifndef PALUDIS_GUARD_PALUDIS_UTIL_CHANNEL_HH
#define PALUDIS_GUARD_PALUDIS_UTIL_CHANNEL_HH 1
 
#include <paludis/util/singleton.hh>
 
/** \file
 * Declaration for the Channel class.
 *
 * \ingroup g_system
 *
 * \section Examples
 *
 * - None at this time.
 */
 
namespace paludis
{
    /**
     * Wrapper around a read/write file descriptor pair, such as a pipe.
     *
     * \ingroup g_system
     * \nosubgrouping
     */
    class PALUDIS_VISIBLE Channel
    {
        protected:
            int _fds[2];
 
        public:
            ///\name Basic operations
            ///\{
 
            Channel() = default;
 
            virtual ~Channel();
 
            Channel(const Channel &) = delete;
            Channel & operator= (const Channel &) = delete;
 
            ///\}
 
            ///\name File descriptors
            ///\{
 
            int read_fd() const PALUDIS_ATTRIBUTE((warn_unused_result))
            {
                return _fds[0];
            }
 
            int write_fd() const PALUDIS_ATTRIBUTE((warn_unused_result))
            {
                return _fds[1];
            }
 
            void clear_read_fd()
            {
                _fds[0] = -1;
            }
 
            void clear_write_fd()
            {
                _fds[1] = -1;
            }
 
            ///\}
 
    };
 
}
 
#endif