TSP: The Transport Sample Protocol



TSP_sample Struct Reference
[Consumer Core Library]

Structure used to get a TSP sample symbol. More...


Data Fields

int32_t array_index
 If the TSP symbol is of array type this is the index corresponding to the value given in uvalue.
int provider_global_index
 The provider global index is the provider-side unique identifier for a TSP symbol.
int time
 The TSP time stamp.
TSP_datatype_t type
 The TSP type for this symbol.
union {
uvalue
 Union containing the value of the item.


Detailed Description

Structure used to get a TSP sample symbol.

A variable sample of this type is filled by a call to TSP_consumer_read_sample.


Field Documentation

int32_t TSP_sample::array_index

If the TSP symbol is of array type this is the index corresponding to the value given in uvalue.

For any scalar symbol it should be 0.

int TSP_sample::provider_global_index

The provider global index is the provider-side unique identifier for a TSP symbol.

It may be used to retrieve the sample symbols informations sent to the consumer in the Answer Sample.

int TSP_sample::time

The TSP time stamp.

This field is mostly for TSP internal use it is not relared to any "real time", that not simulated time nor wallclock time. It is a TSP time sequence. It should be increasing (with 32bits rollover). When TSP time change the provider is changing cycle.

TSP_datatype_t TSP_sample::type

The TSP type for this symbol.

union { ... } TSP_sample::uvalue

Union containing the value of the item.

Framework Home Page.


Beware !! TSP wave is coming...