Home
LNK APIs
The LNK programming interface includes language-specific methods and objects that provide common functionality across multiple environments.
Link programming interface overview
The Link programming interface is an object-oriented approach that enables applications to invoke HCL Link maps, thus removing reliance on command lines.
Link programming interface function overview
Use the Link programming interface to load, run and control maps.
Monitor and manage map overview
These methods enable the execution of a map to be controlled from another thread, and for the progress of a map to be reported.
RegisterStatusMethod
This method allows for a user-provided status method to be registered for a particular map object.

LNK APIs
The LNK programming interface includes language-specific methods and objects that provide common functionality across multiple environments.
- Link programming interface overview
  The Link programming interface is an object-oriented approach that enables applications to invoke HCL Link maps, thus removing reliance on command lines.
  - Link programming interface methods
    The Link programming interface map, card, and adapter object properties define the properties that can be set for each object. Use these methods to GET or SET the object properties.
  - Link programming interface object overview
    The Link programming interface is based on map, card, adapter, connection, and stream objects.
  - Link programming interface function overview
    Use the Link programming interface to load, run and control maps.
    - Scenario: running Link programming interface maps
      Code examples of running maps are installed with the Development Kit in the install_dir\examples\dk\dtxpi directory, where install_dir represents the directory in which the DK is installed.
    - Monitor and manage map overview
      These methods enable the execution of a map to be controlled from another thread, and for the progress of a map to be reported.
      - Abort
        This method aborts the map defined by the map object. The map must be in the running or paused state when this method is called.
      - Continue
        This method continues the map defined by the map object.
      - Pause
        This method pauses the map defined by the map object.
      - RegisterStatusMethod
        This method allows for a user-provided status method to be registered for a particular map object.
    - Load and run map overview
      Use the loading and running methods to load specific maps, refresh maps when the maps have changed, and run maps.
- C API
  The C API enables applications to invoke maps and to develop adapters to use with HCL Link.
- Python API
  Use the Python API to create, edit, and run maps and schemas from a Python program. For details, see the documentation installed in install_dir/python/api/hip/docs/html/index.html. Examples of the Python API are installed in install_dir/python/api/examples. Documentation for the Python API examples is available in install_dir/python/api/docs/html/examples.html.
- Java API
  The Java API interfaces enable you to create, edit, and run maps and schemas from a Java™ program.
- Java Tools
  The Java™ Tools provide objects and JNI utilities that you can use to get information about your map instances.

RegisterStatusMethod

This method allows for a user-provided status method to be registered for a particular map object.

This status method will be invoked at critical points during the execution of the map.

If the status method returns MPI_STATE_ABORTED, execution of the map will stop immediately. After aborting a map, it is possible to start it again from the beginning using the Run method.

iNotifyWhen is a bitmask that governs when the status method will be called. It can be any combination of the values listed.


Value	Description
MPI_EVENT_START_MAP	Notify whenever a map is started.
MPI_EVENT_MAP_COMPLETE	Notify whenever a map completes.
MPI_EVENT_START_BURST	Notify whenever a burst is started.
MPI_EVENT_BURST_COMPLETE	Notify whenever a burst completes.
MPI_EVENT_START_INPUT	Notify whenever an input starts.
MPI_EVENT_INPUT_COMPLETE	Notify whenever an input completes.
MPI_EVENT_START_OUTPUT	Notify whenever an output starts.
MPI_EVENT_OUTPUT_COMPLETE	Notify whenever an output completes.
MPI_EVENT_CARD_EVENTS	Notify whenever any card is started or completes.
MPI_EVENT_BURST_EVENTS	Notify whenever a burst starts or completes.
MPI_EVENT_MAP_EVENTS	Notify whenever a map starts or completes.
MPI_EVENT_ALL_EVENTS	Notify all card, map, and burst events.