SessionException.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/iLink3/Defines.h>
#include <OnixS/CME/iLink3/SessionListener.h>
#include <OnixS/CME/iLink3/ValuesEnums.h>

#include <string>

#if WIN32
#pragma warning(push)
#pragma warning(disable : 4275)
#pragma warning(disable : 4251)
#endif

namespace OnixS {
namespace CME {
namespace iLink3 {
namespace Exceptions{

/**
 * A Session-related exception.
 */
class ONIXS_ILINK3_EXPORTED SessionException : public std::exception
{
public:
    SessionException(SessionErrorReason::Enum reason, const std::string& message);

    SessionException(SessionErrorReason::Enum reason, const std::string& message, const std::exception& cause);

    ~SessionException() ONIXS_ILINK3_NOTHROW ONIXS_ILINK3_OVERRIDE ONIXS_ILINK3_DEFAULT;

    const char* what() const ONIXS_ILINK3_NOTHROW ONIXS_ILINK3_OVERRIDE;

    SessionErrorReason::Enum reason() const ONIXS_ILINK3_NOTHROW
    {
        return reason_;
    }

    const std::string& toString() const ONIXS_ILINK3_NOTHROW
    {
        return message_;
    }

private:
    std::string message_;
    SessionErrorReason::Enum reason_;
};


class ONIXS_ILINK3_EXPORTED SbeMessageAttachedExceptionBase
    : public SessionException
{
public:
    SbeMessageAttachedExceptionBase(SessionErrorReason::Enum reason, const std::string& message, Messaging::SbeMessage sbeMessage);

    Messaging::SbeMessage receivedMessage() const;

    ~SbeMessageAttachedExceptionBase() ONIXS_ILINK3_NOTHROW ONIXS_ILINK3_OVERRIDE = 0;

private:
    std::vector<unsigned char> buffer_;
};

template <typename MessageType>
class TypedSbeMessageAttachedExceptionBase : public SbeMessageAttachedExceptionBase
{
public:
    TypedSbeMessageAttachedExceptionBase(SessionErrorReason::Enum reason, const std::string& message, Messaging::SbeMessage sbeMessage)
        : SbeMessageAttachedExceptionBase(reason, message, sbeMessage)
    {}

    MessageType receivedMessage() const
    {
        return Messaging::typify<MessageType>(SbeMessageAttachedExceptionBase::receivedMessage());
    }
};

/**
 * An unexpected message type is received.
 */
class ONIXS_ILINK3_EXPORTED UnexpectedMessageTypeException
  : public SbeMessageAttachedExceptionBase
{
public:
    explicit UnexpectedMessageTypeException(Messaging::SbeMessage message);

    Messaging::MessageTemplateId templateId() const;

    ~UnexpectedMessageTypeException() ONIXS_ILINK3_NOTHROW ONIXS_ILINK3_OVERRIDE ONIXS_ILINK3_DEFAULT;
};

/**
 * A telecommunication link error is detected.
 */
class ONIXS_ILINK3_EXPORTED LinkErrorException
  : public SessionException
{
public:
    explicit LinkErrorException(const std::string& rejectReason);

    ~LinkErrorException() ONIXS_ILINK3_NOTHROW ONIXS_ILINK3_OVERRIDE ONIXS_ILINK3_DEFAULT;
};

/**
 * An unexpected message sequence number is detected.
 */
class ONIXS_ILINK3_EXPORTED UnexpectedSequenceNumberException
  : public SbeMessageAttachedExceptionBase
{
public:
    UnexpectedSequenceNumberException(Messaging::SbeMessage receivedMessage, const std::string& rejectReason,
        SeqNumber actualSeqNum, SeqNumber expectedSeqNum, Messaging::UInt64 uuid);

    ~UnexpectedSequenceNumberException() ONIXS_ILINK3_NOTHROW ONIXS_ILINK3_OVERRIDE ONIXS_ILINK3_DEFAULT;

    SeqNumber actualSeqNum() const ONIXS_ILINK3_NOTHROW
    {
        return actualSeqNum_;
    }

    SeqNumber expectedSeqNum() const ONIXS_ILINK3_NOTHROW
    {
        return expectedSeqNum_;
    }

    Messaging::UInt64 uuid() const ONIXS_ILINK3_NOTHROW
    {
        return uuid_;
    }

private:
    SeqNumber actualSeqNum_;
    SeqNumber expectedSeqNum_;
    Messaging::UInt64 uuid_;
};

/**
 * A response has not been received during the specified timeout.
 */
class ONIXS_ILINK3_EXPORTED ResponseTimeoutException
  : public SessionException
{
public:
    explicit ResponseTimeoutException(const std::string& rejectReason, int timeoutMilliseconds)
      : SessionException(SessionErrorReason::LinkErrorIsDetected, rejectReason)
      , timeout_(timeoutMilliseconds)
    {}

    ~ResponseTimeoutException() ONIXS_ILINK3_NOTHROW ONIXS_ILINK3_OVERRIDE ONIXS_ILINK3_DEFAULT;

    /// @return timeout in milliseconds
    int timeout() const ONIXS_ILINK3_NOTHROW
    {
        return timeout_;
    }

private:
    int timeout_; ///< timeout in milliseconds.
};


/**
 * The program is finishing its execution.
 */
class ONIXS_ILINK3_EXPORTED ProgramIsFinishingException
  : public SessionException
{
public:
    ProgramIsFinishingException();

    ~ProgramIsFinishingException() ONIXS_ILINK3_NOTHROW ONIXS_ILINK3_OVERRIDE ONIXS_ILINK3_DEFAULT;
};

/// The telecommunication link cannot be established.
class ONIXS_ILINK3_EXPORTED CannotEstablishLinkException
  : public SessionException
{
public:
    /// Constructor.
    ///
    /// \param errCode system error code (if present).
    /// \param rejectReason the telecommunication link error description.
    CannotEstablishLinkException(int errCode, const std::string& rejectReason);

    ~CannotEstablishLinkException() ONIXS_ILINK3_NOTHROW ONIXS_ILINK3_OVERRIDE ONIXS_ILINK3_DEFAULT;

    int errCode() const ONIXS_ILINK3_NOTHROW;

private:
    int errCode_;
};


/**
 * The <a href="https://www.cmegroup.com/confluence/display/EPICSANDBOX/Negotiate">Negotiate</a> message is rejected by the exchange.
 */
class ONIXS_ILINK3_EXPORTED NegotiationRejectException
    : public TypedSbeMessageAttachedExceptionBase<Messaging::NegotiationReject502>
{
public:
    explicit NegotiationRejectException(Messaging::NegotiationReject502 reject);

    ~NegotiationRejectException() ONIXS_ILINK3_NOTHROW ONIXS_ILINK3_OVERRIDE ONIXS_ILINK3_DEFAULT;

    NegotiationRejectErrorCode::Enum errorCodes() const;

    std::string rejectReason() const;
};

/**
 * The <a href="https://www.cmegroup.com/confluence/display/EPICSANDBOX/Establish">Establish</a> message is rejected by the exchange.
 */
class ONIXS_ILINK3_EXPORTED EstablishmentRejectException
    : public TypedSbeMessageAttachedExceptionBase<Messaging::EstablishmentReject505>
{
public:
    explicit EstablishmentRejectException(Messaging::EstablishmentReject505 reject);

    ~EstablishmentRejectException() ONIXS_ILINK3_NOTHROW ONIXS_ILINK3_OVERRIDE ONIXS_ILINK3_DEFAULT;

    std::string rejectReason() const;

    EstablishmentRejectErrorCode::Enum errorCodes() const;
};

/// Received the <a href="https://www.cmegroup.com/confluence/display/EPICSANDBOX/Terminate">Terminate</a> message
/// in reply to the <a href="https://www.cmegroup.com/confluence/display/EPICSANDBOX/Establish">Establish</a> or
/// <a href="https://www.cmegroup.com/confluence/display/EPICSANDBOX/Negotiate">Negotiate</a>  messages.
class ONIXS_ILINK3_EXPORTED TerminateInReplyOnEstablishException
  : public TypedSbeMessageAttachedExceptionBase<Messaging::Terminate507>
{
public:
    explicit TerminateInReplyOnEstablishException(Messaging::Terminate507 terminate);

    ~TerminateInReplyOnEstablishException() ONIXS_ILINK3_NOTHROW ONIXS_ILINK3_OVERRIDE ONIXS_ILINK3_DEFAULT;

    TerminateErrorCode::Enum errorCodes() const;

    std::string terminateReason() const;
};

/// Received the <a href="https://www.cmegroup.com/confluence/display/EPICSANDBOX/iLink+3+Business+Reject">BusinessReject</a> message
/// in reply to the <a href="https://www.cmegroup.com/confluence/display/EPICSANDBOX/Establish">Establish</a> or
/// <a href="https://www.cmegroup.com/confluence/display/EPICSANDBOX/Negotiate">Negotiate</a>  messages.
class ONIXS_ILINK3_EXPORTED BusinessRejectInReplyOnEstablishException
    : public TypedSbeMessageAttachedExceptionBase<Messaging::BusinessReject521>
{
public:
    explicit BusinessRejectInReplyOnEstablishException(Messaging::BusinessReject521 reject);

    ~BusinessRejectInReplyOnEstablishException() ONIXS_ILINK3_NOTHROW ONIXS_ILINK3_OVERRIDE ONIXS_ILINK3_DEFAULT;

    BusinessRejectReason::Enum errorCodes() const;

    std::string rejectReason() const;
};




}
}
}
}

#if WIN32
#pragma warning(pop)
#endif