fawkes::interface_header_t Struct Reference

This struct is used as header for interfaces in memory chunks. More...

#include <interface_mem_header.h>

List of all members.

Public Attributes

char type [__INTERFACE_TYPE_SIZE]
 interface type
char id [__INTERFACE_ID_SIZE]
 interface identifier
unsigned char hash [__INTERFACE_HASH_SIZE]
 interface type version hash
uint16_t flag_writer_active: 1
 1 if there is a writer, 0 otherwise
uint16_t flag_reserved: 15
 reserved for future use
uint16_t num_readers
 number of active readers
uint32_t refcount
 reference count
uint32_t serial
 memory serial


Detailed Description

This struct is used as header for interfaces in memory chunks.

This header is stored at the beginning of each allocated memory chunk.

Definition at line 36 of file interface_mem_header.h.


Member Data Documentation

uint16_t fawkes::interface_header_t::flag_reserved

reserved for future use

Definition at line 41 of file interface_mem_header.h.

uint16_t fawkes::interface_header_t::flag_writer_active

1 if there is a writer, 0 otherwise

Definition at line 40 of file interface_mem_header.h.

Referenced by fawkes::BlackBoardInterfaceProxy::BlackBoardInterfaceProxy(), fawkes::BlackBoardInterfaceManager::close(), fawkes::BlackBoardInterfaceManager::list_all(), and fawkes::BlackBoardInterfaceManager::open_for_writing().

unsigned char fawkes::interface_header_t::hash[__INTERFACE_HASH_SIZE]

interface type version hash

Definition at line 39 of file interface_mem_header.h.

Referenced by fawkes::BlackBoardInterfaceProxy::BlackBoardInterfaceProxy(), fawkes::BlackBoardInterfaceManager::list_all(), fawkes::BlackBoardInterfaceManager::open_for_reading(), fawkes::BlackBoardInterfaceManager::open_for_writing(), and fawkes::BlackBoardInterfaceManager::open_multiple_for_reading().

char fawkes::interface_header_t::id[__INTERFACE_ID_SIZE]

interface identifier

Definition at line 38 of file interface_mem_header.h.

Referenced by fawkes::BlackBoardInterfaceProxy::BlackBoardInterfaceProxy(), fawkes::BlackBoardInterfaceManager::list_all(), and fawkes::BlackBoardInterfaceManager::open_multiple_for_reading().

uint16_t fawkes::interface_header_t::num_readers

number of active readers

Definition at line 42 of file interface_mem_header.h.

Referenced by fawkes::BlackBoardInterfaceProxy::BlackBoardInterfaceProxy(), fawkes::BlackBoardInterfaceManager::close(), fawkes::BlackBoardInterfaceManager::list_all(), fawkes::BlackBoardInterfaceManager::num_readers(), fawkes::BlackBoardInterfaceManager::open_for_reading(), and fawkes::BlackBoardInterfaceManager::open_multiple_for_reading().

uint32_t fawkes::interface_header_t::refcount

reference count

Definition at line 43 of file interface_mem_header.h.

Referenced by fawkes::BlackBoardInterfaceProxy::BlackBoardInterfaceProxy(), fawkes::BlackBoardInterfaceManager::close(), fawkes::BlackBoardInterfaceManager::open_for_reading(), fawkes::BlackBoardInterfaceManager::open_for_writing(), and fawkes::BlackBoardInterfaceManager::open_multiple_for_reading().

uint32_t fawkes::interface_header_t::serial

memory serial

Definition at line 44 of file interface_mem_header.h.

Referenced by fawkes::BlackBoardInterfaceManager::list_all(), fawkes::BlackBoardInterfaceManager::open_for_reading(), fawkes::BlackBoardInterfaceManager::open_for_writing(), and fawkes::BlackBoardInterfaceManager::open_multiple_for_reading().

char fawkes::interface_header_t::type[__INTERFACE_TYPE_SIZE]

interface type

Definition at line 37 of file interface_mem_header.h.

Referenced by fawkes::BlackBoardInterfaceProxy::BlackBoardInterfaceProxy(), fawkes::BlackBoardInterfaceManager::list_all(), and fawkes::BlackBoardInterfaceManager::open_multiple_for_reading().


The documentation for this struct was generated from the following file:
Generated on Tue Feb 22 13:31:37 2011 for Fawkes API by  doxygen 1.4.7