interface_mem_header.h

00001  
00002 /***************************************************************************
00003  *  interface_mem_header.h - BlackBoard interface memory header
00004  *
00005  *  Generated: Fri Oct 20 13:41:29 2006
00006  *  Copyright  2006  Tim Niemueller [www.niemueller.de]
00007  *
00008  ****************************************************************************/
00009 
00010 /*  This program is free software; you can redistribute it and/or modify
00011  *  it under the terms of the GNU General Public License as published by
00012  *  the Free Software Foundation; either version 2 of the License, or
00013  *  (at your option) any later version. A runtime exception applies to
00014  *  this software (see LICENSE.GPL_WRE file mentioned below for details).
00015  *
00016  *  This program is distributed in the hope that it will be useful,
00017  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
00018  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00019  *  GNU Library General Public License for more details.
00020  *
00021  *  Read the full text in the LICENSE.GPL_WRE file in the doc directory.
00022  */
00023 
00024 #ifndef __BLACKBOARD_INTERFACE_MEM_HEADER_H_
00025 #define __BLACKBOARD_INTERFACE_MEM_HEADER_H_
00026 
00027 #include <interface/interface.h>
00028 
00029 #include <stdint.h>
00030 
00031 namespace fawkes {
00032 
00033 /** This struct is used as header for interfaces in memory chunks.
00034  * This header is stored at the beginning of each allocated memory chunk.
00035  */
00036 typedef struct {
00037   char             type[__INTERFACE_TYPE_SIZE]; /**< interface type */
00038   char             id[__INTERFACE_ID_SIZE];     /**< interface identifier */
00039   unsigned char    hash[__INTERFACE_HASH_SIZE]; /**< interface type version hash */
00040   uint16_t         flag_writer_active :  1;     /**< 1 if there is a writer, 0 otherwise */
00041   uint16_t         flag_reserved      : 15;     /**< reserved for future use */
00042   uint16_t         num_readers;                 /**< number of active readers */
00043   uint32_t         refcount;                    /**< reference count */
00044   uint32_t         serial;                      /**< memory serial */
00045 } interface_header_t;
00046 
00047 } // end namespace fawkes
00048 
00049 #endif

Generated on Tue Feb 22 13:31:25 2011 for Fawkes API by  doxygen 1.4.7