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 {

/// List of known errors.
struct ONIXS_ICEMDH_EXPORT KnownErrors
{
    /// \copydoc KnownErrors
    enum Enum
    {
        /// Indicates absence of error.
        Nothing,

        /// Identifiers errors of generic nature.
        Generic,

        /// Indicates License-related issues like
        /// there's no license available or license
        /// has been expired.
        NotLicensed,

        /// Handler configuration is invalid.
        BadConfiguration,

        /// Network packet received by the Handler is corrupted.
        BadPacket,

        /// iMpact message has invalid structure.
        BadMessage,

        /// Indicates that market type from subscription
        /// is not permitted for the user.
        MarketTypeIsNotPermitted,

        /// Indicates irrecoverable log replay failure.
        LogReplayFailure,

        /// Indicates ICE login failure.
        LoginFailure
    };

    /// Returns string presentation of a value.
    static const char* toString(Enum value);
};

/// Error code.
typedef KnownErrors::Enum ErrorCode;

/// Error.
class ONIXS_ICEMDH_EXPORT Error : public std::exception
{
public:
    /// Initializes instance with just a code.
    Error(
        const std::string& source
      , ErrorCode code
      );

    /// Initializes instance with code and description.
    Error(
        const std::string& source
      , ErrorCode code
      , const std::string& description
      );

    /// Initializes instance with code, description and feed ID.
    Error(
        const std::string& source
      , ErrorCode code
      , const std::string& description
      , FeedId feedId
      );

    /// Initializes as clone of another error.
    Error(const Error& other);

    /// Destruction interface.
    virtual ~Error() throw();

    /// Feed ID (if available).
    const Optional<FeedId>& feedId() const;

    /// Code of error.
    ErrorCode code() const;

    /// Human readable description of error.
    const char* description() const;

    /// Origin of the error.
    const char* source() const;

    /// Human readable description of error.
    virtual const char* what() const throw();

    /// String presentation of an error.
    std::string toString() const;

    /// Appends presentation of an error to the string.
    void toString(std::string&) const;

    /// Copies error attributes from another instance.
    Error& operator=(const Error& other);

private:
    enum Traits
    {
        SourceMaxLength = 128
      , DescriptionMaxLength = 1024
    };

    ErrorCode code_;
    char source_[SourceMaxLength];
    char description_[DescriptionMaxLength];
    Optional<FeedId> feedId_;
};

/// Make it printable to formatted C++ I/O streams.
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 MarketData, iMpact, ICE, OnixS