pdcomm::GemResultKind

Enum

Classification of a GemResult returned by GemEndpoint::handleEvent().

enum class GemResultKind : uint32_t

Declared in: #include <pdcomm_gem.hpp>

Members

Failed

Enumerator

A pending request ended without a reply. GemResultInfo::code holds a TCP failure reason such as PDCOMM_TCP_T3_TIMEOUT, PDCOMM_TCP_CANCELLED or PDCOMM_TCP_DISCONNECTED.

Failed = PDCOMM_GEM_FAILED

Declared in: #include <pdcomm_gem.hpp>

Ignored

Enumerator

The TCP event is not a GEM message (for example an HSMS state change). Nothing to do.

Ignored = PDCOMM_GEM_IGNORED

Declared in: #include <pdcomm_gem.hpp>

InvalidResponse

Enumerator

A reply arrived but failed validation, or was an abort (function 0). The matching pending request is cleared and GemResultInfo::code holds a PDCOMM_GEM_ERROR_* value.

InvalidResponse = PDCOMM_GEM_INVALID_RESPONSE

Declared in: #include <pdcomm_gem.hpp>

Primary

Enumerator

An incoming primary message was validated. Check GemResultInfo::replySent: the library already replied to many requests, while others wait for an explicit respond call.

Primary = PDCOMM_GEM_PRIMARY

Declared in: #include <pdcomm_gem.hpp>

Response

Enumerator

A valid reply to one of this endpoint's requests arrived; GemResultInfo::token matches the token returned when the request was submitted.

Response = PDCOMM_GEM_RESPONSE

Declared in: #include <pdcomm_gem.hpp>

Unhandled

Enumerator

The library did not handle an incoming primary and sent no reply. GemResultInfo::code holds a PDCOMM_GEM_ERROR_* value. Reply explicitly with TcpEndpoint::reply() on the original event (for example an F0 abort), or close the endpoint.

Unhandled = PDCOMM_GEM_UNHANDLED

Declared in: #include <pdcomm_gem.hpp>