dataOStream.h

/* Copyright (c) 2007-2012, Stefan Eilemann <eile@equalizergraphics.com>
 *                    2010, Cedric Stalder <cedric.stalder@gmail.com>
 *                    2012, Daniel Nachbaur <danielnachbaur@gmail.com>
 *
 * This file is part of Collage <https://github.com/Eyescale/Collage>
 *
 * 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 CO_DATAOSTREAM_H
#define CO_DATAOSTREAM_H

#include <co/api.h>
#include <co/array.h> // used inline
#include <co/types.h>
#include <lunchbox/nonCopyable.h> // base class
#include <lunchbox/stdExt.h>

#include <map>
#include <set>
#include <vector>

namespace co
{
namespace detail { class DataOStream; }
namespace DataStreamTest { class Sender; }

    class DataOStream : public lunchbox::NonCopyable
    {
    public:
        CO_API void disable();

        void enableSave();

        void disableSave();

        CO_API bool hasSentData() const;

        CO_API const Connections& getConnections() const;

        DataOStream& streamDataHeader( DataOStream& os );

        void sendBody( ConnectionPtr connection, const void* data,
                       const uint64_t size );

        uint64_t getCompressedDataSize() const;

        template< class T > DataOStream& operator << ( const T& value )
            { _write( &value, sizeof( value )); return *this; }

        template< class T > DataOStream& operator << ( Array< T > array )
            { _write( array.data, array.getNumBytes( )); return *this; }

        template< class T >
        DataOStream& operator << ( const lunchbox::Buffer< T >& buffer );

        template< class T >
        DataOStream& operator << ( const std::vector< T >& value );

        template< class K, class V >
        DataOStream& operator << ( const std::map< K, V >& value );

        template< class T >
        DataOStream& operator << ( const std::set< T >& value );

        template< class K, class V >
        DataOStream& operator << ( const stde::hash_map< K, V >& value );

        template< class T >
        DataOStream& operator << ( const stde::hash_set< T >& value );

        template< typename C >
        void serializeChildren( const std::vector< C* >& children );

    protected:
        CO_API DataOStream(); 
        DataOStream( DataOStream& rhs );  
        virtual CO_API ~DataOStream(); 

        CO_API lunchbox::Bufferb& getBuffer();

        void _initCompressor( const uint32_t compressor );

        CO_API void _enable();

        void flush( const bool last );

        void _setupConnections( const Nodes& receivers );

        void _setupConnections( const Connections& connections );

        void _setupConnection( NodePtr node, const bool useMulticast );

        CO_API void _setupConnection( ConnectionPtr connection );
        friend class DataStreamTest::Sender;

        void _resend();

        void _clearConnections(); 

        virtual void sendData( const void* buffer, const uint64_t size,
                               const bool last ) = 0;

        virtual CO_API void reset();

    private:
        detail::DataOStream* const _impl;

        CO_API uint64_t _getCompressedData( void** chunks,
                                            uint64_t* chunkSizes ) const;

        CO_API void _write( const void* data, uint64_t size );

        void _sendData( const void* data, const uint64_t size );

        void _resetBuffer();

        template< class T >
        DataOStream& _writeFlatVector( const std::vector< T >& value )
        {
            const uint64_t nElems = value.size();
            _write( &nElems, sizeof( nElems ));
            if( nElems > 0 )
                _write( &value.front(), nElems * sizeof( T ));
            return *this;
        }
        void _sendFooter( const void* buffer, const uint64_t size );
    };

    std::ostream& operator << ( std::ostream&, const DataOStream& );
}

#include "dataOStream.ipp" // template implementation

#endif //CO_DATAOSTREAM_H