OnixS C++ B3 BOE Binary Order Entry  1.2.0
API Documentation
Public Member Functions | List of all members
SessionStorage Class Referenceabstract

#include <OnixS/B3/BOE/SessionStorage.h>

Public Member Functions

virtual ~SessionStorage ()=default
 
virtual const std::string & id () const =0
 
virtual UInt64 sessionVerId () const =0
 
virtual void sessionVerId (UInt64 value)=0
 
virtual SeqNumber inSeqNum () const =0
 
virtual void inSeqNum (SeqNumber msgSeqNum)=0
 
virtual SeqNumber outSeqNum () const =0
 
virtual void outSeqNum (SeqNumber msgSeqNum)=0
 
virtual bool negotiated () const =0
 
virtual void negotiated (bool negotiated)=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
 

Detailed Description

Definition at line 65 of file SessionStorage.h.

Constructor & Destructor Documentation

virtual ~SessionStorage ( )
virtualdefault

Destructor.

Member Function Documentation

virtual void close ( bool  doBackup = false)
pure virtual

Closes the storage.

virtual void flush ( )
pure virtual

Flushes all internal buffers.

virtual const std::string& id ( ) const
pure virtual
Returns
Storage Id.
virtual SeqNumber inSeqNum ( ) const
pure virtual
Returns
the expected sequence number of the next inbound message.
virtual void inSeqNum ( SeqNumber  msgSeqNum)
pure virtual

Sets the expected sequence number of the next inbound message.

virtual bool negotiated ( ) const
pure virtual
Returns
true if the session is negotiated (the Negotiation Response message has been received in reply to the Negotiation message); otherwise - false.
virtual void negotiated ( bool  negotiated)
pure virtual

Sets the "negotiated" status.

The session is negotiated when the Negotiation Response message has been received in reply to the Negotiation message.

virtual SeqNumber outSeqNum ( ) const
pure virtual
Returns
the sequence number of the next outgoing message.
virtual void outSeqNum ( SeqNumber  msgSeqNum)
pure virtual

Sets the sequence number of the next outgoing message.

virtual Timestamp sessionCreationTime ( ) const
pure virtual
Returns
the session creation time.
virtual void sessionCreationTime ( Timestamp  )
pure virtual

Sets the session creation time.

virtual UInt64 sessionVerId ( ) const
pure virtual
Returns
Session Version Identification (sessionVerId).
virtual void sessionVerId ( UInt64  value)
pure virtual

Sets Session Version Identification (sessionVerId).

virtual void storeInboundMessage ( const NetworkMessage &  message,
SeqNumber  msgSeqNum,
Timestamp  messageReceivingUtcTimestamp = Timestamp() 
)
pure virtual

Logs the given inbound message.

virtual void storeOutboundMessage ( const NetworkMessage &  message,
SeqNumber  msgSeqNum,
Timestamp  messageSendingUtcTimestamp = Timestamp() 
)
pure virtual

Logs the given outgoing message.

virtual void warmup ( size_t  messageSize,
Timestamp  ts = Timestamp() 
)
pure virtual

Warmup the storage.

The documentation for this class was generated from the following file: