Leka
A low-latency C++20 price-time-priority limit order book and matching engine
▶ Replay viewer
Loading...
Searching...
No Matches
lob::SequenceNumber Class Reference

Monotonic engine sequence used for deterministic processing order. More...

#include <sequence_number.hpp>

Public Member Functions

 SequenceNumber ()
 Constructs an invalid, zero-valued sequence number.
 SequenceNumber (std::uint64_t sequenceNumber)
 Constructs a sequence number from its numeric value.
std::uint64_t getSequenceNumber () const
 Returns the underlying sequence value.
bool isValid () const
 Returns whether the sequence number is nonzero.
auto operator<=> (const SequenceNumber &other) const =default
 Compares sequence numbers by processing order.

Detailed Description

Monotonic engine sequence used for deterministic processing order.

Definition at line 8 of file sequence_number.hpp.

Constructor & Destructor Documentation

◆ SequenceNumber() [1/2]

lob::SequenceNumber::SequenceNumber ( )
inlineexplicit

Constructs an invalid, zero-valued sequence number.

Definition at line 14 of file sequence_number.hpp.

Referenced by operator<=>().

◆ SequenceNumber() [2/2]

lob::SequenceNumber::SequenceNumber ( std::uint64_t sequenceNumber)
inlineexplicit

Constructs a sequence number from its numeric value.

Definition at line 17 of file sequence_number.hpp.

Member Function Documentation

◆ getSequenceNumber()

std::uint64_t lob::SequenceNumber::getSequenceNumber ( ) const
inline

Returns the underlying sequence value.

Definition at line 20 of file sequence_number.hpp.

◆ isValid()

bool lob::SequenceNumber::isValid ( ) const
inline

Returns whether the sequence number is nonzero.

Definition at line 23 of file sequence_number.hpp.

◆ operator<=>()

auto lob::SequenceNumber::operator<=> ( const SequenceNumber & other) const
default

Compares sequence numbers by processing order.

References SequenceNumber().


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