TSP: The Transport Sample Protocol



GLU Default Instance
[GLU Library]

Collaboration diagram for GLU Default Instance:The default GLU API implements default function that are suitable for a 'simple' GLU object. More...

Functions

double GLU_get_base_frequency_default (GLU_handle_t *cthis)
 Default GLU base frequency.
int32_t GLU_get_filtered_ssi_list_default (GLU_handle_t *cthis, int filter_kind, char *filter_string, TSP_answer_sample_t *answer_sample)
 Return the filtered list of sample symbols.
GLU_handle_tGLU_get_instance_default (GLU_handle_t *cthis, int custom_argc, char *custom_argv[], char **error_info)
 Default GLU_get_instance.
int32_t GLU_get_nb_symbols_default (GLU_handle_t *cthis)
 Return the number of (static) available symbols.
int32_t GLU_get_pgi_default (GLU_handle_t *cthis, TSP_sample_symbol_info_list_t *symbol_list, int *pg_indexes)
 Default GLU_get_pgi.
BEGIN_C_DECLS char * GLU_get_server_name_default (GLU_handle_t *cthis)
 Default GLU server name.
GLU_server_type_t GLU_get_server_type_default (GLU_handle_t *cthis)
 Default GLU server type.
int32_t GLU_start_default (GLU_handle_t *cthis)
 Default GLU start.
int32_t GLU_validate_sample_default (TSP_sample_symbol_info_t *looked_for, TSP_sample_symbol_info_t *compared, int *pg_indexes)
 Test if the asked symbol is the same symbol of the complete symbol list.


Detailed Description

The default GLU API implements default function that are suitable for a 'simple' GLU object.


Function Documentation

double GLU_get_base_frequency_default ( GLU_handle_t cthis  ) 

Default GLU base frequency.

Parameters:
[in] cthis the GLU object
Returns:
GLU base frequency (Hz)

int32_t GLU_get_filtered_ssi_list_default ( GLU_handle_t cthis,
int  filter_kind,
char *  filter_string,
TSP_answer_sample_t answer_sample 
)

Return the filtered list of sample symbols.

Parameters:
[in] cthis the GLU object
[in] filter_kind the filter kind
[in] filter_string the filter string
[out] answer_sample the Answer Sample containing the list of symbols matching specified filter.
Returns:
the number of (static) available symbols.

GLU_handle_t* GLU_get_instance_default ( GLU_handle_t cthis,
int  custom_argc,
char *  custom_argv[],
char **  error_info 
)

Default GLU_get_instance.

The default implementation is only valid for an ACTIVE GLU. In this case this function always return this. PASSIVE GLU should reimplement this function.

Parameters:
[in,out] cthis the GLU object
[in] custom_argc 
[in] custom_argv 
[in,out] error_info 
Returns:
the GLU handle

int32_t GLU_get_nb_symbols_default ( GLU_handle_t cthis  ) 

Return the number of (static) available symbols.

Parameters:
[in] cthis the GLU object
Returns:
the number of (static) available symbols.

int32_t GLU_get_pgi_default ( GLU_handle_t cthis,
TSP_sample_symbol_info_list_t symbol_list,
int *  pg_indexes 
)

Default GLU_get_pgi.

The default implementation use the mandatory GLU_get_sample_symbol_info_list and does a linear search in it.

Parameters:
[in] cthis the GLU object
[in] symbol_list the symbol list to validate
[out] pg_indexes array containing corresponding provider global indexes or -1 if not found
Returns:
TRUE if all symbol found, else return FALSE

BEGIN_C_DECLS char* GLU_get_server_name_default ( GLU_handle_t cthis  ) 

Default GLU server name.

Parameters:
cthis the GLU object
Returns:
GLU name.

GLU_server_type_t GLU_get_server_type_default ( GLU_handle_t cthis  ) 

Default GLU server type.

Parameters:
[in] cthis the GLU object
Returns:
GLU server type.

int32_t GLU_start_default ( GLU_handle_t cthis  ) 

Default GLU start.

Parameters:
[in] cthis the GLU object
Returns:
true or false

int32_t GLU_validate_sample_default ( TSP_sample_symbol_info_t looked_for,
TSP_sample_symbol_info_t compared,
int *  pg_indexes 
)

Test if the asked symbol is the same symbol of the complete symbol list.

Parameters:
[in] looked_for asked symbol
[in] compared symbol of the complete list
[out] pg_indexes provider global index (-1 if symbol is NOK) matching specified filter.
Returns:
true if symbol is correct.

Framework Home Page.


Beware !! TSP wave is coming...