seqeron 0.18.0
Loading...
Searching...
No Matches
org::limitless::seqeron::app::Payload Class Reference

One application payload delivered in order, with the frame layer off it: the envelope is stripped, and body() strips the payload's own messageHeader too, which is where an SBE decoder wraps. More...

#include <org/limitless/seqeron/app/Payload.hpp>

Public Member Functions

std::int64_t clusterSeqNo () const noexcept
 
std::int64_t groupSeqNo () const noexcept
 
std::int32_t sourceId () const noexcept
 
std::int32_t connectionId () const noexcept
 
std::uint16_t groupMask () const noexcept
 
ReplyAddress replyAddress () const noexcept
 
std::int64_t sourceSessionId () const noexcept
 
std::int64_t clusterTimestampNs () const noexcept
 
std::int64_t receiveTimeNs () const noexcept
 
std::int64_t position () const noexcept
 
std::uint16_t payloadId () const noexcept
 
std::uint16_t templateId () const noexcept
 
std::uint16_t blockLength () const noexcept
 
std::uint16_t version () const noexcept
 
const char * payload () const noexcept
 
std::uint64_t payloadLength () const noexcept
 
const char * body () const noexcept
 
std::uint64_t bodyLength () const noexcept
 
template<typename Decoder >
Decoder decode () const
 

Friends

template<typename Dispatch >
class detail::Session
 
Payload detail::makePayload (const protocol::SequencedEvent &event)
 

Detailed Description

One application payload delivered in order, with the frame layer off it: the envelope is stripped, and body() strips the payload's own messageHeader too, which is where an SBE decoder wraps.

A payload that carries no header at all (§13.2, what offerFrame exists for) is addressed by payload() instead, and its templateId, blockLength and version mean nothing.

Nothing of seqeron's own vocabulary reaches here — the system family is the façade's business, and a frame of it never arrives as a payload.

Dispatch on (payloadId, templateId), never templateId alone: template ids are unique per schema, so two applications' templates can collide.

A view: valid only during the handler call; copy anything that must outlive it. The Java twin is app/Payload.java; keep the two in step.

Member Function Documentation

◆ blockLength()

std::uint16_t org::limitless::seqeron::app::Payload::blockLength ( ) const
inlinenoexcept

◆ body()

const char * org::limitless::seqeron::app::Payload::body ( ) const
inlinenoexcept

◆ bodyLength()

std::uint64_t org::limitless::seqeron::app::Payload::bodyLength ( ) const
inlinenoexcept

◆ clusterSeqNo()

std::int64_t org::limitless::seqeron::app::Payload::clusterSeqNo ( ) const
inlinenoexcept

◆ clusterTimestampNs()

std::int64_t org::limitless::seqeron::app::Payload::clusterTimestampNs ( ) const
inlinenoexcept

◆ connectionId()

std::int32_t org::limitless::seqeron::app::Payload::connectionId ( ) const
inlinenoexcept

◆ decode()

template<typename Decoder >
Decoder org::limitless::seqeron::app::Payload::decode ( ) const
inline

◆ groupMask()

std::uint16_t org::limitless::seqeron::app::Payload::groupMask ( ) const
inlinenoexcept

◆ groupSeqNo()

std::int64_t org::limitless::seqeron::app::Payload::groupSeqNo ( ) const
inlinenoexcept

◆ payload()

const char * org::limitless::seqeron::app::Payload::payload ( ) const
inlinenoexcept

◆ payloadId()

std::uint16_t org::limitless::seqeron::app::Payload::payloadId ( ) const
inlinenoexcept

◆ payloadLength()

std::uint64_t org::limitless::seqeron::app::Payload::payloadLength ( ) const
inlinenoexcept

◆ position()

std::int64_t org::limitless::seqeron::app::Payload::position ( ) const
inlinenoexcept

◆ receiveTimeNs()

std::int64_t org::limitless::seqeron::app::Payload::receiveTimeNs ( ) const
inlinenoexcept

◆ replyAddress()

ReplyAddress org::limitless::seqeron::app::Payload::replyAddress ( ) const
inlinenoexcept

◆ sourceId()

std::int32_t org::limitless::seqeron::app::Payload::sourceId ( ) const
inlinenoexcept

◆ sourceSessionId()

std::int64_t org::limitless::seqeron::app::Payload::sourceSessionId ( ) const
inlinenoexcept

◆ templateId()

std::uint16_t org::limitless::seqeron::app::Payload::templateId ( ) const
inlinenoexcept

◆ version()

std::uint16_t org::limitless::seqeron::app::Payload::version ( ) const
inlinenoexcept

Friends And Related Symbol Documentation

◆ detail::makePayload

Payload detail::makePayload ( const protocol::SequencedEvent &  event)
friend

◆ detail::Session

template<typename Dispatch >
friend class detail::Session
friend

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