seqeron 0.18.0
Loading...
Searching...
No Matches
seqeron C++ client

The C++ client of seqeron: header-only, linked as seqeron::seqeron_core. A C++ client is a thin stub that talks over IPC to a host process, the Java ClientProxy, which runs the cluster session, the queue and the fences (doc/seqeron-protocol-spec.md §17). The direct C++ client is retired.

Start here

To Take
Run one instance of an elected active/standby gateway pair hosted::Gateway
Run a co-located application: one replica per node, publishing while its node leads hosted::Application
Follow the ordered stream, publishing nothing hosted::Consumer

A stub's listener sees Payload and ClusterError, and a publish returns Publish. The listener concepts are in app/Listeners.hpp.

Namespaces

All under org::limitless::seqeron.

Namespace Holds
hosted The stubs above
app The types the stubs share with the Java client tier: Payload, ClusterError, GroupDirectory, OutstandingWork, SnapshotListener and the listener concepts
protocol The wire contract: the frame envelope and SequencedEvent, the counter ids, the host protocol's ids and Publish
util Support code: infrastructure rather than API

The detail namespaces and the generated SBE codecs are not API and are left out.

Getting it

include(FetchContent)
FetchContent_Declare(seqeron
GIT_REPOSITORY https://github.com/FredrikJDahlberg/seqeron.git
GIT_TAG v<version>)
FetchContent_MakeAvailable(seqeron)
target_link_libraries(my_app PRIVATE seqeron::seqeron_core)

Or find_package(seqeron) against an installed prefix, which takes your own installed Aeron.

Read next

  • Client API: what a client programs against, in both languages, and what is not API
  • Protocol specification: the frames, the two families and the system vocabulary
  • Examples: FollowStream, the smallest complete client, and the two façades in use