TSP: The Transport Sample Protocol



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

S_BB Struct Reference
[BlackBoard]

BlackBoard definition. More...

#include <bb_core.h>


Data Fields

int semid
 BB access semaphore.

int msgid
 Synchronisation message queue.

char name [BB_NAME_MAX_SIZE+1]
 BlackBoard name.

int32_t max_data_desc_size
 Maximum data descriptor size in bytes.

unsigned long data_desc_offset
 Data descriptor array offset.

int n_data
 The number of data currently stored in the BB.

unsigned long max_data_size
 The maximum data size in BB.

unsigned long data_offset
 BlackBoard data zone offset (bytes).

unsigned long data_free_offset
 Offset (octets) of the next free byte in the blackboard data zone.

int destroyed
 Destroyed state of a BB.


Detailed Description

BlackBoard definition.

A blackboard implements the publish/subsbcribe idiom.

Definition at line 156 of file bb_core.h.


Field Documentation

unsigned long S_BB::data_desc_offset
 

Data descriptor array offset.

Definition at line 178 of file bb_core.h.

unsigned long S_BB::data_free_offset
 

Offset (octets) of the next free byte in the blackboard data zone.

Definition at line 192 of file bb_core.h.

Referenced by bb_shadow_update_data().

unsigned long S_BB::data_offset
 

BlackBoard data zone offset (bytes).

Definition at line 187 of file bb_core.h.

int S_BB::destroyed
 

Destroyed state of a BB.

Should be used by processes to detach/re-attach to a destroyed BB.

Definition at line 198 of file bb_core.h.

int32_t S_BB::max_data_desc_size
 

Maximum data descriptor size in bytes.

Definition at line 176 of file bb_core.h.

unsigned long S_BB::max_data_size
 

The maximum data size in BB.

Definition at line 185 of file bb_core.h.

int S_BB::msgid
 

Synchronisation message queue.

This is a simple inter-process synchronisation mean. For example a simulation process may send end of cycle message to the queue in order to signal another process that he may shadow the BB for further safe use.

Definition at line 172 of file bb_core.h.

int S_BB::n_data
 

The number of data currently stored in the BB.

This is the used size of the data descriptor array.

Definition at line 183 of file bb_core.h.

char S_BB::name[BB_NAME_MAX_SIZE+1]
 

BlackBoard name.

Definition at line 174 of file bb_core.h.

int S_BB::semid
 

BB access semaphore.

This SysV sempahore set contains only 1 semaphore which should be taken before any structural BB modification and/or BB data zone copy.

See also:
bb_shadow_get.

Definition at line 164 of file bb_core.h.

Referenced by bb_shadow_get().


The documentation for this struct was generated from the following file: Framework Home Page.

Beware !! TSP wave is coming...