Feed Handler C API

The Feed Handler API return codes and handle types are enumerated in the Feed Handler API header files.

For an overview see page Fee Handler API Overview

Please use the links in the following table to view the detailed descriptions of each API function:

mco_fh_app_stop() Requests Feed Handler application shutdown
mco_fh_metadata_add() Provide metadata to the feed handler
mco_fh_writer_create() Create a database writer object
mco_fh_writer_store_record() Write a record to the database
mco_fh_writer_destroy() Destroy a writer
mco_fh_record_create() Create a database record
mco_fh_record_zero_out() Reset the record’s fields to zeroes
mco_fh_record_set_field_SCALAR_TYPE() Set the value of a record’s scalar field
mco_fh_record_set_field_string() Set a record field’s C string value
mco_fh_record_set_field_char_array() Set a record field’s character array value
mco_fh_record_destroy() Destroy a record object
mco_fh_config_get_node_type() Return the type of the configuration node
mco_fh_config_get_node_name() Return the name of the configuration node
mco_fh_config_node_get_SCALAR_TYPE() Retrieve the configuration node’s value as SCALAR_TYPE
mco_fh_config_node_get_child() Return the current node’s child node with the specified key
mco_fh_config_node_get_vector_size() Return the array node’s element count
mco_fh_config_node_get_vector_element() Return the array node’s element at the specified index
mco_fh_log() Write a message to the Feed Handler application log

Feed Handler Module API Functions

Please use the links in the following table to view the detailed descriptions of each API function:

mco_fh_mod_api_version() Return the version of ModAPI implemented by this module
mco_fh_mod_create() Create a module instance
mco_fh_mod_name() Return the name of the module
mco_fh_mod_version() Return the version of the module
mco_fh_mod_add_data_source() Add a data source from the module’s configuration section
mco_fh_mod_add_subscription() Add a subscription to the module’s subscription list
mco_fh_mod_init() Initialize the module
mco_fh_mod_fill_metadata() Request that the module provide metadata
mco_fh_mod_get_field_info() Return information (type, size, precision) about the specified table’s field
mco_fh_mod_add_table() Instruct the module to use the database table as specified
mco_fh_mod_start() Request that the module begin execution
mco_fh_mod_get_stats() Retrieve the module’s statistics for UI reporting
mco_fh_mod_stop() Request that the module to stop
mco_fh_mod_destroy() Request deallocation of all resources associated with the module’s handle