TSP: The Transport Sample Protocol



Answer Sample Library Handling
[TSP Common Library]

Collaboration diagram for Answer Sample Library Handling:The Answer Sample Handling part of the TSP Common Library regroup a set of functions which should be used to manipulate the Answer Sample object. More...

Functions

_EXPORT_TSP_COMMON int32_t TSP_AS_delete (TSP_answer_sample_t **as)
 Delete an Answer Sample.
_EXPORT_TSP_COMMON int32_t TSP_AS_finalize (TSP_answer_sample_t *as)
 Destroy the content of an Answer Sample.
_EXPORT_TSP_COMMON int32_t TSP_AS_initialize (TSP_answer_sample_t *as, int32_t version_id, uint32_t channel_id, int32_t p_timeout, int32_t pgn, double base_frequency, int32_t max_period, int32_t max_consumer_number, int32_t current_consumer_number, TSP_status_t status)
 Initialize an Answer Sample.
BEGIN_C_DECLS _EXPORT_TSP_COMMON
TSP_answer_sample_t
TSP_AS_new (int32_t version_id, uint32_t channel_id, int32_t p_timeout, int32_t pgn, double base_frequency, int32_t max_period, int32_t max_consumer_number, int32_t current_consumer_number, TSP_status_t status)
 Create an Answer Sample.


Detailed Description

The Answer Sample Handling part of the TSP Common Library regroup a set of functions which should be used to manipulate the Answer Sample object.


Function Documentation

_EXPORT_TSP_COMMON int32_t TSP_AS_delete ( TSP_answer_sample_t **  as  ) 

Delete an Answer Sample.

Parameters:
[in] as pointer to pointer to the Answer Sample to be destroy
Returns:
TSP_STATUS_OK if ok

_EXPORT_TSP_COMMON int32_t TSP_AS_finalize ( TSP_answer_sample_t as  ) 

Destroy the content of an Answer Sample.

Parameters:
[in,out] as the Answer Sample whose content should be destroyed.
Returns:
TSP_STATUS_OK if ok

_EXPORT_TSP_COMMON int32_t TSP_AS_initialize ( TSP_answer_sample_t as,
int32_t  version_id,
uint32_t  channel_id,
int32_t  p_timeout,
int32_t  pgn,
double  base_frequency,
int32_t  max_period,
int32_t  max_consumer_number,
int32_t  current_consumer_number,
TSP_status_t  status 
)

Initialize an Answer Sample.

Parameters:
[in,out] as the Answer Sample to initialize
[in] version_id the TSP protocol version identifier
[in] channel_id the TSP Channel ID
[in] p_timeout the provider timeout
[in] pgn the provider group number, number of group(s) included in Answer.
[in] base_frequency the base frequency of the provider.
[in] max_period the maximum period the provider is able to handle
[in] max_consumer_number the maximum number of consumer the provider is able to handle.
[in] current_consumer_number the current number of connected consumer.
[in] status the TSP STATUS of the answer.
Returns:
TSP_STATUS_OK if ok

BEGIN_C_DECLS _EXPORT_TSP_COMMON TSP_answer_sample_t* TSP_AS_new ( int32_t  version_id,
uint32_t  channel_id,
int32_t  p_timeout,
int32_t  pgn,
double  base_frequency,
int32_t  max_period,
int32_t  max_consumer_number,
int32_t  current_consumer_number,
TSP_status_t  status 
)

Create an Answer Sample.

Parameters:
[in] version_id the TSP protocol version identifier
[in] channel_id 
[in] p_timeout 
[in] pgn 
[in] base_frequency 
[in] max_period 
[in] max_consumer_number 
[in] current_consumer_number 
[in] status 
Returns:
the new TSP_answer_sample_t

Framework Home Page.


Beware !! TSP wave is coming...