catapult::disruptor::ConsumerResult Struct Reference

Result of a consumer operation. More...

Inheritance diagram for catapult::disruptor::ConsumerResult:

Public Member Functions
constexpr	ConsumerResult ()
	Creates a default result. More...

Static Public Member Functions
static constexpr ConsumerResult	Abort ()
	Creates a consumer result indicating that processing should be aborted. More...
static constexpr ConsumerResult	Abort (disruptor::CompletionCode code)
	Creates a consumer result indicating that processing should be aborted with the specified code. More...
static constexpr ConsumerResult	Continue ()
	Creates a consumer result indicating that processing should continue. More...
static constexpr ConsumerResult	Complete (disruptor::CompletionCode code)
	Creates a consumer result indicating that processing has completed with the specified code. More...

Public Attributes
disruptor::CompletionStatus	CompletionStatus
	Completion status. More...
disruptor::CompletionCode	CompletionCode
	Optional code that can provide additional consumer completion information. More...

Private Member Functions
constexpr	ConsumerResult (disruptor::CompletionStatus status, disruptor::CompletionCode code)

Detailed Description

Result of a consumer operation.

Constructor & Destructor Documentation

ConsumerResult() [1/2]

constexpr catapult::disruptor::ConsumerResult::ConsumerResult ( )

inlineconstexpr

Creates a default result.

Here is the caller graph for this function:

ConsumerResult() [2/2]

constexpr catapult::disruptor::ConsumerResult::ConsumerResult ( disruptor::CompletionStatus  status, disruptor::CompletionCode  code  )

inlineconstexprprivate

Member Function Documentation

Abort() [1/2]

static constexpr ConsumerResult catapult::disruptor::ConsumerResult::Abort ( )

inlinestaticconstexpr

Creates a consumer result indicating that processing should be aborted.

Here is the caller graph for this function:

Abort() [2/2]

static constexpr ConsumerResult catapult::disruptor::ConsumerResult::Abort ( disruptor::CompletionCode  code )

inlinestaticconstexpr

Creates a consumer result indicating that processing should be aborted with the specified code.

Here is the call graph for this function:

Complete()

static constexpr ConsumerResult catapult::disruptor::ConsumerResult::Complete ( disruptor::CompletionCode  code )

inlinestaticconstexpr

Creates a consumer result indicating that processing has completed with the specified code.

Here is the call graph for this function:

Here is the caller graph for this function:

Continue()

static constexpr ConsumerResult catapult::disruptor::ConsumerResult::Continue ( )

inlinestaticconstexpr

Creates a consumer result indicating that processing should continue.

Here is the caller graph for this function:

Member Data Documentation

CompletionCode

disruptor::CompletionCode catapult::disruptor::ConsumerResult::CompletionCode

Optional code that can provide additional consumer completion information.

CompletionStatus

disruptor::CompletionStatus catapult::disruptor::ConsumerResult::CompletionStatus

Completion status.

---

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

• DisruptorTypes.h