SessionStorage.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/ABI.h>
#include <OnixS/ICE/BOE/Messaging.h>
#include <OnixS/ICE/BOE/messaging/Integral.h>
#include <OnixS/ICE/BOE/messaging/Time.h>
#include <OnixS/ICE/BOE/messaging/NetworkMessage.h>
 
#include <string>
#include <vector>
 
ONIXS_ICEBOE_NAMESPACE_BEGIN
 
using namespace ONIXS_ICEBOE_MESSAGING_NAMESPACE;

struct SessionStorageType
{
    enum Enum
    {
        Undefined = 0,

        FileBased,

        AsyncFileBased,

        MemoryBased,

        Pluggable
    };
 
    ONIXS_ICEBOE_EXPORTED static Enum parse(const std::string &);

    ONIXS_ICEBOE_EXPORTED static const char * toString(SessionStorageType::Enum);
};

class ONIXS_ICEBOE_EXPORTED SessionStorage
{
public:
    virtual ~SessionStorage() = default;

    virtual const std::string & id() const = 0;

    virtual SeqNumber inSeqNum() const = 0;

    virtual void inSeqNum(SeqNumber msgSeqNum) = 0;

    virtual SeqNumber outSeqNum() const = 0;

    virtual void outSeqNum(SeqNumber msgSeqNum) = 0;

    virtual Timestamp sessionCreationTime() const = 0;

    virtual void sessionCreationTime(Timestamp) = 0;

    virtual void close(bool doBackup = false) = 0;

    virtual void storeInboundMessage(const NetworkMessage message, SeqNumber msgSeqNum, Timestamp messageReceivingUtcTimestamp = Timestamp()) = 0;

    virtual void storeOutboundMessage(const NetworkMessage message, SeqNumber msgSeqNum, Timestamp messageSendingUtcTimestamp = Timestamp()) = 0;

    virtual void flush() = 0;

    virtual void warmup(size_t messageSize, Timestamp ts = Timestamp()) = 0;
};
 
ONIXS_ICEBOE_NAMESPACE_END