TSP: The Transport Sample Protocol



TSP_sample_symbol_info_t Struct Reference
[The TSP Abstract API]

TSP Sample Information. More...


Data Fields

unsigned int dimension
 The dimension of the symbol (array size).
string name
 TSP Symbol name.
unsigned int nelem
 The number of requested element beginning at offset.
unsigned int offset
 The offset of the first requested element if the symbol is an array.
int period
 The period at which the symbol will be provided.
int phase
 The phase at which the symbol will be provided.
int provider_global_index
 The provider global index (PGI).
int provider_group_index
 The TSP Group Index to which the symbol belongs to.
int provider_group_rank
 The rank of the symbol in its TSP Group.
TSP_datatype_t type
 The type of the TSP symbol.


Detailed Description

TSP Sample Information.

A TSP Symbol is entirely defined by this structure.


Field Documentation

unsigned int TSP_sample_symbol_info_t::dimension

The dimension of the symbol (array size).

string TSP_sample_symbol_info_t::name

TSP Symbol name.

unsigned int TSP_sample_symbol_info_t::nelem

The number of requested element beginning at offset.

0 means all element requested beginning at offset. Only used if dimension > 1.

unsigned int TSP_sample_symbol_info_t::offset

The offset of the first requested element if the symbol is an array.

Only used if dimension > 1.

int TSP_sample_symbol_info_t::period

The period at which the symbol will be provided.

int TSP_sample_symbol_info_t::phase

The phase at which the symbol will be provided.

int TSP_sample_symbol_info_t::provider_global_index

The provider global index (PGI).

This a provider-side index which uniquely identify a symbol. Each symbol provided by a TSP provider should have a unique PGI assigned by the provider.

int TSP_sample_symbol_info_t::provider_group_index

The TSP Group Index to which the symbol belongs to.

TSP Groups are computed by the provider upon a TSP request sample.

int TSP_sample_symbol_info_t::provider_group_rank

The rank of the symbol in its TSP Group.

TSP_datatype_t TSP_sample_symbol_info_t::type

The type of the TSP symbol.

Framework Home Page.


Beware !! TSP wave is coming...