bs_module Struct Reference
[Bio-SPHERE Modules]

#include <biosphere_module.h>

Data Fields
const int	bsapi_major
const int	bsapi_minor
const int	module_major
const int	module_minor
const char *	name
const char *	author
const char *	date
const char *	copyright
const char *	description
bs_status(*	init )(void)
bs_status(*	cleanup )(void)
service_request_handler	handler
service_request_handler	syshandler
const char *	services_definition

---

Detailed Description

Each Bio-SPHERE module must declare a variable called symtable which points to this structure. It contains the necessary data fields and function pointers for correct operation of the module.

Definition at line 71 of file biosphere_module.h.

---

Field Documentation

const int bs_module::bsapi_major

The major version of the Bio-SPHERE version used.

Definition at line 73 of file biosphere_module.h.

Referenced by main().

const int bs_module::bsapi_minor

The minor version of the Bio-SPHERE version used.

Definition at line 74 of file biosphere_module.h.

Referenced by main().

const int bs_module::module_major

The major version of this module.

Definition at line 76 of file biosphere_module.h.

Referenced by get_module_descriptions(), and main().

const int bs_module::module_minor

The minor version of this module.

Definition at line 77 of file biosphere_module.h.

Referenced by get_module_descriptions(), and main().

const char* bs_module::name

Name of the module

Definition at line 79 of file biosphere_module.h.

Referenced by get_module_descriptions(), load_module(), and main().

const char* bs_module::author

Author(s) or name of the organization that created the module

Definition at line 80 of file biosphere_module.h.

Referenced by main().

const char* bs_module::date

The release date of the module

Definition at line 81 of file biosphere_module.h.

const char* bs_module::copyright

Optional copyright information

Definition at line 82 of file biosphere_module.h.

const char* bs_module::description

A description of the module

Definition at line 83 of file biosphere_module.h.

Referenced by get_module_descriptions().

bs_status(* bs_module::init)(void)

Initialization routine for this module. It will be called upon loading of the module.

Referenced by load_module().

bs_status(* bs_module::cleanup)(void)

Cleanup routine for this module. Modules are responsible for their own memory management.

Referenced by unload_all_modules().

service_request_handler bs_module::handler

Function to handle a service request.

Parameters:

	response	Pointer to a service response. It is the responsibility of the module to allocate memory for this data structure. Bio-SPHERE will free it after use.
	request	The request that is to be handled.

Returns:

BS_OK on success or other values depending on the error.

Definition at line 106 of file biosphere_module.h.

Referenced by load_module().

service_request_handler bs_module::syshandler

Function pointer to the platform-wide service handler. When the module is loaded, Bio-SPHERE sets this pointer so the module can make use of all other services.

Definition at line 113 of file biosphere_module.h.

Referenced by load_module().

const char* bs_module::services_definition

Path to an WSDL (XML) describing the services. For modules this file will be distributed along side them in the modules directory. For core services, the WSDL definitions will be installed in a separate services/ directory. In future versions it will be desirable to allow this path to be a URI.

Definition at line 122 of file biosphere_module.h.

Referenced by set_definitions().

---

The documentation for this struct was generated from the following file:

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

---