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
{
class ONIXS_CONFLATEDTCP_EXPORTED Session
{
public:
    static const UInt64 UndefinedUuid = 0;

    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();

    UInt64 uuid() const;

    const std::string id() const;

    int marketSegmentId() const;

    const std::string customKey() const;

    Session& connect(const std::string &host, Port port);

    Session& disconnect(const std::string &reason = "Terminate");

    template <typename SbeMessageType, size_t MaxMessageSize, typename MessageInitializer>
    Session& send(Messaging::MessageHolder<SbeMessageType, MaxMessageSize, MessageInitializer> &msg);
 
#if defined(ONIXS_CONFLATEDTCP_CXX11)

    template <typename SbeMessageType, size_t MaxMessageSize, typename MessageInitializer>
    Session& send(Messaging::MessageHolder<SbeMessageType, MaxMessageSize, MessageInitializer> &&msg);
 
#endif
 
#if defined(ONIXS_CONFLATEDTCP_CXX11)

    template <typename SbeMessageType, size_t MaxMessageSize, typename MessageInitializer>
    Session& send(Messaging::MessageHolders<SbeMessageType, MaxMessageSize, MessageInitializer> &msgs);
 
#endif
 
#if defined(ONIXS_CONFLATEDTCP_CXX11)

    template <typename SbeMessageType, size_t MaxMessageSize, typename MessageInitializer>
    Session& send(std::initializer_list<Messaging::MessageHolder<SbeMessageType, MaxMessageSize, MessageInitializer> > list);
 
#endif

    std::string remoteHost() const;

    std::string remoteIpAddress() const;

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

    std::string localNetworkInterface() const;

    Session& localNetworkInterface(const std::string &value);

    Port localPort() const;

    bool tcpNoDelayOption() const;

    Session& tcpNoDelayOption(bool value);

    const SocketOptions &socketOptions() const;

    Session& socketOptions(const SocketOptions &options);
 
    static const int UndefinedAffinity = -1;

    Session& receivingThreadAffinity(CpuIndex cpuIndex);

    Session& receivingThreadAffinity(const CpuIndexes &cpuIndexes);

    const CpuIndexes &receivingThreadAffinity() const;

    Session& sendingThreadAffinity(CpuIndex cpuIndex);

    Session& sendingThreadAffinity(const CpuIndexes &cpuIndexes);

    const CpuIndexes &sendingThreadAffinity() const;

    int receivingThreadPriority() const;

    Session& receivingThreadPriority(int priority);

    int sendingThreadPriority() const;

    Session& sendingThreadPriority(int priority);

    int receivingThreadPolicy() const;

    Session& receivingThreadPolicy(int policy);

    int sendingThreadPolicy() const;

    Session& sendingThreadPolicy(int policy);

    unsigned receiveSpinningTimeout() const;

    Session& receiveSpinningTimeout(unsigned timeoutInUs);

    unsigned sendSpinningTimeout() const;

    Session& sendSpinningTimeout(unsigned timeoutInUs);

    bool reportNewMessagesWhileWaitingForMissedMessages() const;

    Session& reportNewMessagesWhileWaitingForMissedMessages(bool value);

    bool validateSequenceNumbers() const;

    Session& validateSequenceNumbers(bool validate);

    unsigned messageGrouping() const;

    Session& messageGrouping(unsigned numberOfMessagesToGroup);

    SessionStorageType::Enum storageType() const;

    const std::string &storageId() const;

    SeqNumber outSeqNum() const;

    Session& outSeqNum(SeqNumber nextOutSeqNum);

    SeqNumber inSeqNum() const;

    Session& inSeqNum(SeqNumber nextExpectedInSeqNum);

    SeqNumber previousSeqNo() const;

    Session& previousSeqNo(SeqNumber value);

    Messaging::UInt64 previousUuid() const;

    Session& previousUuid(Messaging::UInt64 value);

    Session& reset(bool startOfWeek = false);

    SessionStateId::Enum state();

    Messaging::Timestamp creationTime() const;

    void flushSessionStorage();

    unsigned reconnectAttempts() const;

    Session& reconnectAttempts(unsigned reconnectAttempts);

    unsigned reconnectInterval() const;

    Session& reconnectInterval(unsigned seconds);

    bool localTimeUsage() const;

    Session& localTimeUsage(bool useLocalTime);

    const std::string &storageDirectory() const;

    bool logBeforeSending() const;

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

    const Session& log(const std::string &message) const;

    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 defined(ONIXS_CONFLATEDTCP_CXX11)
 
template <typename SbeMessageType, size_t MaxMessageSize, typename MessageInitializer>
Session& Session::send(Messaging::MessageHolder<SbeMessageType, MaxMessageSize, MessageInitializer> &&msg)
{
    send(msg);
 
    return *this;
}
 
#endif
 
#if defined(ONIXS_CONFLATEDTCP_CXX11)
 
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
 
 
}
}
}