cniCreateNodeFactory

Creates a node factory in the message broker engine. A single instance of the named message flow node factory is created.

This function must be invoked only in the initialization function bipGetMessageFlowNodeFactory, which is called when the LIL is loaded by the message broker. If cniCreateNodeFactory is invoked at any other time, the results are unpredictable.

Syntax

CciFactory* cniCreateNodeFactory(
  int*      returnCode,
  CciChar*  name);

Parameters

returnCode
The return code from the function (output).
Possible return codes are:
  • CCI_SUCCESS
  • CCI_FAILURE
  • CCI_EXCEPTION
  • CCI_INV_FACTORY_NAME
  • CCI_INV_OBJECT_NAME
name
The name of the factory being created (input).

Return values

If successful, the address of the node factory object is returned. Otherwise, a value of zero (CCI_NULL_ADDR) is returned, and the returnCode parameter indicates the reason for the error.

Example

  factoryObject = cniCreateNodeFactory(0, (unsigned short *)constPluginNodeFactory);
  if (factoryObject == CCI_NULL_ADDR) {

  /* Handle errors */