Error.h

Go to the documentation of this file.

// Copyright Onix Solutions Limited [OnixS]. All rights reserved.
//
// This software owned by Onix Solutions Limited [OnixS] and is protected by copyright law
// and international copyright treaties.
//
// Access to and use of the software is governed by the terms of the applicable OnixS Software
// Services Agreement (the Agreement) and Customer end user license agreements granting
// a non-assignable, non-transferable and non-exclusive license to use the software
// for it's own data processing purposes under the terms defined in the Agreement.
//
// Except as otherwise granted within the terms of the Agreement, copying or reproduction of any
// part of this source code or associated reference material to any other location for further
// reproduction or redistribution, and any amendments to this copyright notice, are expressly
// prohibited.
//
// Any reproduction or redistribution for sale or hiring of the Software not in accordance with
// the terms of the Agreement is a violation of copyright law.
//
 
#pragma once
 
#include "OnixS/CME/DropCopy/Export.h"
#include "OnixS/CME/DropCopy/Types.h"
 
#include <exception>
#include <string>
 
namespace OnixS { namespace CME { namespace DropCopy {

struct ONIXS_CME_DROP_COPY_EXPORT KnownErrors
{
    enum Enum
    {
        Nothing,

        Generic,

        NotLicensed,

        BadConfiguration,

        BadMessage
    };

    static Enum deserialize(const char* value);

    static const char* toString(Enum value);
};

typedef KnownErrors::Enum ErrorCode;

class ONIXS_CME_DROP_COPY_EXPORT Error : public std::exception
{
public:
    Error(const std::string& source, ErrorCode code);

    Error(const std::string& source, ErrorCode code, const std::string& description);

    Error(const Error& other);

    virtual ~Error() throw();

    ErrorCode code() const;

    const char* description() const;

    const char* source() const;

    virtual const char* what() const throw();

    std::string toString() const;

    void toString(std::string&) const;

    Error& operator=(const Error& other);
 
private:
    enum Traits
    {
        SourceMaxLength = 128,
        DescriptionMaxLength = 1024
    };
 
    ErrorCode code_;
    char source_[SourceMaxLength + 1];
    char description_[DescriptionMaxLength + 1];
};
 
inline ErrorCode Error::code() const
{
    return code_;
}
 
inline const char* Error::description() const
{
    return description_;
}
 
inline const char* Error::source() const
{
    return source_;
}
 
inline std::string Error::toString() const
{
    std::string str;
    toString(str);
    return str;
}
 
}}}
 
namespace std {
// Outputs message into standard stream.
ONIXS_CME_DROP_COPY_EXPORT std::ostream&
operator<<(std::ostream&, const OnixS::CME::DropCopy::Error&);
}