TSP: The Transport Sample Protocol



Main Page | Modules | Alphabetical List | Data Structures | File List | Data Fields | Globals | Related Pages

BBUtils
[BlackBoard]


Typedefs

typedef enum BB_LOG_LEVEL BB_LOG_LEVEL_T
 BlackBoard Log message level.


Enumerations

enum  BB_LOG_LEVEL
 BlackBoard Log message level. More...


Functions

char * bb_utils_build_shm_name (const char *shm_name)
 Build the string name used for creating a shm segment from a user supplied name.

char * bb_utils_build_sem_name (const char *sem_name)
 Construit le nom à utiliser pour la création d'un sémaphore à partir d'un nom 'utilisateur'.

char * bb_utils_build_msg_name (const char *sem_name)
 Construit le nom à utiliser pour la création d'une queue de message à partir d'un nom 'utilisateur'.

key_t bb_utils_ntok (const char *name)
 Build a SysV IPC key from a name.

int32_t bb_logMsg (const BB_LOG_LEVEL_T level, const char *modname, char *fmt,...)
 Log message for BB Error.


Detailed Description

General utility functions for TSP BlackBoard.

Typedef Documentation

typedef enum BB_LOG_LEVEL BB_LOG_LEVEL_T
 

BlackBoard Log message level.

Referenced by bb_logMsg().


Enumeration Type Documentation

enum BB_LOG_LEVEL
 

BlackBoard Log message level.

Definition at line 53 of file bb_utils.h.


Function Documentation

int32_t bb_logMsg const BB_LOG_LEVEL_T  level,
const char *  modname,
char *  fmt,
... 
 

Log message for BB Error.

This function may be replaced by a project specific function which want to use BB with a unified log system. The default implementation use TSP STRACE facility.

Parameters:
level IN, the log level.
modname IN, the module who sent the message.
fmt IN, format as in printf.
Returns:
0 on success, -1 on error.

Definition at line 151 of file bb_utils.c.

References BB_LOG_LEVEL_T.

Referenced by bb_attach(), bb_destroy(), bb_detach(), bb_lock(), bb_publish(), bb_rcv_msg(), bb_simple_publish(), bb_simple_synchro_config(), bb_simple_thread_synchro_go(), bb_simple_thread_synchro_wait(), bb_snd_msg(), bb_unlock(), and GLU_init().

char* bb_utils_build_msg_name const char *  sem_name  ) 
 

Construit le nom à utiliser pour la création d'une queue de message à partir d'un nom 'utilisateur'.

Parameters:
sem_name IN, user supplied name.
Returns:
le nom à utiliser pour créer la queue de message La chaine de retour est allouée par la fonction et DOIT donc être désallouée par l'appelant.

Definition at line 91 of file bb_utils.c.

char* bb_utils_build_sem_name const char *  sem_name  ) 
 

Construit le nom à utiliser pour la création d'un sémaphore à partir d'un nom 'utilisateur'.

Parameters:
sem_name IN, user supplied name.
Returns:
le nom à utiliser pour créer le sémaphore La chaine de retour est allouée par la fonction et DOIT donc être désallouée par l'appelant.

Definition at line 70 of file bb_utils.c.

char* bb_utils_build_shm_name const char *  shm_name  ) 
 

Build the string name used for creating a shm segment from a user supplied name.

We use this for easy SHM name 'normalization' for easy shm portability. One may use the name with either POSIX shm_open(3) or sys V shmget(2) through

See also:
bb_utils_notok.
Parameters:
shm_name IN, user supplied name.
Returns:
the name to be used by shm creator. The string is allocated (as strdup(3) do) so that caller should free it.

Definition at line 51 of file bb_utils.c.

Referenced by bb_attach(), and bb_destroy().

key_t bb_utils_ntok const char *  name  ) 
 

Build a SysV IPC key from a name.

L'objectif de cette fonction est de générer des clefs différentes pour des noms différents, à la manière d'une fonction de hachage ou checksum parfaite. Cette fonction vise les même objectifs que ftok(3) avec les noms de fichiers mais avec une chaine de caractere quelconque.

Parameters:
name un nom représentant l'élément IPC pour lequel on veut générer une clef.
Returns:
SysV IPC key corresponding to the specified name.

Definition at line 144 of file bb_utils.c.

Referenced by bb_attach(), and bb_destroy().

Framework Home Page.


Beware !! TSP wave is coming...