TSP: The Transport Sample Protocol



BB TSP Provider Library
[BB TSP ProviderTSP Libraries]

Collaboration diagram for BB TSP Provider Library:The BlackBoard TSP provider library API. More...

Functions

int32_t bb_tsp_provider_allow_write_symbol (int provider_global_index)
 Authorize asynchronous write for BB symbols specified by its PGI.
GLU_handle_tbb_tsp_provider_create_GLU (double frequency, int32_t acknowledgeCopy, int GLUServerType)
 attribute the function of the GLU
int32_t bb_tsp_provider_finalize ()
 Terminate the bb_tsp_provider nicely.
int32_t bb_tsp_provider_forbid_write_symbol (int provider_global_index)
 Forbid asynchronous write for BB symbols specified by its PGI.
int32_t bb_tsp_provider_initialise (int *argc, char **argv[], int TSPRunMode, const char *bbname, double frequency, int32_t acknowledgeCopy)
 Initialize Blackboard TSP provider Library.
void bb_tsp_provider_setbbname (const char *bbname)
 set the bb name


Detailed Description

The BlackBoard TSP provider library API.

The library is used to build the BB TSP Provider application. It can be used to build its own customized BlackBoard provider.


Function Documentation

int32_t bb_tsp_provider_allow_write_symbol ( int  provider_global_index  ) 

Authorize asynchronous write for BB symbols specified by its PGI.

After a call to this asynchronous write request to this PGI will be honored gracefully (if valid though) by BB provider.

Parameters:
provider_global_index IN, the PGI of the symbol we want to authorize asynchronous write.
Returns:
TRUE if authorization succeed FALSE otherwise.

GLU_handle_t* bb_tsp_provider_create_GLU ( double  frequency,
int32_t  acknowledgeCopy,
int  GLUServerType 
)

attribute the function of the GLU

Parameters:
[in] frequency the frequency advertised by the bb_tsp_provider
[in] acknowledgeCopy 0 if no acknowledgment is to be sent by the provider to the simulation driving sample, otherwise acknowledgment is sent.
[in] GLUServerType type of serveur: ACTIVE or PASSIVE
Returns:
the pointer's GLU

int32_t bb_tsp_provider_finalize (  ) 

Terminate the bb_tsp_provider nicely.

The function end up in a call to TSP_provider_finalize().

int32_t bb_tsp_provider_forbid_write_symbol ( int  provider_global_index  ) 

Forbid asynchronous write for BB symbols specified by its PGI.

After a call to this asynchronous write request to this PGI will be refused by BB provider.

Parameters:
[in] provider_global_index IN, the PGI of the symbol we want to forbid the asynchronous write.
Returns:
TRUE if authorization succeed FALSE otherwise.

int32_t bb_tsp_provider_initialise ( int *  argc,
char **  argv[],
int  TSPRunMode,
const char *  bbname,
double  frequency,
int32_t  acknowledgeCopy 
)

Initialize Blackboard TSP provider Library.

Parameters:
[in] argc argc coming from main (before the main use it)
[in] argv argv coming from main (before the main use it)
[in] TSPRunMode running mode, 0 = non blocking, 1 = blocking (never return).
[in] bbname the blackboard name we should attach to.
[in] frequency the frequency advertised by the bb_tsp_provider
[in] acknowledgeCopy 0 if no acknowledgment is to be sent by the provider to the simulation driving sample, otherwise acknowledgment is sent.
Returns:
E_OK if initialization is successfull E_NOK otherwise.

void bb_tsp_provider_setbbname ( const char *  bbname  ) 

set the bb name

Parameters:
[in] bbname name of the blackboard
Returns:
void

Framework Home Page.


Beware !! TSP wave is coming...