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/ICE/BOE/Defines.h>
#include <OnixS/ICE/BOE/SessionListener.h>
#include <OnixS/ICE/BOE/Messaging.h>
 
#include <string>
 
ONIXS_ICEBOE_NAMESPACE_BEGIN
namespace Exceptions {

class ONIXS_ICEBOE_EXPORTED SessionException : public std::exception
{
public:
    explicit SessionException(SessionErrorReason::Enum reason, std::string message);
 
    ~SessionException() override = default;

    ONIXS_ICEBOE_NODISCARD const char* what() const noexcept override;

    ONIXS_ICEBOE_NODISCARD SessionErrorReason::Enum reason() const noexcept;

    ONIXS_ICEBOE_NODISCARD const std::string& toString() const noexcept;
 
private:
    std::string message_;
    SessionErrorReason::Enum reason_;
};

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

    ~SbeMessageAttachedExceptionBase() override = 0;

    ONIXS_ICEBOE_NODISCARD Messaging::SbeMessage receivedMessage() const;
 
private:
    std::vector<unsigned char> buffer_;
};

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

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

class ONIXS_ICEBOE_EXPORTED UnexpectedMessageTypeException final : public SbeMessageAttachedExceptionBase
{
public:
    explicit UnexpectedMessageTypeException(Messaging::SbeMessage message);

    ONIXS_ICEBOE_NODISCARD Messaging::MessageTemplateId templateId() const;
 
    ~UnexpectedMessageTypeException() noexcept override = default;
};

class ONIXS_ICEBOE_EXPORTED LinkErrorException final
        : public SessionException
{
public:
    explicit LinkErrorException(std::string rejectReason);
 
    ~LinkErrorException() override = default;
};

class ONIXS_ICEBOE_EXPORTED UnexpectedSequenceNumberException final
        : public SbeMessageAttachedExceptionBase
{
public:
    UnexpectedSequenceNumberException(
            Messaging::SbeMessage receivedMessage, std::string rejectReason, SeqNumber actualSeqNum, SeqNumber expectedSeqNum);
 
    ~UnexpectedSequenceNumberException() override = default;

    ONIXS_ICEBOE_NODISCARD SeqNumber actualSeqNum() const noexcept;

    ONIXS_ICEBOE_NODISCARD SeqNumber expectedSeqNum() const noexcept;
 
private:
    SeqNumber actualSeqNum_;
    SeqNumber expectedSeqNum_;
};

class ONIXS_ICEBOE_EXPORTED ResponseTimeoutException final
        : public SessionException
{
public:
    explicit ResponseTimeoutException(std::string rejectReason, int timeoutMilliseconds);
 
    ~ResponseTimeoutException() override = default;

    ONIXS_ICEBOE_NODISCARD int timeout() const noexcept;
 
private:
    int timeout_;
};

class ONIXS_ICEBOE_EXPORTED ProgramIsFinishingException final
        : public SessionException
{
public:
    ProgramIsFinishingException();
 
    ~ProgramIsFinishingException() override = default;
};

class ONIXS_ICEBOE_EXPORTED CannotEstablishLinkException final
        : public SessionException
{
public:
    CannotEstablishLinkException(int errCode, std::string rejectReason);
 
    ~CannotEstablishLinkException() override = default;

    ONIXS_ICEBOE_NODISCARD int errCode() const noexcept;
 
private:
    int errCode_;
};

class ONIXS_ICEBOE_EXPORTED LogonRequestRejectException final
        : public TypedSbeMessageAttachedExceptionBase<Messaging::LogonReport>
{
public:
    explicit LogonRequestRejectException(Messaging::LogonReport reject);
 
    ~LogonRequestRejectException() noexcept override = default;
};

class ONIXS_ICEBOE_EXPORTED LogoutReportInReplyOnLogonRequestException final
        : public TypedSbeMessageAttachedExceptionBase<Messaging::LogoutReport>
{
public:
    explicit LogoutReportInReplyOnLogonRequestException(Messaging::LogoutReport terminate);
 
    ~LogoutReportInReplyOnLogonRequestException() override = default;
};

class ONIXS_ICEBOE_EXPORTED ErrorOnLogonRequestException final
        : public TypedSbeMessageAttachedExceptionBase<Messaging::Error>
{
public:
    explicit ErrorOnLogonRequestException(Messaging::Error error);
 
    ~ErrorOnLogonRequestException() override = default;
};
 
}
ONIXS_ICEBOE_NAMESPACE_END