Gateway.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/testing/ABI.h>
#include <OnixS/CME/iLink3/SessionSettings.h>
#include <OnixS/CME/iLink3/Messaging.h>
#include <OnixS/CME/iLink3/ValuesEnums.h>
#include <OnixS/CME/iLink3/testing/MessagePtr.h>
#include <OnixS/CME/iLink3/testing/ClientMessageListener.h>
 
#include <chrono>
#include <atomic>
 
namespace OnixS {
namespace CME {
namespace iLink3 {
namespace Testing {
 
// Assume NegotiationResponse501::credentials is empty
constexpr
UInt16 calculateNegotiationResponse501MaxSize()
{
    using Message = NegotiationResponse501;
 
    return
        Message::blockLength(Message::Schema::Version)
        + MessageHeader::Size
        + Message::getMinimalVariableFieldsSize(Message::Schema::Version);
}
 
//  Type aliases
using NegotiationResponse501Container = MessageHolder<NegotiationResponse501, calculateNegotiationResponse501MaxSize()>;
using NegotiationReject502Container = MessageHolder<NegotiationReject502>;
using EstablishmentAck504Container = MessageHolder<EstablishmentAck504>;
using EstablishmentReject505Container = MessageHolder<EstablishmentReject505>;
using Terminate507Container = MessageHolder<Terminate507>;
using Sequence506Container = MessageHolder<Sequence506>;
 
using MessageBasePtr = MessagePtr<SbeMessage>;
using Negotiate500Ptr = MessagePtr<Negotiate500>;
using Establish503Ptr = MessagePtr<Establish503>;
using Terminate507Ptr = MessagePtr<Terminate507>;
using Sequence506Ptr = MessagePtr<Sequence506>;

class ONIXS_ILINK3_EXPORTED Gateway
{
public:
    using Timeout = std::chrono::milliseconds;
 
    Gateway(const SessionSettings::LicenseStores& licenseStores, int port, const char* host = "127.0.0.1",
            const Timeout& acceptTimeout = defaultTimeout(),
            const Timeout& sendReceiveTimeout = defaultTimeout());

    virtual ~Gateway();

    Gateway(const Gateway&) = delete;
    Gateway& operator=(const Gateway&) = delete;

    Gateway(Gateway&&) noexcept;
    Gateway& operator=(Gateway&&) noexcept;

    void swap(Gateway&) noexcept;

    Gateway& acceptConnection(const Timeout& acceptTimeout = defaultTimeout());

    bool tryAcceptConnection(const Timeout& acceptTimeout = defaultTimeout());

    Gateway& acceptSession(SeqNumber outgoingSequenceNumber = 1, UInt64 previousUuid = 0, UInt32 previousSeqNo = 0);

    Terminate507Ptr waitUntilTerminate(
        ClientMessageListener* listener = nullptr, ClientSessionMessageListener* sessionMessageListener = nullptr,
        std::atomic<bool>* stopRequested = nullptr);
 

    bool dispatch(MessageBasePtr msg, ClientMessageListener* listener = nullptr, ClientSessionMessageListener* sessionMessageListener = nullptr);

    Gateway& sendSequence(UInt32 nextSeqNo, KeepAliveLapsed::Enum keepAliveLapsed = KeepAliveLapsed::NotLapsed, UInt64 uuid = 0);

    Gateway& disconnect();

    const char * host() const noexcept;

    ONIXS_ILINK3_NODISCARD
    int port() const noexcept;

    Gateway& enableLogger(const std::string& logFileName, unsigned int logLevel = 3);

    template <typename SbeMessageType, size_t MaxMessageSize, typename MessageInitializer>
    Gateway& send(iLink3::Messaging::MessageHolder<SbeMessageType, MaxMessageSize, MessageInitializer>& msg);

    template <typename SbeMessageType, size_t MaxMessageSize, typename MessageInitializer>
    Gateway& send(iLink3::Messaging::MessageHolder<SbeMessageType, MaxMessageSize, MessageInitializer>&& msg);

    template <typename SbeMessageType, size_t MaxMessageSize, typename MessageInitializer>
    Gateway& send(iLink3::Messaging::MessageHolder<SbeMessageType, MaxMessageSize, MessageInitializer>& msg, SeqNumber num);

    template <typename SbeMessageType, size_t MaxMessageSize, typename MessageInitializer>
    Gateway& send(iLink3::Messaging::MessageHolder<SbeMessageType, MaxMessageSize, MessageInitializer>&& msg, SeqNumber num);

    template <typename SbeMessageType, size_t MaxMessageSize, typename MessageInitializer>
    Gateway& send(iLink3::Messaging::MessageHolder<SbeMessageType, MaxMessageSize, MessageInitializer>& msg, std::initializer_list<SeqNumber> numbers);

    template <typename SbeMessageType, size_t MaxMessageSize, typename MessageInitializer>
    Gateway& send(iLink3::Messaging::MessageHolder<SbeMessageType, MaxMessageSize, MessageInitializer>&& msg, std::initializer_list<SeqNumber> numbers);
 

    template <typename TMsg>
    MessagePtr<TMsg> receiveTypedMessage();

    Gateway& run(ClientMessageListener& listener);

    Gateway& run(ClientMessageListener& appMsgListener, ClientSessionMessageListener& sessionMsgListener);

    ONIXS_ILINK3_NODISCARD
    SeqNumber outSeqNum() const noexcept;

    Gateway& outSeqNum(SeqNumber nextOutSeqNum) noexcept;

    ONIXS_ILINK3_NODISCARD
    UInt64 uuid() const noexcept
    {
        return uId_;
    }

    ONIXS_ILINK3_NODISCARD
    FTI::Enum faultToleranceIndicator() const noexcept
    {
        return faultToleranceIndicator_;
    }

    Gateway& faultToleranceIndicator(FTI::Enum value)
    {
        faultToleranceIndicator_ = value;
 
        return *this;
    }

    Gateway& tcpNoDelayOption(bool noDelay);

    ONIXS_ILINK3_NODISCARD
    bool tcpNoDelayOption() const noexcept ;

    ONIXS_ILINK3_NODISCARD
    int socketReceiveBufferSize() const noexcept;

    Gateway& socketReceiveBufferSize(int bufferSize);

    ONIXS_ILINK3_NODISCARD
    int socketSendBufferSize() const noexcept;

    Gateway& socketSendBufferSize(int bufferSize);
 
protected:
    ONIXS_ILINK3_NODISCARD
    bool isConnectionClosed(const Timeout& timeout) const;

    ONIXS_ILINK3_NODISCARD
    bool isConnectionClosed() const;

    MessageBasePtr receive() const;

    MessageBasePtr tryReceive(const std::chrono::microseconds& timeout = defaultTimeout()) const;

    Negotiate500Ptr receiveNegotiate();

    Negotiate500Ptr acceptNegotiate(UInt32 previousSeqNo = 0);

    Negotiate500Ptr rejectNegotiate(NegotiationRejectErrorCode::Enum errorCodes = NegotiationRejectErrorCode::Enum(),
        const std::string & reason = std::string());

    Establish503Ptr receiveEstablish();

    Establish503Ptr acceptEstablish(UInt32 outgoingSequenceNumber = 1, UInt64 previousUuid = 0, UInt32 previousSeqNo = 0);

    Establish503Ptr rejectEstablish(UInt32 outgoingSequenceNumber = 1, EstablishmentRejectErrorCode::Enum errorCodes = EstablishmentRejectErrorCode::Enum(), const std::string & reason = std::string());

    Terminate507Ptr receiveTerminate();

    Terminate507Ptr acceptTerminate();

    Gateway& sendTerminate(const std::string& reason = {}, UInt16 errCode = TerminateErrorCode::Other);

    Terminate507Ptr terminate(const std::string& reason = {}, UInt16 errCode = TerminateErrorCode::Other);

    NegotiationResponse501Container createNegotiationResponse(const Negotiate500Ptr& request, UInt32 previousSeqNo);

    NegotiationReject502Container createNegotiationReject(const Negotiate500Ptr& request, NegotiationRejectErrorCode::Enum errorCodes,
        const std::string & reason);

    EstablishmentAck504Container createEstablishmentAck(const Establish503Ptr& request, UInt32 outgoingSequenceNumber);

    EstablishmentReject505Container createEstablishmentReject(const Establish503Ptr& request, UInt32 outgoingSequenceNumber,
        EstablishmentRejectErrorCode::Enum errorCodes, const std::string & reason);

    Terminate507Container createTerminate(const Terminate507Ptr& request);

    Terminate507Container createTerminate(const std::string& reason, UInt16 errCode);

    Sequence506Container createSequence(UInt32 nextSeqNo, KeepAliveLapsed::Enum keepAliveLapsed = KeepAliveLapsed::NotLapsed, UInt64 uuid = 0);

    Gateway& send(Messaging::SbeMessage, Messaging::SimpleOpenFramingHeader&);

    Gateway& sendData(const void* data, size_t size);

    Gateway& close();

    static Timeout defaultTimeout()
    {
        return Timeout(30000);
    }

    UInt64 uId_{0};
 
private:
    Messaging::FTI::Enum faultToleranceIndicator_{Messaging::FTI::Enum::Primary};
 
    class Impl;
    Impl* impl_;
};
 
 
template <typename TMsg>
MessagePtr<TMsg> Gateway::receiveTypedMessage()
{
    return cast<TMsg>(receive());
}
 
template <typename SbeMessageType, size_t MaxMessageSize, typename MessageInitializer>
Gateway& Gateway::send(iLink3::Messaging::MessageHolder<SbeMessageType, MaxMessageSize, MessageInitializer>& msg)
{
    const auto messageSize = msg.setHeader();
    auto* const header = msg.header();
    assert(header);
 
    return send(Messaging::SbeMessage(header + 1, messageSize), *header);
}
 
template <typename SbeMessageType, size_t MaxMessageSize, typename MessageInitializer>
Gateway& Gateway::send(iLink3::Messaging::MessageHolder<SbeMessageType, MaxMessageSize, MessageInitializer>&& msg)
{
    return send(msg);
}
 
template <typename Holder>
typename std::enable_if<std::is_base_of<TagBased::Message, typename Holder::MessageType>::value>::type
    setSeqNum(Holder& msg, SeqNumber num)
{
    msg->set(TagBased::Tags::SeqNum, num);
}
 
template <typename Holder>
typename std::enable_if<!std::is_base_of<TagBased::Message, typename Holder::MessageType>::value>::type
    setSeqNum(Holder& msg, SeqNumber num)
{
    msg->setSeqNum(num);
}
 
template <typename SbeMessageType, size_t MaxMessageSize, typename MessageInitializer>
Gateway& Gateway::send(iLink3::Messaging::MessageHolder<SbeMessageType, MaxMessageSize, MessageInitializer>& msg, SeqNumber num)
{
    setSeqNum(msg, num);
    return send(msg);
}
 
template <typename SbeMessageType, size_t MaxMessageSize, typename MessageInitializer>
Gateway& Gateway::send(iLink3::Messaging::MessageHolder<SbeMessageType, MaxMessageSize, MessageInitializer>&& msg, SeqNumber num)
{
    setSeqNum(msg, num);
    return send(msg);
}
 
template <typename SbeMessageType, size_t MaxMessageSize, typename MessageInitializer>
Gateway& Gateway::send(
    iLink3::Messaging::MessageHolder<SbeMessageType, MaxMessageSize, MessageInitializer>& msg, std::initializer_list<SeqNumber> numbers)
{
    for(auto seqNum : numbers)
    {
        send(msg, seqNum);
    }
 
    return *this;
}
 
template <typename SbeMessageType, size_t MaxMessageSize, typename MessageInitializer>
Gateway& Gateway::send(
    iLink3::Messaging::MessageHolder<SbeMessageType, MaxMessageSize, MessageInitializer>&& msg, std::initializer_list<SeqNumber> numbers)
{
    for(auto seqNum : numbers)
    {
        send(msg, seqNum);
    }
 
    return *this;
}
 
 
}}}}