Session.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>
#include <OnixS/CME/ConflatedTCP/Defines.h>
#include <OnixS/CME/ConflatedTCP/SessionListener.h>
#include <OnixS/CME/ConflatedTCP/SessionSettings.h>
#include <OnixS/CME/ConflatedTCP/SessionStorage.h>
#include <OnixS/CME/ConflatedTCP/messaging/SbeMessage.h>

namespace OnixS
{
namespace CME
{
namespace ConflatedTCP
{
/**
* An Conflated TCP Session.
*/
class ONIXS_CONFLATEDTCP_EXPORTED Session
{
public:
    static const UInt64 UndefinedUuid = 0;

    /**
     * Constructor.
     *
     * \param settings Session settings.
     * \param marketSegmentId Market segment ID.
     * \param sessionListener Session listener.
     * \param marketDataListener Market Data listener.
     * \param storageType Session storage type.
     * \param storage Session storage.
     * \param uuid Universally Unique Identifier (UUID).
     * \param customKey Custom key that could be used to distinguish sessions with the same UUID, Session ID, FirmId, and Market Segment ID values.
     */
    Session(const SessionSettings &settings, int marketSegmentId,
        SessionListener* sessionListener, MDP::MarketDataListener* marketDataListener, SessionStorageType::Enum storageType = SessionStorageType::FileBased,
        SessionStorage *storage = ONIXS_CONFLATEDTCP_NULLPTR, UInt64 uuid = UndefinedUuid, const std::string &customKey = "" );

    ~Session();

    /// \return the Universally Unique Identifier (UUID).
    UInt64 uuid() const;

    /// \return Session ID (assigned by the exchange).
    const std::string id() const;

    /// \return Market Segment ID.
    int marketSegmentId() const;

    /// \return Custom key that could be used to distinguish sessions with the same UUID, Session ID, FirmId, and Market Segment ID values.
    const std::string customKey() const;

    /**
     * Establishes the connection.
     *
     * \param host Market Segment Gateway host.
     * \param port Market Segment Gateway port.
     *
     * \return This session.
     */
    Session& connect(const std::string &host, Port port);

    /**
    * Terminates the connection.
    *
    * \param reason Terminate reason details.
    *
    * \note Method blocks until the Terminate message is received in reply, or the timeout is elapsed.
    *
    * \return This session.
    */
    Session& disconnect(const std::string &reason = "Terminate");

    /**
     * Sends the message.
     *
     * \note This call is thread-safe.
     *
     * \return This session.
     */
    template <typename SbeMessageType, size_t MaxMessageSize, typename MessageInitializer>
    Session& send(Messaging::MessageHolder<SbeMessageType, MaxMessageSize, MessageInitializer> &msg);

#if ONIXS_CONFLATEDTCP_COMPILER_CXX_RVALUE_REFERENCES

    /**
     * Sends the message.
     *
     * \note This call is thread-safe.
     *
     * \return This session.
     */
    template <typename SbeMessageType, size_t MaxMessageSize, typename MessageInitializer>
    Session& send(Messaging::MessageHolder<SbeMessageType, MaxMessageSize, MessageInitializer> &&msg);

#endif

#if ONIXS_CONFLATEDTCP_COMPILER_CXX_ALIAS_TEMPLATES

    /**
     * Sends messages.
     *
     * \note This call is thread-safe.
     *
     * \return This session.
     */
    template <typename SbeMessageType, size_t MaxMessageSize, typename MessageInitializer>
    Session& send(Messaging::MessageHolders<SbeMessageType, MaxMessageSize, MessageInitializer> &msgs);

#endif

#if defined(ONIXS_CONFLATEDTCP_CXX11)

    /**
     * Sends messages.
     *
     * \note This call is thread-safe.
     *
     * \return This session.
     */
    template <typename SbeMessageType, size_t MaxMessageSize, typename MessageInitializer>
    Session& send(std::initializer_list<Messaging::MessageHolder<SbeMessageType, MaxMessageSize, MessageInitializer> > list);

#endif

    /**
    * Warms up the sending path.
    *
    * \param msg SBE message to warm up the sending path.
    *
    * \note This call is thread-safe.
    *
    * \return This session.
    */
    template <typename SbeMessageType, size_t MaxMessageSize>
    Session& warmUp(Messaging::MessageHolder<SbeMessageType, MaxMessageSize> &msg)
    {
        warmUp(msg.message(), *msg.header());
        return *this;
    }

    /// \return the host name the session is connected to.
    std::string remoteHost() const;

    /// \return the IP address the session is connected to.
    std::string remoteIpAddress() const;

    /// \return the port number the session is connected to.
    Port remotePort() const;

    // TODO: move to SessionSettings
    std::pair<Port, Port> localPortRange() const;

    // TODO: move to SessionSettings
    Session& localPortRange(std::pair<Port, Port> portRange);

    /// \return the IP Address or name of the local network interface.
    std::string localNetworkInterface() const;

    /// Sets the IP Address or name of the local network interface.
    Session& localNetworkInterface(const std::string &value);

    /// \return the local network port number.
    Port localPort() const;

    /// \return the value of the `TCP_NODELAY` option (improve latency at the expense of message throughput).
    bool tcpNoDelayOption() const;

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

    /// \return Socket options.
    const SocketOptions &socketOptions() const;

    /// Sets socket options.
    Session& socketOptions(const SocketOptions &options);

    static const int UndefinedAffinity = -1;

    /// Sets the receiving thread CPU affinity.
    Session& receivingThreadAffinity(CpuIndex cpuIndex);

    /// \return the receiving thread CPU affinity.
    Session& receivingThreadAffinity(const CpuIndexes &cpuIndexes);

    /// Sets the receiving thread CPU affinity.
    const CpuIndexes &receivingThreadAffinity() const;

    /// Sets the sending thread CPU affinity.
    Session& sendingThreadAffinity(CpuIndex cpuIndex);

    /// Sets the sending thread CPU affinity.
    Session& sendingThreadAffinity(const CpuIndexes &cpuIndexes);

    /// \return the auxiliary sending thread CPU affinity.
    const CpuIndexes &sendingThreadAffinity() const;

    /// \return the scheduling priority of the receiving thread.
    int receivingThreadPriority() const;

    /// Sets the scheduling priority of the receiving thread.
    Session& receivingThreadPriority(int priority);

    /// \return the scheduling priority of the sending thread.
    int sendingThreadPriority() const;

    /// \return the scheduling priority of the sending thread.
    Session& sendingThreadPriority(int priority);

    /// \return the receiving thread policy.
    int receivingThreadPolicy() const;

    /// Sets the receiving thread policy.
    Session& receivingThreadPolicy(int policy);

    /// Sets the sending thread policy.
    int sendingThreadPolicy() const;

    /// \return the sending thread policy.
    Session& sendingThreadPolicy(int policy);

    /// \return the receive spinning timeout value (in microseconds).
    unsigned receiveSpinningTimeout() const;

    /// Sets the receive spinning timeout value (in microseconds).
    Session& receiveSpinningTimeout(unsigned timeoutInUs);

    /// \return the send spinning timeout value (in microseconds).
    unsigned sendSpinningTimeout() const;

    /// Sets the send spinning timeout value (in microseconds).
    Session& sendSpinningTimeout(unsigned timeoutInUs);

    /// \return `true` if new messages are reported even when the message gap is detected,
    /// and the reply on the [Retransmit Request](https://www.cmegroup.com/confluence/display/EPICSANDBOX/Retransmit+Request)
    /// message is expected, otherwise - `false`.
    bool reportNewMessagesWhileWaitingForMissedMessages() const;

    /// Sets the option to report new messages even when the message gap is detected,
    /// and the reply on the [Retransmit Request](https://www.cmegroup.com/confluence/display/EPICSANDBOX/Retransmit+Request)
    /// message is expected.
    Session& reportNewMessagesWhileWaitingForMissedMessages(bool value);

    /// \return `true` if incoming message sequence numbers are validated, otherwise - `false`.
    bool validateSequenceNumbers() const;

    /// Turns on/off the validation of incoming message sequence numbers.
    Session& validateSequenceNumbers(bool validate);

    /// \return the number of messages to be sent together.
    unsigned messageGrouping() const;

    /**
     * Sets the number of messages to be sent together.
     *
     * \param numberOfMessagesToGroup If the parameter is zero (by default) or one, the Handler tries to send
     * an outgoing application-level message in the context of the thread that calls the OnixS::CME::ConflatedTCP::Session::send method.
     * If the message cannot be sent immediately, it is stored in the queue for the subsequent sending by the sending thread.
     * If this parameter is larger than one, the Handler stores outgoing SBE messages in the queue for the subsequent sending by the sending thread.
     *
     * \return This session.
     */
    Session& messageGrouping(unsigned numberOfMessagesToGroup);

    /// \return Session storage type.
    SessionStorageType::Enum storageType() const;

    /// \return Session storage ID.
    const std::string &storageId() const;

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

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

    /// \return the expected sequence number of the next inbound message.
    SeqNumber inSeqNum() const;

    /// Sets the expected sequence number of the next inbound message.
    Session& inSeqNum(SeqNumber nextExpectedInSeqNum);

    /**
     * \return the sequence number of the last business message published by CME with the PreviousUUID.
     *
     *  If no business message was published, the value is zero.
     */
    SeqNumber previousSeqNo() const;

    /// Sets the sequence number of the last business message published by CME with the PreviousUUID.
    Session& previousSeqNo(SeqNumber value);

    /**
     * \return The UUID from the previously Established session.
     *
     * - This can be the CME assigned default UUID=0 for messages published by CME before first Negotiation of customer at the beginning of the week.
     * - This can be the last UUID as used by the customer from the previously Established session.
     */
    Messaging::UInt64 previousUuid() const;

    /// Sets the UUID from the previously Established session.
    Session& previousUuid(Messaging::UInt64 value);

    /**
     * Backups the current log files, resets the sequence numbers to 1 and generates a new UUID.
     *
     * \warning Can be called only when the session is disconnected.
     *
     * \param startOfWeek if `true` then the PreviousUUID and PreviousSeqNum are reset to 0.
     *
     * \return This session.
     */
    Session& reset(bool startOfWeek = false);

    /// \return Session's current state.
    SessionStateId::Enum state();

    /// \return the time when the session was created or the last reset operation was performed.
    Messaging::Timestamp creationTime() const;

    /// Flushes all internal buffers of the session storage.
    void flushSessionStorage();

    /// \return the maximum number of tries to restore the telecommunications link.
    unsigned reconnectAttempts() const;

    /// Sets the maximum number of tries to restore the telecommunications link.
    Session& reconnectAttempts(unsigned reconnectAttempts);

    /// \return the time interval between retries to restore the telecommunications link (seconds).
    unsigned reconnectInterval() const;

    /// Sets the time interval between retries to restore the telecommunications link (seconds).
    Session& reconnectInterval(unsigned seconds);

    /// \return the usage of local time in Handler events and logs files.
    bool localTimeUsage() const;

    /// Specifies the usage of local time in Handler events and logs files.
    Session& localTimeUsage(bool useLocalTime);

    /// \return The session storage directory.
    const std::string &storageDirectory() const;

    /// \return `true` if logging of an outgoing message to the session storage is performed before sending it to the wire, otherwise - `false`.
    bool logBeforeSending() const;

    /// Sets the option to log an outgoing message to the session storage before sending it to the wire.
    Session& logBeforeSending(bool value);

    // @TODO: document this method.
    size_t incomingMessageGapQueueMaximumSize() const;

    // @TODO: document this method.
    Session& incomingMessageGapQueueMaximumSize(size_t value);

    /// Write the given user's message to the Handler's log file using the session formatted Id.
    const Session& log(const std::string &message) const;

    /// \return the human-friendly description.
    std::string toString() const;

private:
    Session(const Session& );
    Session& operator=(const Session& );

    void send(Messaging::SbeMessage msg, Messaging::SimpleOpenFramingHeader &header);
    void send(std::vector<Messaging::SbeMessage> msgs, std::vector<Messaging::SimpleOpenFramingHeader *> headers);
    void warmUp(Messaging::SbeMessage msg, Messaging::SimpleOpenFramingHeader &header);

    struct Impl;
    Impl *const impl_;
};

template <typename SbeMessageType, size_t MaxMessageSize, typename MessageInitializer>
Session& Session::send(Messaging::MessageHolder<SbeMessageType, MaxMessageSize, MessageInitializer> &msg)
{
    const Messaging::MessageSize messageSize = msg.setHeader();
    Messaging::SimpleOpenFramingHeader *const header = msg.header();
    send(Messaging::SbeMessage(header + 1, messageSize, Messaging::SbeMessage::NoCheck()), *header);

    return *this;
}

#if ONIXS_CONFLATEDTCP_COMPILER_CXX_RVALUE_REFERENCES

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

    return *this;
}

#endif

#if ONIXS_CONFLATEDTCP_COMPILER_CXX_ALIAS_TEMPLATES

template <typename SbeMessageType, size_t MaxMessageSize, typename MessageInitializer>
Session& Session::send(Messaging::MessageHolders<SbeMessageType, MaxMessageSize, MessageInitializer> &msgs)
{
    std::vector<Messaging::SbeMessage> messages(msgs.size());
    std::vector<Messaging::SimpleOpenFramingHeader *> headers(msgs.size());

    for (size_t i = 0; i < msgs.size(); ++i)
    {
        const Messaging::MessageSize messageSize = msgs[i].setHeader();
        Messaging::SimpleOpenFramingHeader *const header = msgs[i].header();
        messages[i] = Messaging::SbeMessage(header + 1, messageSize, Messaging::SbeMessage::NoCheck());
        headers[i] = header;
    }

    send(messages, headers);

    return *this;
}

#endif

#if defined(ONIXS_CONFLATEDTCP_CXX11)

template <typename SbeMessageType, size_t MaxMessageSize, typename MessageInitializer>
Session& Session::send(std::initializer_list<Messaging::MessageHolder<SbeMessageType, MaxMessageSize, MessageInitializer> > list)
{
    auto messages = Messaging::MessageHolders<SbeMessageType, MaxMessageSize, MessageInitializer>{list};
    return send(messages);
}

#endif


}
}
}