Haka: module Struct Reference

Haka

- Main Page
- Modules
- Data Structures
- Files

- Data Structures
- Data Structure Index
- Data Fields

Data Fields
module Struct Reference

`#include <include/haka/module.h>`

## Data Fields
enum module_type | type
const char * | name
const char * | description
const char * | author
int | api_version
int(* | init )(struct parameters *args)
void(* | cleanup )()

## Detailed Description

Module declaration object.

## Field Documentation

int module::api_version

API version (use HAKA_API_VERSION).

const char* module::author

Module author.

void(* module::cleanup) ()

Cleanup the module. This function is called by the application when the module is unloaded.

const char* module::description

Module description.

int(* module::init) (struct parameters *args)

Initialize the module. This function is called by the application.

Returns
  Non zero in case of an error. In this case the module will be unloaded but cleanup is not going to be called.

const char* module::name

Module name.

enum module_type module::type

Module type

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

- include/haka/module.h