Overview

TokenizedDecoder can decode pw_trace_tokenized-encoded trace events.

Public Member Functions
	TokenizedDecoder (tokenizer::Detokenizer &detokenizer, uint64_t ticks_per_sec)

void	SetTimeOffset (uint64_t time_offset)

Result< DecodedEvent >	ReadSizePrefixed (stream::Reader &reader)

Result< DecodedEvent >	Decode (ConstByteSpan data)

Constructor & Destructor Documentation

pw::trace::TokenizedDecoder::TokenizedDecoder	(	tokenizer::Detokenizer &	detokenizer,
		uint64_t	ticks_per_sec
	)

inline

Creates a new event decoder.

Parameters

[in]	detokenizer	The Detokenizer responsible for converting embedded tokens back to strings. This must reference a token database with valid tokens for the originating firmware.
[in]	ticks_per_sec	The rate at which the pw_trace clock ticks for the target device/firmware. This is typically retrieved using the `TraceService::GetClockParameters()` RPC method.

Result< DecodedEvent > pw::trace::TokenizedDecoder::Decode ( ConstByteSpan data )

Decodes a DecodedEvent from a span of data.

Parameters

[in] data The byte span which a DecodedEvent is decoded.

Note: All of the data is assumed to be part of a single DecodedEvent. Don't use this method if the data may include multiple encoded DecodedEvents.

Returns

A Result containing a decoded event on success or one of the following error codes on failure:

Result< DecodedEvent > pw::trace::TokenizedDecoder::ReadSizePrefixed ( stream::Reader & reader )

Reads from reader a size-prefixed DecodedEvent as returned by pw_trace_tokenized:transfer_handler.

Parameters

[in] reader The stream from which size-prefixed Events are read and decoded.

Returns

A Result containing a decoded event on success or one of the following error codes on failure:

void pw::trace::TokenizedDecoder::SetTimeOffset ( uint64_t time_offset )

inline

Sets the current time offset; the base for future decoded event timestamps.

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