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/ConflatedTCP/ABI.h>

#if defined(ONIXS_CONFLATEDTCP_HAS_GATEWAY_EMULATOR)

#include <OnixS/CME/ConflatedTCP/Messaging.h>
#include <OnixS/CME/ConflatedTCP/testing/MessagePtr.h>
#include <OnixS/CME/ConflatedTCP/testing/ClientMessageListener.h>

#include <chrono>

namespace OnixS {
namespace CME {
namespace ConflatedTCP {
namespace Testing {

// Assume NegotiationResponse202::credentials is empty
constexpr
UInt16 calculateNegotiationResponse202MaxSize()
{
    using Message = NegotiationResponse202;

    return
        Message::blockLength(Message::Schema::Version)
        + MessageHeader::Size
        + Message::getMinimalVariableFieldsSize(Message::Schema::Version);
}

//  Type aliases
using NegotiationResponse202Container = MessageHolder<NegotiationResponse202, calculateNegotiationResponse202MaxSize()>;
using NegotiationReject201Container = MessageHolder<NegotiationReject201>;
using Terminate203Container = MessageHolder<Terminate203>;
using RequestAck206Container = MessageHolder<RequestAck206>;
using RequestReject207Container = MessageHolder<RequestReject207>;

using MessageBasePtr = MessagePtr<SbeMessage>;
using Negotiate200Ptr = MessagePtr<Negotiate200>;
using Terminate203Ptr = MessagePtr<Terminate203>;
using RequestAck206Ptr = MessagePtr<RequestAck206>;
using RequestReject207Ptr = MessagePtr<RequestReject207>;

/// CME Conflated TCP Gateway Emulator.
class ONIXS_CONFLATEDTCP_EXPORTED Gateway
{
public:
    explicit
    Gateway(int port, const char* host = "127.0.0.1", const std::chrono::seconds& timeout = std::chrono::seconds(10));

    ///
    virtual ~Gateway();

    /// Deleted.
    Gateway(const Gateway&) = delete;
    Gateway& operator=(const Gateway&) = delete;

    /// Move semantic.
    Gateway(Gateway&&) noexcept;
    Gateway& operator=(Gateway&&) noexcept;

    /// Swap with other.
    void swap(Gateway&) noexcept;

    /// Accepts an incoming connection.
    Gateway& acceptConnection();

    /// Accepts an incoming Conflated TCP session.
    Gateway& acceptSession(SeqNumber outgoingSequenceNumber = 1, UInt64 previousUuid = 0, UInt32 previousSeqNo = 0);

    /// Waits until the Terminate203 message is received.
    ///
    /// If the listener is provided, then receives and reports application-level messages via the corresponding callback.
    /// Responds to the Sequence506 message if received.
    Terminate203Ptr waitUntilTerminate(ClientMessageListener* listener = nullptr);

    /// Closes the accepted connection.
    Gateway& disconnect();

    /// \return the listen port.
    ONIXS_CONFLATEDTCP_NODISCARD
    int port() const noexcept;

    /// Enables logging.
    Gateway& enableLogger(const std::string& logFileName);

    /// Sends the given message.
    template <typename SbeMessageType, size_t MaxMessageSize, typename MessageInitializer>
    Gateway& send(ConflatedTCP::Messaging::MessageHolder<SbeMessageType, MaxMessageSize, MessageInitializer>& msg);

    /// Sends the given message.
    template <typename SbeMessageType, size_t MaxMessageSize, typename MessageInitializer>
    Gateway& send(ConflatedTCP::Messaging::MessageHolder<SbeMessageType, MaxMessageSize, MessageInitializer>&& msg);

    /// Sets the given sequence number and send the message.
    template <typename SbeMessageType, size_t MaxMessageSize, typename MessageInitializer>
    Gateway& send(ConflatedTCP::Messaging::MessageHolder<SbeMessageType, MaxMessageSize, MessageInitializer>& msg, SeqNumber num);

    /// Sets the given sequence number and send the message.
    template <typename SbeMessageType, size_t MaxMessageSize, typename MessageInitializer>
    Gateway& send(ConflatedTCP::Messaging::MessageHolder<SbeMessageType, MaxMessageSize, MessageInitializer>&& msg, SeqNumber num);

    /// Receives the message of the particular type.
    ///
    /// \throw std::logic_error if an unexpected type is received.
    template <typename TMsg>
    MessagePtr<TMsg> receiveTypedMessage();

    /// Accepts an incoming connection and establishes the session.
    ///
    /// - Receives and reports application-level messages via the corresponding callback.
    /// - Sends Sequence messages.
    Gateway& run(ClientMessageListener& listener);

    /// \return the sequence number of the next outgoing message.
    ONIXS_CONFLATEDTCP_NODISCARD
    SeqNumber outSeqNum() const;

    /// Sets the sequence number of the next outgoing message.
    Gateway& outSeqNum(SeqNumber nextOutSeqNum);

    /// \return UUUD.
    ONIXS_CONFLATEDTCP_NODISCARD
    UInt64 uuid() const noexcept
    {
        return uId_;
    }

    /// Sets the value of the option to improve latency at the expense of message throughput (the `TCP_NODELAY` socket option).
    Gateway& tcpNoDelayOption(bool noDelay);

    /// \return the value of the option to improve latency at the expense of message throughput (the `TCP_NODELAY` socket option).
    ///
    /// The default value is SessionSettings::Default::TcpNoDelayOption.
    ONIXS_CONFLATEDTCP_NODISCARD
    bool tcpNoDelayOption() const;

    /// \return the socket receive buffer size.
    ///
    /// The default value is SessionSettings::Default::SocketReceiveBufferSize.
    ONIXS_CONFLATEDTCP_NODISCARD
    int socketReceiveBufferSize() const;

    /// Sets the socket receive buffer size.
    ///
    /// \param bufferSize the size of the socket receive buffer size.
    /// If SessionSettings::UseOsDefaultSocketBufferSize then the default operating system value is used.
    Gateway& socketReceiveBufferSize(int bufferSize);

    /// \return the size of the socket send buffer size.
    ///
    /// The default value is SessionSettings::Default::SocketSedndBufferSize.
    ONIXS_CONFLATEDTCP_NODISCARD
    int socketSendBufferSize() const;

    /// Sets the size of the socket send buffer size.
    ///
    /// \param bufferSize the size of the socket send buffer size.
    /// If SessionSettings::UseOsDefaultSocketBufferSize then the default operating system value is used.
    Gateway& socketSendBufferSize(int bufferSize);

protected:
    /// Checks whether the connection is closed by the counterparty.
    ONIXS_CONFLATEDTCP_NODISCARD
    bool isConnectionClosed(const std::chrono::seconds& timeout) const;

    /// Checks whether the connection is closed by the counterparty
    /// using the default timeout (provided in the constructor).
    ONIXS_CONFLATEDTCP_NODISCARD
    bool isConnectionClosed() const;

    /// Receives a message.
    MessageBasePtr receive() const;

    /// Receives the Negotiate200 message.
    ///
    /// \throw std::logic_error if an unexpected type is received.
    Negotiate200Ptr receiveNegotiate();

    /// Receives the Negotiate200 and responds with the NegotiationResponse202 message.
    ///
    /// \throw std::logic_error if an unexpected type is received.
    Negotiate200Ptr acceptNegotiate(UInt32 previousSeqNo = 0);

    /// Receives the Negotiate200 message and responds with the NegotiationReject201 message.
    ///
    /// \throw std::logic_error if an unexpected type is received.
    Negotiate200Ptr rejectNegotiate(ErrorCodes::Enum errorCodes = ErrorCodes::Enum(), const std::string & reason = std::string());

    /// Receive the Terminate203 message.
    ///
    /// \throw std::logic_error if an unexpected type is received.
    Terminate203Ptr receiveTerminate();

    /// Receive the Terminate203 message and responds with the Terminate203 message.
    ///
    /// \throw std::logic_error if an unexpected type is received.
    Terminate203Ptr acceptTerminate();

    /// Sends the Terminate203 message.
    Gateway& sendTerminate(const std::string& reason = {}, ErrorCodes::Enum errCode = ErrorCodes::Other);

    /// Sends the Terminate203 meassage and waist until the response is received.
    Terminate203Ptr terminate(const std::string& reason = {}, ErrorCodes::Enum errCode = ErrorCodes::Other);

    /// Creates a NegotiationResponse202 message
    NegotiationResponse202Container createNegotiationResponse(const Negotiate200Ptr& request, UInt32 previousSeqNo);

    /// Creates a NegotiationReject201 message.
    NegotiationReject201Container createNegotiationReject(const Negotiate200Ptr& request, ErrorCodes::Enum errorCodes, const std::string & reason);

    /// Creates a RequestAck206 message.
    template <typename TRequestMsg>
    RequestAck206Container createRequestAck(const TRequestMsg& request);

    /// Creates a RequestReject207 message.
    template <typename TRequestMsg>
    RequestReject207Container createRequestReject(const TRequestMsg& request);

    /// Creates a Terminate203 message.
    Terminate203Container createTerminate(const Terminate203Ptr& request);

    /// Creates a Terminate203 message.
    Terminate203Container createTerminate(const std::string& reason, ErrorCodes::Enum errCode);

    /// Sends the given message.
    Gateway& send(Messaging::SbeMessage, Messaging::SimpleOpenFramingHeader&);

    /// Sends the given data
    Gateway& sendData(const void* data, size_t size);

    /// UUID.
    UInt64 uId_{0};

private:
    template<typename MessageType>
    void invokeCallback(void(ClientMessageListener::*Callback)(const MessageType &, Gateway *), ClientMessageListener * listener, const MessageBasePtr & msg)
    {
        if(listener)
            (listener->*Callback)(cast<MessageType>(msg), this);
    }

    class Impl;
    Impl* impl_;
};

template <typename TRequestMsg>
RequestAck206Container Gateway::createRequestAck(const TRequestMsg& request)
{
    MessageHolder<RequestAck206> response;
    
    response.message()
        .setReqId(request->reqId())
        .setSubscriptionReqType(request->subscriptionReqType())
        .setReqIdStatus(RequestIDStatus::FullAck);
    
    return response;
}

template <typename TRequestMsg>
RequestReject207Container Gateway::createRequestReject(const TRequestMsg& request)
{
    MessageHolder<RequestReject207> response;

    response.message()
        .setReqId(request->reqId())
        .setReqRejReason(ReqRejReason::Other);

    return response;
}

template <typename TMsg>
MessagePtr<TMsg> Gateway::receiveTypedMessage()
{
    return cast<TMsg>(receive());
}

template <typename SbeMessageType, size_t MaxMessageSize, typename MessageInitializer>
Gateway& Gateway::send(ConflatedTCP::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(ConflatedTCP::Messaging::MessageHolder<SbeMessageType, MaxMessageSize, MessageInitializer>&& msg)
{
    return send(msg);
}

template <typename SbeMessageType, size_t MaxMessageSize, typename MessageInitializer>
Gateway& Gateway::send(ConflatedTCP::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(ConflatedTCP::Messaging::MessageHolder<SbeMessageType, MaxMessageSize, MessageInitializer>&& msg, SeqNumber num)
{
    setSeqNum(msg, num);
    return send(msg);
}

}}}}

#endif