TSP: The Transport Sample Protocol



Sample Symbol Extended Information Library Handling
[TSP Common Library]

Collaboration diagram for Sample Symbol Extended Information Library Handling:The Sample Symbol Extended Information Library part of the TSP Common Library regroup a set of functions which should be used to manipulate the Sample Symbol Extended Information object and list of them. More...

Functions

_EXPORT_TSP_COMMON int32_t TSP_EI_copy (TSP_extended_info_t *dest_EI, const TSP_extended_info_t src_EI)
 copy a TSP Extended Info .
_EXPORT_TSP_COMMON int32_t TSP_EI_delete (TSP_extended_info_t **ei)
 destruct an ei
_EXPORT_TSP_COMMON int32_t TSP_EI_finalize (TSP_extended_info_t *ei)
 Finalize an extended information item.
_EXPORT_TSP_COMMON int32_t TSP_EI_initialize (TSP_extended_info_t *ei, const char *key, const char *value)
 Initialize an extended information item.
BEGIN_C_DECLS _EXPORT_TSP_COMMON
TSP_extended_info_t
TSP_EI_new (const char *key, const char *value)
 create a new ei
_EXPORT_TSP_COMMON int32_t TSP_EI_update (TSP_extended_info_t *ei, const char *key, const char *value)
 Udpate an extended information item.
_EXPORT_TSP_COMMON int32_t TSP_EIList_copy (TSP_extended_info_list_t *eil_dest, const TSP_extended_info_list_t eil_src)
 copy a TSP Extended Info list.
_EXPORT_TSP_COMMON int32_t TSP_EIList_delete (TSP_extended_info_list_t **eil)
 destruct an eil
_EXPORT_TSP_COMMON int32_t TSP_EIList_finalize (TSP_extended_info_list_t *eil)
 Finalize an extended information list.
_EXPORT_TSP_COMMON const TSP_extended_info_tTSP_EIList_findEIByKey (const TSP_extended_info_list_t *eil, const char *key)
 Find a extended information in a list by key.
_EXPORT_TSP_COMMON int32_t TSP_EIList_initialize (TSP_extended_info_list_t *eil, const int32_t len)
 Initialize an extended information list.
_EXPORT_TSP_COMMON TSP_extended_info_list_tTSP_EIList_new (int32_t len)
 create a new eil
_EXPORT_TSP_COMMON int32_t TSP_SSEI_copy (TSP_sample_symbol_extended_info_t *ssei_dest, const TSP_sample_symbol_extended_info_t ssei_src)
 copy a TSP Sample Symbol Extended Info structure.
_EXPORT_TSP_COMMON int32_t TSP_SSEI_delete (TSP_sample_symbol_extended_info_t **ssei)
 destruct an ssei
_EXPORT_TSP_COMMON int32_t TSP_SSEI_finalize (TSP_sample_symbol_extended_info_t *ssei)
 destruction of a TSP Sample Symbol Extended Info structure.
_EXPORT_TSP_COMMON int32_t TSP_SSEI_initialize (TSP_sample_symbol_extended_info_t *ssei, const int32_t pgi, const int32_t nei)
 Initialize a TSP Sample Symbol Extended Info structure.
_EXPORT_TSP_COMMON TSP_sample_symbol_extended_info_tTSP_SSEI_new (const int32_t pgi, const int32_t nei)
 create a new ssei
_EXPORT_TSP_COMMON int32_t TSP_SSEIList_copy (TSP_sample_symbol_extended_info_list_t *dest_ssei_list, const TSP_sample_symbol_extended_info_list_t src_ssei_list)
 copy a TSP Sample Symbol Extended Info list structure.
_EXPORT_TSP_COMMON int32_t TSP_SSEIList_delete (TSP_sample_symbol_extended_info_list_t **ssei_list)
 destruct an sseil
_EXPORT_TSP_COMMON int32_t TSP_SSEIList_finalize (TSP_sample_symbol_extended_info_list_t *ssei_list)
 Destruction of a TSP Sample Symbol Extended Info list structure.
_EXPORT_TSP_COMMON int32_t TSP_SSEIList_initialize (TSP_sample_symbol_extended_info_list_t *ssei_list, int32_t len)
 initialize a TSP Sample Symbol Extended Info list structure.
_EXPORT_TSP_COMMON TSP_sample_symbol_extended_info_list_tTSP_SSEIList_new (int32_t len)
 create a new sseil


Detailed Description

The Sample Symbol Extended Information Library part of the TSP Common Library regroup a set of functions which should be used to manipulate the Sample Symbol Extended Information object and list of them.


Function Documentation

_EXPORT_TSP_COMMON int32_t TSP_EI_copy ( TSP_extended_info_t dest_EI,
const TSP_extended_info_t  src_EI 
)

copy a TSP Extended Info .

Parameters:
[in,out] dest_EI destination
[in] src_EI source
Returns:
TSP_STATUS_OK on success

_EXPORT_TSP_COMMON int32_t TSP_EI_delete ( TSP_extended_info_t **  ei  ) 

destruct an ei

Parameters:
[in] ei ei to destruct
Returns:
TSP_STATUS_OK if ok

_EXPORT_TSP_COMMON int32_t TSP_EI_finalize ( TSP_extended_info_t ei  ) 

Finalize an extended information item.

Parameters:
[in,out] ei the extended info structure, the structure should be allocated but the field may not
Returns:
TSP_STATUS_OK on success

_EXPORT_TSP_COMMON int32_t TSP_EI_initialize ( TSP_extended_info_t ei,
const char *  key,
const char *  value 
)

Initialize an extended information item.

Parameters:
[in,out] ei the extended info structure, the structure should be allocated but the field may not
[in] key the key/name of the extended information
[in] value the value of the extended information
Returns:
TSP_STATUS_OK on success

BEGIN_C_DECLS _EXPORT_TSP_COMMON TSP_extended_info_t* TSP_EI_new ( const char *  key,
const char *  value 
)

create a new ei

Parameters:
[in] key key of the ei
[in] value value of the extended info
Returns:
the new ei

_EXPORT_TSP_COMMON int32_t TSP_EI_update ( TSP_extended_info_t ei,
const char *  key,
const char *  value 
)

Udpate an extended information item.

Parameters:
[in,out] ei the extended info structure, the structure should be allocated including the field
[in] key the key/name of the extended information
[in] value the value of the extended information
Returns:
TSP_STATUS_OK on success

_EXPORT_TSP_COMMON int32_t TSP_EIList_copy ( TSP_extended_info_list_t eil_dest,
const TSP_extended_info_list_t  eil_src 
)

copy a TSP Extended Info list.

Parameters:
[in,out] eil_dest destination list
[in] eil_src source list
Returns:
TSP_STATUS_OK on success

_EXPORT_TSP_COMMON int32_t TSP_EIList_delete ( TSP_extended_info_list_t **  eil  ) 

destruct an eil

Parameters:
[in] eil eil to destruct
Returns:
TSP_STATUS_OK if ok

_EXPORT_TSP_COMMON int32_t TSP_EIList_finalize ( TSP_extended_info_list_t eil  ) 

Finalize an extended information list.

Parameters:
[in,out] eil the extended info list structure
Returns:
TSP_STATUS_OK on success

_EXPORT_TSP_COMMON const TSP_extended_info_t* TSP_EIList_findEIByKey ( const TSP_extended_info_list_t eil,
const char *  key 
)

Find a extended information in a list by key.

Parameters:
[in] eil the extended information list to look in
[in] key the key of the extended information to look for
Returns:
a TSP_extended_info_t if found else NULL

_EXPORT_TSP_COMMON int32_t TSP_EIList_initialize ( TSP_extended_info_list_t eil,
const int32_t  len 
)

Initialize an extended information list.

Parameters:
[in,out] eil the extended info list structure, the structure should be allocated but the field may not On input the pre-allocated structure On output the content of the structure has been allocated and initialized.
[in] len the length of the extended info list
Returns:
TSP_STATUS_OK on success

_EXPORT_TSP_COMMON TSP_extended_info_list_t* TSP_EIList_new ( int32_t  len  ) 

create a new eil

Parameters:
[in] len length of the eil
Returns:
the new eil

_EXPORT_TSP_COMMON int32_t TSP_SSEI_copy ( TSP_sample_symbol_extended_info_t ssei_dest,
const TSP_sample_symbol_extended_info_t  ssei_src 
)

copy a TSP Sample Symbol Extended Info structure.

Parameters:
[in,out] ssei_dest destination
[in] ssei_src source
Returns:
TSP_STATUS_OK on success

_EXPORT_TSP_COMMON int32_t TSP_SSEI_delete ( TSP_sample_symbol_extended_info_t **  ssei  ) 

destruct an ssei

Parameters:
[in] ssei ssei to destruct
Returns:
TSP_STATUS_OK if ok

_EXPORT_TSP_COMMON int32_t TSP_SSEI_finalize ( TSP_sample_symbol_extended_info_t ssei  ) 

destruction of a TSP Sample Symbol Extended Info structure.

Parameters:
[in,out] ssei struct to destroy
Returns:
TSP_STATUS_OK on success

_EXPORT_TSP_COMMON int32_t TSP_SSEI_initialize ( TSP_sample_symbol_extended_info_t ssei,
const int32_t  pgi,
const int32_t  nei 
)

Initialize a TSP Sample Symbol Extended Info structure.

Parameters:
[in,out] ssei the SSEI structure
[in] pgi the provider global index
[in] nei the number of extended informations to be attached to this PGI
Returns:
TSP_STATUS_OK on success

_EXPORT_TSP_COMMON TSP_sample_symbol_extended_info_t* TSP_SSEI_new ( const int32_t  pgi,
const int32_t  nei 
)

create a new ssei

Parameters:
[in] pgi pgi of the ei
[in] nei number of extended info
Returns:
the new ssei

_EXPORT_TSP_COMMON int32_t TSP_SSEIList_copy ( TSP_sample_symbol_extended_info_list_t dest_ssei_list,
const TSP_sample_symbol_extended_info_list_t  src_ssei_list 
)

copy a TSP Sample Symbol Extended Info list structure.

Parameters:
[in,out] dest_ssei_list destination list
[in] src_ssei_list source list
Returns:
TSP_STATUS_OK on success

_EXPORT_TSP_COMMON int32_t TSP_SSEIList_delete ( TSP_sample_symbol_extended_info_list_t **  ssei_list  ) 

destruct an sseil

Parameters:
[in] ssei_list sseil to destruct
Returns:
TSP_STATUS_OK if ok

_EXPORT_TSP_COMMON int32_t TSP_SSEIList_finalize ( TSP_sample_symbol_extended_info_list_t ssei_list  ) 

Destruction of a TSP Sample Symbol Extended Info list structure.

Parameters:
[in,out] ssei_list list to destroy
Returns:
TSP_STATUS_OK on success

_EXPORT_TSP_COMMON int32_t TSP_SSEIList_initialize ( TSP_sample_symbol_extended_info_list_t ssei_list,
int32_t  len 
)

initialize a TSP Sample Symbol Extended Info list structure.

Parameters:
[in,out] ssei_list list to initialize
[in] len length of the list
Returns:
TSP_STATUS_OK on success

_EXPORT_TSP_COMMON TSP_sample_symbol_extended_info_list_t* TSP_SSEIList_new ( int32_t  len  ) 

create a new sseil

Parameters:
[in] len length of the sseil
Returns:
the new sseil

Framework Home Page.


Beware !! TSP wave is coming...