Warning.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 KnownWarnings
{
    enum Enum
    {
        Generic,

        NoNetworkActivity,

        SessionNumberMismatch,

        PacketGap,

        PacketQueueOverflow,

        ListenerFailure,

        NoUdsForMarketType,
    };

    static Enum deserialize(const char* value);

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

typedef KnownWarnings::Enum WarningCode;

class ONIXS_ICEMDH_EXPORT Warning
{
public:
    Warning(const std::string& source, WarningCode code);

    Warning(const std::string& source, WarningCode code, const std::string& description);

    Warning(const std::string& source, WarningCode code, const std::string& description, FeedId feedId);

    Warning(const Warning& other);

    ~Warning();

    const Optional<FeedId>& feedId() const;

    WarningCode code() const;

    const char* description() const;

    const char* source() const;

    std::string toString() const;

    void toString(std::string&) const;

    Warning& operator=(const Warning& other);
 
private:
    enum Traits
    {
        SourceMaxLength = 128,
        DescriptionMaxLength = 1024
    };
 
    WarningCode code_;
    char source_[SourceMaxLength];
    char description_[DescriptionMaxLength];
    Optional<FeedId> feedId_;
};

ONIXS_ICEMDH_EXPORT std::ostream& operator<<(std::ostream&, const Warning&);
 
inline const Optional<FeedId>& Warning::feedId() const
{
    return feedId_;
}
 
inline WarningCode Warning::code() const
{
    return code_;
}
 
inline const char* Warning::description() const
{
    return description_;
}
 
inline const char* Warning::source() const
{
    return source_;
}
 
inline std::string Warning::toString() const
{
    std::string str;
    toString(str);
    return str;
}
 
}}}} // namespace OnixS::ICE::iMpact::MarketData