Error.h

Go to the documentation of this file.

/*
 * Copyright (c) Onix Solutions Limited. All rights reserved.
 *
 * This software owned by Onix Solutions Limited 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 "Export.h"
#include "Optional.h"
#include "Types.h"
 
#include <iosfwd>
#include <string>
 
namespace OnixS { namespace ICE { namespace iMpact { namespace MarketData {

struct ONIXS_ICEMDH_EXPORT KnownErrors
{
    enum Enum
    {
        Nothing,

        Generic,

        NotLicensed,

        BadConfiguration,

        BadPacket,

        BadMessage,

        MarketTypeIsNotPermitted,

        LogReplayFailure,

        LoginFailure
    };

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

typedef KnownErrors::Enum ErrorCode;

class ONIXS_ICEMDH_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 std::string& source, ErrorCode code, const std::string& description, FeedId feedId);

    Error(const Error& other);

    virtual ~Error() throw();

    const Optional<FeedId>& feedId() const;

    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];
    char description_[DescriptionMaxLength];
    Optional<FeedId> feedId_;
};

ONIXS_ICEMDH_EXPORT std::ostream& operator<<(std::ostream&, const Error&);
 
inline const Optional<FeedId>& Error::feedId() const
{
    return feedId_;
}
 
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 OnixS::ICE::iMpact::MarketData