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:
    SessionException(SessionErrorReason::Enum reason, const std::string& message);
 
    SessionException(SessionErrorReason::Enum reason, const std::string& message, const std::exception& cause);
 
    ~SessionException() noexcept override = default;
 
    const char* what() const noexcept override;
 
    SessionErrorReason::Enum reason() const noexcept
    {
        return reason_;
    }
 
    const std::string& toString() const noexcept
    {
        return message_;
    }
 
private:
    std::string message_;
    SessionErrorReason::Enum reason_;
};
 
 
class ONIXS_ICEBOE_EXPORTED SbeMessageAttachedExceptionBase
    : public SessionException
{
public:
    SbeMessageAttachedExceptionBase(SessionErrorReason::Enum reason, const std::string& message, Messaging::SbeMessage sbeMessage);
 
    Messaging::SbeMessage receivedMessage() const;
 
    ~SbeMessageAttachedExceptionBase() noexcept 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());
    }
};

class ONIXS_ICEBOE_EXPORTED UnexpectedMessageTypeException
  : public SbeMessageAttachedExceptionBase
{
public:
    explicit UnexpectedMessageTypeException(Messaging::SbeMessage message);
 
    Messaging::MessageTemplateId templateId() const;
 
    ~UnexpectedMessageTypeException() noexcept override = default;
};

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

class ONIXS_ICEBOE_EXPORTED UnexpectedSequenceNumberException
  : public SbeMessageAttachedExceptionBase
{
public:
    UnexpectedSequenceNumberException(Messaging::SbeMessage receivedMessage, const std::string& rejectReason,
        SeqNumber actualSeqNum, SeqNumber expectedSeqNum);
 
    ~UnexpectedSequenceNumberException() noexcept override = default;
 
    SeqNumber actualSeqNum() const noexcept
    {
        return actualSeqNum_;
    }
 
    SeqNumber expectedSeqNum() const noexcept
    {
        return expectedSeqNum_;
    }
 
private:
    SeqNumber actualSeqNum_;
    SeqNumber expectedSeqNum_;
};

class ONIXS_ICEBOE_EXPORTED ResponseTimeoutException
  : public SessionException
{
public:
    explicit ResponseTimeoutException(const std::string& rejectReason, int timeoutMilliseconds)
      : SessionException(SessionErrorReason::LinkErrorIsDetected, rejectReason)
      , timeout_(timeoutMilliseconds)
    {}
 
    ~ResponseTimeoutException() noexcept override = default;

    int timeout() const noexcept
    {
        return timeout_;
    }
 
private:
    int timeout_; 
};
 

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

class ONIXS_ICEBOE_EXPORTED CannotEstablishLinkException
  : public SessionException
{
public:
    CannotEstablishLinkException(int errCode, const std::string& rejectReason);
 
    ~CannotEstablishLinkException() noexcept override = default;
 
    int errCode() const noexcept;
 
private:
    int errCode_;
};
 
class ONIXS_ICEBOE_EXPORTED LogonRequestRejectException
    : public TypedSbeMessageAttachedExceptionBase<Messaging::LogonReport>
{
public:
    explicit LogonRequestRejectException(Messaging::LogonReport reject);
 
    ~LogonRequestRejectException() noexcept override = default;
};
 
class ONIXS_ICEBOE_EXPORTED LogoutReportInReplyOnLogonRequestException
  : public TypedSbeMessageAttachedExceptionBase<Messaging::LogoutReport>
{
public:
    explicit LogoutReportInReplyOnLogonRequestException(Messaging::LogoutReport terminate);
 
    ~LogoutReportInReplyOnLogonRequestException() noexcept override = default;
 
};
 
class ONIXS_ICEBOE_EXPORTED ErrorOnLogonRequestException
    : public TypedSbeMessageAttachedExceptionBase<Messaging::Error>
{
public:
    explicit ErrorOnLogonRequestException(Messaging::Error error);
 
    ~ErrorOnLogonRequestException() noexcept override = default;
};
 
}
ONIXS_ICEBOE_NAMESPACE_END