TSP: The Transport Sample Protocol



S_BB Struct Reference
[The BB Core Library]

BlackBoard description structure. More...

Collaboration diagram for S_BB:
Collaboration graph
[legend]

Data Fields

int32_t bb_version_id
 The BlackBoard version identifier This is used by bb_tools and BB Library API in order to avoid version mismatch between API blackboard access.
unsigned long data_desc_offset
 Data descriptor array offset.
unsigned long data_free_offset
 Offset (in bytes) of the next free byte in the blackboard data zone.
unsigned long data_offset
 BlackBoard data zone offset (bytes) The offset in the shared memory segment where the BlackBoard raw data area array begins.
int32_t max_data_desc_size
 Maximum data descriptor size in bytes.
unsigned long max_data_size
 The maximum data size in BB (bytes).
int n_data
 The number of data currently stored (i.e.
char name [BB_NAME_MAX_SIZE+1]
 BlackBoard name.
union {
priv
 private structure (depends on the shmem implementation)
BB_STATUS_T status
 State of a BB.
enum bb_type type
 The type of the BB, used to select the right set of bb_operations.

Detailed Description

BlackBoard description structure.

This structure describes the BlackBoard itself (not data published in BlackBoard which are described by the S_BB_DATADESC_T structure).


Field Documentation

The BlackBoard version identifier This is used by bb_tools and BB Library API in order to avoid version mismatch between API blackboard access.

unsigned long S_BB::data_desc_offset

Data descriptor array offset.

The offset in the shared memory segment where the BlackBoard data descriptor array begins.

unsigned long S_BB::data_free_offset

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

This offset is relative to data_offset

unsigned long S_BB::data_offset

BlackBoard data zone offset (bytes) The offset in the shared memory segment where the BlackBoard raw data area array begins.

Maximum data descriptor size in bytes.

This the maximum number of publishable data is the BlackBoard (independently of their size).

unsigned long S_BB::max_data_size

The maximum data size in BB (bytes).

The sum of the size (in bytes) of all published data may not exceed this number.

The number of data currently stored (i.e.

published) in the BB. This is the used size of the BlackBoard data descriptor array.

char S_BB::name[BB_NAME_MAX_SIZE+1]

BlackBoard name.

union { ... } S_BB::priv

private structure (depends on the shmem implementation)

State of a BB.

Should be used by processes to detach/re-attach to a destroyed BB and avoid some operation on shadowed BB.

The type of the BB, used to select the right set of bb_operations.

Framework Home Page.

Beware !! TSP wave is coming...