OnixS C++ CME iLink 3 Binary Order Entry Handler  1.18.0
API Documentation
Public Member Functions | List of all members
SessionStorage Class Referenceabstract

#include <OnixS/CME/iLink3/SessionStorage.h>

Public Member Functions

virtual ~SessionStorage ()=default
 
virtual const std::string & id () const =0
 
virtual UInt64 uuid () const =0
 
virtual void uuid (UInt64 value)=0
 
virtual UInt64 previousUuid () const =0
 
virtual void previousUuid (UInt64 value)=0
 
virtual SeqNumber inSeqNum () const =0
 
virtual void inSeqNum (SeqNumber msgSeqNum)=0
 
virtual SeqNumber previousSeqNum () const =0
 
virtual void previousSeqNum (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 SeqNumber previousSeqNum ( ) const
pure virtual
Returns
the sequence number of the last business message published by CME with the PreviousUUID.

If no business message was published, the value is zero.

virtual void previousSeqNum ( SeqNumber  msgSeqNum)
pure virtual

Sets the sequence number of the last business message published by CME with the PreviousUUID.

virtual UInt64 previousUuid ( ) const
pure virtual
Returns
The UUID from the previously established session.
  • This can be the CME assigned default UUID=0 for messages published by CME before the first Negotiation of the customer at the beginning of the week.
  • This can be the last UUID used by the customer from the previously established session.
virtual void previousUuid ( UInt64  value)
pure virtual

Sets the UUID from the previously Established session.

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

Sets the session creation time.

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 UInt64 uuid ( ) const
pure virtual
Returns
Universally Unique Identifier (UUID).
virtual void uuid ( UInt64  value)
pure virtual

Sets Universally Unique Identifier (UUID).

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: