systemPipe.h

/* Copyright (c) 2009-2011, Stefan Eilemann <eile@equalizergraphics.com>
 *               2009, Maxim Makhinya
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License version 2.1 as published
 * by the Free Software Foundation.
 *  
 * This library 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 Lesser General Public License for more
 * details.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#ifndef EQ_SYSTEM_PIPE_H
#define EQ_SYSTEM_PIPE_H

#include <eq/error.h> // enum
#include <eq/api.h>
#include <string>

namespace eq
{
    class Pipe;

    class SystemPipe
    {
    public:
        EQ_API SystemPipe( Pipe* parent );

        EQ_API virtual ~SystemPipe( );

        EQ_API virtual bool configInit( ) = 0;

        EQ_API virtual void configExit( ) = 0;

        Pipe* getPipe() { return _pipe; }
        
        const Pipe* getPipe() const { return _pipe; }

        EQ_API co::base::Error getError() const;

    protected:
        EQ_API void setError( const uint32_t error );

    private:
        Pipe* const _pipe;

        struct Private;
        Private* _private; // placeholder for binary-compatible changes
    };
}

#endif // EQ_SYSTEM_PIPE_H