eq/fabric/error.h

/* Copyright (c) 2010-2016, Stefan Eilemann <eile@eyescale.ch>
 *                          Daniel Nachbaur <danielnachbaur@gmail.com>
 *
 * 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 EQFABRIC_ERROR_H
#define EQFABRIC_ERROR_H

#include <eq/fabric/api.h>
#include <eq/fabric/types.h>
#include <lunchbox/bitOperation.h> // inline template specialization

namespace eq
{
namespace fabric
{

class Error
{
    typedef void (Error::*bool_t)() const;
    void bool_true() const {}

public:
    EQFABRIC_API Error( const uint32_t code,
                        const uint128_t& originator = uint128_t( ));

    EQFABRIC_API Error& operator = ( const ErrorCode code );

    EQFABRIC_API operator bool_t() const;

    EQFABRIC_API bool operator ! () const;

    EQFABRIC_API uint32_t getCode() const;

    EQFABRIC_API const uint128_t& getOriginator() const;

    EQFABRIC_API bool operator == ( const Error& rhs ) const;

    EQFABRIC_API bool operator != ( const Error& rhs ) const;

    EQFABRIC_API bool operator == ( const uint32_t code ) const;

    EQFABRIC_API bool operator != ( const uint32_t code ) const;

    EQFABRIC_API Error(); 
    EQFABRIC_API void serialize( co::DataOStream& os ) const; 
    EQFABRIC_API void deserialize( co::DataIStream& is ); 

private:
    friend void lunchbox::byteswap< Error >( Error& value );

    uint32_t _code;
    uint128_t _originator;
};

EQFABRIC_API std::ostream& operator << ( std::ostream& os, const Error& );

}
}

namespace lunchbox
{
template<> inline void byteswap( eq::fabric::Error& value )
{
    byteswap( value._code );
    byteswap( value._originator );
}
}

#endif // EQFABRIC_ERROR_H