C++

This is the C++ API used by the generated store classes, and to be used in the application to instantiate the stored::Debugger, stored::Synchronizer and the relevant stored::ProtocolLayer subclasses to build a protocol stack for your application.

• Config
  • stored::DefaultConfig
    • stored::DefaultConfig
      • AvoidDynamicMemory
      • CompressStreams
      • Debug
      • DebuggerAlias
      • DebuggerEcho
      • DebuggerIdentification
      • DebuggerList
      • DebuggerListPrefixAlways
      • DebuggerMacro
      • DebuggerRead
      • DebuggerReadMem
      • DebuggerStreamBuffer
      • DebuggerStreamBufferOverflow
      • DebuggerStreams
      • DebuggerTrace
      • DebuggerVersion
      • DebuggerWrite
      • DebuggerWriteMem
      • EnableAssert
      • EnableHooks
      • FullNames
      • StoreInLittleEndian
      • UnalignedAccess
      • stored::DefaultConfig::Allocator
        • type
  • stored::Config
    • stored::Config
• Components
  • stored::Amplifier
  • stored::FirstOrderFilter
  • stored::PID
  • stored::PinIn
  • stored::PinOut
  • stored::PulseWave
  • stored::Ramp
  • stored::Sine
• Debugger
  • Protocol
    • Capabilities
    • Echo
    • Read
    • Write
    • List
    • Alias
    • Macro
    • Identification
    • Version
    • Read memory
    • Write memory
    • Streams
    • Flush
    • Tracing
  • stored::Debugger
    • stored::Debugger
      • ListCallbackArg
      • StoreMap
      • Debugger()
      • ~Debugger()
      • capabilities()
      • decode()
      • find()
      • identification()
      • list()
      • map()
      • process()
      • setIdentification()
      • setVersions()
      • stores()
      • stream()
      • stream()
      • stream()
      • stream()
      • streams()
      • trace()
      • tracing()
      • unmap()
      • version()
      • Ack
      • CmdAlias
      • CmdCapabilities
      • CmdEcho
      • CmdFlush
      • CmdIdentification
      • CmdList
      • CmdMacro
      • CmdRead
      • CmdReadMem
      • CmdStream
      • CmdTrace
      • CmdVersion
      • CmdWrite
      • CmdWriteMem
      • Nack
      • stored::Debugger::StorePrefixComparator
        • operator()()
  • stored::DebugStoreBase
    • stored::DebugStoreBase
      • ListCallbackArg
      • ~DebugStoreBase()
      • find()
      • list()
      • name()
  • stored::DebugVariant
    • stored::DebugVariant
      • base
      • DebugVariant()
      • DebugVariant()
      • get()
      • operator!=()
      • operator==()
      • set()
      • size()
      • type()
      • valid()
• Directory
  • stored::find()
    • find()
  • stored::list()
    • list()
• Pipes
  • stored::pipes::PipeBase
  • stored::pipes::Pipe
  • stored::pipes::PipeEntry
  • stored::pipes::PipeExit
  • stored::pipes::Group
  • stored::pipes::Buffer
  • stored::pipes::Call
  • stored::pipes::Cast
  • stored::pipes::Changes
  • stored::pipes::Constrained
  • stored::pipes::Convert
  • stored::pipes::Get
  • stored::pipes::Identity
  • stored::pipes::Log
  • stored::pipes::Map
  • stored::pipes::Mux
  • stored::pipes::RateLimit
  • stored::pipes::Set
  • stored::pipes::Signal
  • stored::pipes::Tee
  • stored::pipes::Transistor
  • stored::pipes::Triggered
• Poller
  • Pollables
    • stored::Pollable
      • stored::Pollable
        • Events
        • Events_value
        • EventsFlags
          • PollInIndex
          • PollOutIndex
          • PollErrIndex
          • PollPriIndex
          • PollHupIndex
          • FlagCount
        • Pollable()
        • events
        • revents
        • user_data
        • PollErr
        • PollHup
        • PollIn
        • PollOut
        • PollPri
    • stored::PollableCallback
      • stored::PollableCallback
        • PollableCallback()
        • operator()()
        • f
      • pollable()
    • stored::PollableFd
      • stored::PollableFd
        • PollableFd()
        • fd
      • pollable()
    • stored::PollableFileLayer
      • stored::PollableFileLayer
        • PollableFileLayer()
        • layer
      • pollable()
    • stored::PollableHandle
      • stored::PollableHandle
        • PollableHandle()
        • handle
    • stored::PollableSocket
      • stored::PollableSocket
        • PollableSocket()
        • socket
      • pollable()
    • stored::PollableZmqLayer
      • stored::PollableZmqLayer
        • PollableZmqLayer()
        • layer
      • pollable()
    • stored::PollableZmqSocket
      • stored::PollableZmqSocket
        • PollableZmqSocket()
        • socket
      • pollable()
  • stored::InheritablePoller
    • stored::InheritablePoller
      • Result
      • ~InheritablePoller()
      • add()
      • clear()
      • empty()
      • poll()
      • remove()
      • reserve()
  • stored::Poller
    • stored::Poller
      • base
      • Poller()
      • ~Poller()
• Protocol
  • stored::AsciiEscapeLayer
    • stored::AsciiEscapeLayer
      • base
      • AsciiEscapeLayer()
      • ~AsciiEscapeLayer()
      • decode()
      • encode()
      • mtu()
      • Esc
      • EscMask
  • stored::BufferLayer
    • stored::BufferLayer
      • base
      • BufferLayer()
      • ~BufferLayer()
      • encode()
      • reset()
  • stored::CallbackLayer
  • stored::CompressLayer
    • stored::CompressLayer
      • Window
      • Lookahead
      • DecodeInputBuffer
      • FlagEncoding
      • FlagDecoding
      • base
      • CompressLayer()
      • ~CompressLayer()
      • decode()
      • encode()
      • idle()
      • mtu()
      • setPurgeableResponse()
  • stored::Crc16Layer
    • stored::Crc16Layer
      • polynomial
      • init
      • base
      • Crc16Layer()
      • ~Crc16Layer()
      • decode()
      • encode()
      • mtu()
      • reset()
  • stored::Crc8Layer
    • stored::Crc8Layer
      • polynomial
      • init
      • base
      • Crc8Layer()
      • ~Crc8Layer()
      • decode()
      • encode()
      • mtu()
      • reset()
  • stored::DebugArqLayer
    • stored::DebugArqLayer
      • base
      • DebugArqLayer()
      • ~DebugArqLayer()
      • decode()
      • encode()
      • mtu()
      • reset()
      • setPurgeableResponse()
      • ResetFlag
  • stored::DebugZmqLayer
    • stored::DebugZmqLayer
      • DefaultPort
      • base
      • DebugZmqLayer()
      • ~DebugZmqLayer()
      • recv()
  • stored::DoublePipeLayer
    • stored::DoublePipeLayer
      • base
      • DoublePipeLayer()
      • ~DoublePipeLayer()
      • encode()
      • fd()
      • isConnected()
      • isOpen()
      • recv()
      • reopen()
      • reset()
  • stored::FifoLoopback
  • stored::FifoLoopback1
  • stored::FileLayer
    • stored::FileLayer
      • DefaultBufferSize
      • base
      • fd_type
      • FileLayer()
      • FileLayer()
      • ~FileLayer()
      • encode()
      • fd()
      • isOpen()
      • recv()
  • stored::IdleCheckLayer
    • stored::IdleCheckLayer
      • base
      • IdleCheckLayer()
      • ~IdleCheckLayer()
      • decode()
      • encode()
      • idle()
      • idleDown()
      • idleUp()
      • setIdle()
  • stored::Loopback
    • stored::Loopback
      • Loopback()
      • ~Loopback()
      • reserve()
  • stored::NamedPipeLayer
    • stored::NamedPipeLayer
      • BufferSize
      • Inbound
      • Outbound
      • Duplex
      • base
      • NamedPipeLayer()
      • ~NamedPipeLayer()
      • encode()
      • handle()
      • isConnected()
      • name()
      • recv()
      • reopen()
  • stored::PrintLayer
    • stored::PrintLayer
      • base
      • PrintLayer()
      • ~PrintLayer()
      • decode()
      • disable()
      • enable()
      • enabled()
      • encode()
      • file()
      • setFile()
  • stored::SegmentationLayer
    • stored::SegmentationLayer
      • base
      • SegmentationLayer()
      • ~SegmentationLayer()
      • decode()
      • encode()
      • lowerMtu()
      • mtu()
      • reset()
      • ContinueMarker
      • EndMarker
  • stored::SerialLayer
    • stored::SerialLayer
      • BufferSize
      • base
      • SerialLayer()
      • ~SerialLayer()
      • resetAutoBaud()
  • stored::StdioLayer
    • stored::StdioLayer
      • DefaultBufferSize
      • base
      • fd_type
      • StdioLayer()
      • ~StdioLayer()
      • encode()
      • fd()
      • isOpen()
      • isPipeIn()
      • isPipeOut()
      • recv()
  • stored::SyncZmqLayer
    • stored::SyncZmqLayer
      • base
      • SyncZmqLayer()
      • ~SyncZmqLayer()
  • stored::TerminalLayer
    • stored::TerminalLayer
      • MaxBuffer
      • base
      • TerminalLayer()
      • TerminalLayer()
      • ~TerminalLayer()
      • decode()
      • encode()
      • mtu()
      • nonDebugEncode()
      • reset()
      • Esc
      • EscEnd
      • EscStart
  • stored::XsimLayer
    • stored::XsimLayer
      • base
      • XsimLayer()
      • ~XsimLayer()
      • encode()
      • keepAlive()
      • recv()
      • reopen()
      • req()
      • reset()
      • KeepAlive
  • Abstract classes
    • stored::ArqLayer
      • stored::ArqLayer
        • RetransmitCallbackThreshold
        • base
        • Event
          • EventNone
          • EventReconnect
          • EventEncodeBufferOverflow
          • EventRetransmit
        • ArqLayer()
        • ~ArqLayer()
        • connected()
        • decode()
        • didTransmit()
        • encode()
        • flush()
        • keepAlive()
        • mtu()
        • reset()
        • resetDidTransmit()
        • retransmits()
        • setEventCallback()
        • shrink_to_fit()
        • waitingForAck()
        • AckFlag
        • NopFlag
        • SeqMask
    • stored::PolledFileLayer
      • stored::PolledFileLayer
        • base
        • fd_type
        • ~PolledFileLayer()
        • fd()
    • stored::PolledLayer
      • stored::PolledLayer
        • base
        • ~PolledLayer()
        • isOpen()
        • lastError()
        • recv()
    • stored::ProtocolLayer
      • stored::ProtocolLayer
        • ProtocolLayer()
        • ~ProtocolLayer()
        • bottom()
        • bottom()
        • connected()
        • decode()
        • down()
        • encode()
        • encode()
        • flush()
        • mtu()
        • reset()
        • setDown()
        • setPurgeableResponse()
        • setUp()
        • stack()
        • top()
        • top()
        • up()
        • wrap()
• Synchronizer
  • Protocol
    • Hello
    • Welcome
    • Update
      • Proposal
    • Bye
  • stored::StoreJournal
    • stored::StoreJournal
      • ShortSeqWindow
      • SeqLowerMargin
      • SeqCleanThreshold
      • Key
      • Seq
      • ShortSeq
      • Size
      • StoreJournal()
      • ~StoreJournal()
      • bumpSeq()
      • changed()
      • clean()
      • decodeBuffer()
      • decodeUpdates()
      • encodeBuffer()
      • encodeHash()
      • encodeUpdates()
      • hasChanged()
      • hasChanged()
      • hash()
      • iterateChanged()
      • keyToBuffer()
      • reserveHeap()
      • seq()
      • decodeHash()
      • encodeHash()
      • keySize()
      • stored::StoreJournal::StoreCallback
        • StoreCallback()
        • ~StoreCallback()
        • doHookChanged()
        • doHookEntryRO()
        • doHookExitRO()
        • doHooks()
        • hookChanged()
        • hookChanged()
        • hookEntryRO()
        • hookEntryRO()
        • hookExitRO()
        • hookExitRO()
  • stored::SyncConnection
    • stored::SyncConnection
      • base
      • Id
      • SyncConnection()
      • ~SyncConnection()
      • decode()
      • drop()
      • isSynchronizing()
      • process()
      • reset()
      • source()
      • synchronizer()
      • Bye
      • Hello
      • Update
      • Welcome
  • stored::Synchronizable
    • stored::Synchronizable
      • MaxMessageSize
      • Objects
      • Synchronizable()
      • ~Synchronizable()
      • journal()
      • journal()
      • operator StoreJournal &()
      • operator StoreJournal const &()
      • reserveHeap()
      • stored::Synchronizable::TypedStoreCallback
        • TypedStoreCallback()
        • ~TypedStoreCallback()
        • doHookChanged()
        • doHookEntryRO()
        • doHookExitRO()
        • doHooks()
        • hookChanged()
        • hookChanged()
        • hookEntryRO()
        • hookEntryRO()
        • hookExitRO()
        • hookExitRO()
  • stored::Synchronizer
    • stored::Synchronizer
      • Synchronizer()
      • ~Synchronizer()
      • connect()
      • disconnect()
      • encodeBuffer()
      • isSynchronizing()
      • isSynchronizing()
      • map()
      • process()
      • process()
      • process()
      • process()
      • process()
      • process()
      • syncFrom()
      • toJournal()
      • unmap()
• Types
  • stored::Function
    • stored::Function
      • type
      • Function()
      • Function()
      • as()
      • callback()
      • callback()
      • container()
      • get()
      • get()
      • id()
      • operator type()
      • operator!=()
      • operator()()
      • operator()()
      • operator=()
      • operator==()
      • set()
      • set()
      • valid()
      • size()
  • stored::toType
    • stored::toType
      • type
  • stored::Variable
    • stored::Variable
      • type
      • Variable()
      • Variable()
      • Variable()
      • ~Variable()
      • as()
      • container()
      • get()
      • operator type()
      • operator!=()
      • operator=()
      • operator=()
      • operator==()
      • set()
      • valid()
      • size()
  • stored::Variable with hooks
    • stored::Variable< T, Container, true >
      • base
      • type
      • Variable()
      • Variable()
      • Variable()
      • ~Variable()
      • as()
      • container()
      • entryRO()
      • entryX()
      • exitRO()
      • exitX()
      • get()
      • key()
      • operator type()
      • operator=()
      • operator=()
      • set()
      • size()
  • stored::Variant
    • stored::Variant
      • Variant()
      • Variant()
      • Variant()
      • Variant()
      • Variant()
      • buffer()
      • callback()
      • container()
      • copy()
      • entryRO()
      • entryRO()
      • entryX()
      • entryX()
      • exitRO()
      • exitRO()
      • exitX()
      • exitX()
      • function()
      • get()
      • get()
      • get()
      • isFunction()
      • isVariable()
      • key()
      • operator!=()
      • operator==()
      • set()
      • set()
      • set()
      • set()
      • set()
      • set()
      • size()
      • toQString()
      • toQVariant()
      • type()
      • valid()
      • variable()
      • m_buffer
      • m_f
  • stored::Variant<void>
    • stored::Variant< void >
      • Variant()
      • Variant()
      • apply()
      • container()
      • entryRO()
      • entryX()
      • exitRO()
      • exitX()
      • function()
      • function()
      • get()
      • get()
      • isFunction()
      • isVariable()
      • operator!=()
      • operator==()
      • set()
      • set()
      • size()
      • type()
      • valid()
      • variable()
      • variable()
• Utilities
  • likely
    • likely
    • unlikely
  • saturated_cast
    • saturated_cast()
  • stored_assert
    • stored_assert
  • stored::banner
    • banner()
  • stored::Fifo
  • stored::memcmp_swap
    • memcmp_swap()
    • memcpy_swap()
  • stored::MessageFifo
  • stored::Scratchpad
    • stored::ScratchPad
      • maxSize
      • chunkHeader
      • spare
      • size_type
      • ScratchPad()
      • ~ScratchPad()
      • alloc()
      • capacity()
      • chunks()
      • empty()
      • max()
      • reserve()
      • reset()
      • shrink_to_fit()
      • size()
      • snapshot()
      • stored::ScratchPad::Snapshot
        • Snapshot()
        • ~Snapshot()
        • reset()
        • rollback()
  • stored::Signal
  • stored::Signalling
  • stored::string_literal
    • string_literal()
  • stored::strncmp
    • strncmp()
  • stored::strncpy
    • strncpy()
  • stored::swap_endian
    • swap_endian()
    • swap_endian()