/Users/maurits/Documents/studie/afstuderen/biosphere/common/type.h

Go to the documentation of this file.

/*
 * Author: MA Hartman
 * Date: apr 10, 2007
 * 
 * Function:
 * Utility functions for the several Bio-SPHERE data structures.
 * 
 * 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 TYPE_H
#define TYPE_H

#include <biosphere.h>
#include <apr_pools.h>

bs_data_type *new_bs_data_type(apr_pool_t *mp, const char *name);

bs_message *new_bs_message(apr_pool_t *mp, const char *name,
                bs_uint16 num_parts);

inline void add_part_to_message(bs_message *msg, bs_message_part *part, apr_pool_t *mp);

bs_message_part *new_bs_message_part(apr_pool_t *mp, const char *name,
                bs_data_type *type);

bs_operation *new_bs_operation(apr_pool_t *mp, const char *name,
                bs_message *input, bs_message *output, bs_message *fault);

bs_port_type *new_bs_port_type(apr_pool_t *mp, const char *name,
                bs_uint16 num_operations);

inline void add_operation_to_port_type(bs_port_type *pt, bs_operation *op,
                apr_pool_t *mp);

bs_port *new_bs_port(apr_pool_t *mp, const char *name, bs_port_type *type);

bs_service *new_bs_service(apr_pool_t *mp, const char *name,
                bs_uint16 num_ports);

inline void add_port_to_service(bs_service *svc, bs_port *port,
                apr_pool_t *mp);

bs_definition *new_bs_definition(apr_pool_t *mp, const char *name,
                bs_uint16 num_data_types, bs_uint16 num_messages,
                bs_uint16 num_port_types, bs_uint16 num_services);

inline void add_data_type_to_definition(bs_definition *def, bs_data_type *type,
                apr_pool_t *mp);

inline void add_message_to_definition(bs_definition *def, bs_message *msg,
                apr_pool_t *mp);

inline void add_port_type_to_definition(bs_definition *def, bs_port_type *pt,
                apr_pool_t *mp);

inline void add_service_to_definition(bs_definition *def, bs_service *svc,
                apr_pool_t *mp);

bs_service_request *new_bs_service_request(apr_pool_t *mp, bs_byte *uuid,
                char *service, char *port, char *operation,
                bs_message_instance *input);

bs_service_response *new_bs_service_response(apr_pool_t *mp,
                const bs_byte *uuid,
                const char *service, const char *port, const char *operation,
                bs_message_instance *output, bs_message_instance *fault);

bs_message_instance *new_bs_message_instance(apr_pool_t *mp, const char *name,
                bs_uint16 num_parts);

bs_part_instance *new_bs_part_instance(apr_pool_t *mp, const char *name,
                bs_data_type *type, const char *data, bs_uint64 size);

inline void add_part_to_request_instance(bs_part_instance *part,
                bs_message_instance *msg, apr_pool_t *mp);

bs_status merge_def_with_def(apr_pool_t *mp, bs_definition *result,
                bs_definition *d);
                
bs_status merge_bs_definitions(apr_pool_t *mp, bs_definition **def, ...);

bs_bool is_builtin_type(const char *name);

bs_status check_builtin_type(bs_part_instance *inst);

bs_bool request_corresponds_with_definition(const bs_service_request *request,
                const bs_definition *def);

#endif /*STRUCTURES_H_*/

---