Skip to content
Start free evaluation

pdcomm_gem_spool_entry_time_at

Function

Reads the capture timestamp of one spooled message.

PdcommStatus pdcomm_gem_spool_entry_time_at(PdcommTcpEndpoint *endpoint, size_t index, uint64_t *captured_at, uint8_t *present)

Declared in: #include <pdcomm_gem_spooling.h>

Complements pdcomm_gem_spool_entry_at() without changing ::PdcommGemSpoolEntryInfo. Entries loaded from a legacy snapshot have no capture time and return #PDCOMM_OK with *present 0 and *captured_at 0.

Parameters

NameDescription
endpointEndpoint with an Equipment spool.
indexZero-based queue index.
captured_atReceives the now value passed when the message was captured; set to 0 first. Must not be NULL.
presentReceives 1 when a capture time is stored; set to 0 first. Must not be NULL.

Returns

#PDCOMM_OK on success; #PDCOMM_INVALID_ARGUMENT when an output or endpoint is NULL; #PDCOMM_INVALID_STATE when no Equipment spool is configured; #PDCOMM_OUT_OF_RANGE when index is past the end (both outputs stay 0); #PDCOMM_POISONED after a contained panic.