/Users/maurits/Documents/studie/afstuderen/biosphere/include/biosphere.h

Go to the documentation of this file.

/*
 * Author: MA Hartman
 * Date: jan 16, 2007
 * 
 * Function:
 * Biosphere.h defines common functions and datastructures for the
 * Bio-SPHERE platform.
 * 
 * License information:
 * 
 * Copyright (c) 2006 Maurits Hartman
 *
 * Permission is hereby granted, free of charge, to any person
 * obtaining a copy of this software and associated documentation
 * files (the "Software"), to deal in the Software without
 * restriction, including without limitation the rights to use,
 * copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following
 * conditions:
 * 
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 * OTHER DEALINGS IN THE SOFTWARE.
 * 
 */

#ifndef BIOSPHERE_H
#define BIOSPHERE_H

#ifdef __cplusplus
  extern "C" {
#endif

/*******************************************************
 *                                                     *
 *  GENERAL DEFINITIONS                                *
 *                                                     *
 *******************************************************/

#define BIOSPHERE_VERSION_MAJOR  0
#define BIOSPHERE_VERSION_MINOR  0
#define BIOSPHERE_VERSION_PATCH  3
#define BIOSPHERE_VERSION_STRING "Bio-SPHERE/0.0.3 (May 30, 2007)"

#ifndef TRUE
  #define TRUE 1
  #define FALSE 0
#endif

typedef unsigned char                   bs_bool;
typedef unsigned char                   bs_byte;
typedef short                   bs_int16;
typedef unsigned short  bs_uint16;
typedef int                     bs_int32;
typedef unsigned int    bs_uint32;
typedef long long                       bs_int64;
typedef unsigned long long      bs_uint64;
typedef double                                  bs_double;

#define BS_UINT64_FMT "llu"
#define BS_INT64_FMT "lld"

/* Only include after the types are defined since biosphere_error.h
 * relies on those. */
#include <biosphere_error.h>


/*******************************************************
 *                                                     *
 *  SERVICE DEFINITION STRUCTURES                      *
 *                                                     *
 *******************************************************/

typedef struct bs_data_type
{
        char   *name;           
        bs_bool builtin;        
        bs_bool from_mp;        
} bs_data_type;

typedef struct bs_message_part
{
        char                            *name;          
        bs_data_type            *type;          
        bs_bool from_mp;        
} bs_message_part;

typedef struct bs_message
{
        char                       *name;               
        bs_message_part   **parts;              
        bs_uint16                       num_parts;      
        bs_bool                         from_mp;        
} bs_message;

typedef struct bs_operation
{
        char       *name;               
        bs_message *input;              
        bs_message *output;             
        bs_message *fault;              
        bs_bool         from_mp;        
} bs_operation;

typedef struct bs_port_type
{
        char               *name;                       
        bs_operation  **operations;             
        bs_uint16               num_operations; 
        bs_bool                 from_mp;                
} bs_port_type;

typedef struct bs_port
{
        char               *name;                       
        bs_port_type   *port_type;              
        bs_bool                 from_mp;                
} bs_port;

typedef struct bs_service
{
        char               *name;                       
        bs_port           **ports;                      
        bs_uint16               num_ports;              
        bs_bool                 from_mp;                
} bs_service;

typedef struct bs_definition
{
        char               *name;                       
        bs_data_type  **data_types;             
        bs_uint16               num_data_types; 
        bs_message        **messages;           
        bs_uint16               num_messages;   
        bs_port_type  **port_types;             
        bs_uint16               num_port_types; 
        bs_service        **services;           
        bs_uint16               num_services;   
        bs_bool                 from_mp;                
} bs_definition;

/*******************************************************
 *                                                     *
 *  SERVICE REQUEST STRUCTURES                         *
 *                                                     *
 *******************************************************/

typedef struct bs_part_instance
{
        char               *name;               
        bs_data_type   *type;           
        char               *data;               
        bs_uint64               size;           
        bs_bool                 from_mp;        
} bs_part_instance;

typedef struct bs_message_instance
{
        char                       *name;               
        bs_part_instance  **parts;              
        bs_uint16                       num_parts;      
        bs_bool                         from_mp;        
} bs_message_instance;

typedef struct bs_service_request
{
        bs_byte                 uuid[16];       
        char               *service;    
        char               *port;               
        char               *operation;  
        bs_message_instance *input;     
        bs_bool                 from_mp;        
} bs_service_request;
 
/*******************************************************
 *                                                     *
 *  SERVICE RESPONSE STRUCTURES                        *
 *                                                     *
 *******************************************************/
 
typedef struct bs_service_response
{ 
        bs_byte                 uuid[16];       
        char               *service;    
        char               *port;               
        char               *operation;  
        bs_message_instance *output;    
        bs_message_instance *fault;             
        bs_bool                 from_mp;        
} bs_service_response;

#ifdef __cplusplus
  }
#endif
#endif /*BIOSPHERE_H*/

---