Arguments of the Message Handler Plug-in Initialize Function

The plug-in initialize function (ffh_mh_init_function) prepares the message handler plug-in for use.

The ffh_mh_info argument of the initialize function specifies the release_message and shutdown callbacks that should be used by the plug-in to release no longer needed ffh_fast_message instances, or to request shutdown of the FAST feed handler.

ffh_mh_info->user_data can be used by the plug-in to store a pointer to an instance of its message handler class for future reference.

The plug-in should save a reference to the ffh_mh_info argument so that it can use it in its implementation of the shutdown() function required by the publisher API. In that shutdown() function, the plug-in should invoke the shutdown callback specified in the ffh_mh_info object.

The ffh_init_param argument of the initialize function contains the values and the names of the initParam elements from the configuration file. It can be used to pass information needed to initialize the publisher API (for example, the publisher configuration directory and the RDS templates directory).

Related concepts
Message Handler Plug-ins
Related tasks
Writing a Message Handler Plug-in for the FAST Feed Handler
Writing a Message Handler Plug-in Initialize Function
Writing a Message Handler Plug-in Process Function
Writing a Message Handler Plug-in Finalize Function
Implementing the Shutdown Callback Method
Related reference
Arguments of the Message Handler Process Function
Arguments of the Message Handler Finalize Function
C API Definitions of Function Signatures for Building a Message Handler
C API Definition of ffh_fast_message and its Related Structures
FAST Templates