Home
LNK APIs
The LNK programming interface includes language-specific methods and objects that provide common functionality across multiple environments.
C API
The C API enables applications to invoke maps and to develop adapters to use with HCL Link.
Custom adapters
The custom adapters interface makes it possible for users to develop adapters with as much functionality as those provided with the product.
Vtable adapter library
Virtual table example structure
The virtual table (vtable) adapter library contains configuration information about the adapter, including the names of functions, transactional capabilities, and so on. This vtable is exported from the DLL/shared library of each adapter. This is ann example of the vtable structure.

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.
- C API
  The C API enables applications to invoke maps and to develop adapters to use with HCL Link.
  - C API interface methods overview
    The map, card, and adapter object properties define the properties that can be set for each object. Use the C API interface methods to GET or SET the adapter object properties.
  - Object methods
  - Loading, running, and controlling maps
    There are various methods you can use to load, run, and control maps when you use APIs with HCL Link.
  - Custom adapters
    The custom adapters interface makes it possible for users to develop adapters with as much functionality as those provided with the product.
    - Developing custom adapters
      The custom adapters interface makes it possible for users to develop adapters with as much functionality as those provided with the product.
    - Adapter registration and the library virtual table
      The first step required to develop an adapter is to add the adapter to the adapters.xml registration file.
    - Initializing the adapter
      InitializeLibrary provides an entry point by which any global structures, critical sections, or lists that are required by the adapter can be initialized.
    - Point to adapter methods
      After your adapter is loaded, you call the virtual table (vtable) structure to obtain pointers to the methods.
    - Adapter registration file
      The adapters.xml registration file contains a single tag for each adapter, including a number of attributes to provide information about the adapter.
    - Vtable adapter library
      - Virtual table adapter library
        The virtual table (vtable) adapter library contains configuration information about the adapter, including the names of functions, transactional capabilities, and so on. This vtable is exported from the DLL/shared library of each adapter.
      - Virtual table library values
        The virtual table (vtable) adapter library contains configuration information about the adapter, including the names of functions, transactional capabilities, and so on. This vtable is exported from the DLL/shared library of each adapter.
      - Virtual table example structure
        The virtual table (vtable) adapter library contains configuration information about the adapter, including the names of functions, transactional capabilities, and so on. This vtable is exported from the DLL/shared library of each adapter. This is ann example of the vtable structure.
    - Methods provided by adapter
    - Additional adapter methods
      There are a number of additional methods that are part of the HIP Programming Interface library that are of particular relevance to adapter developers.
    - Passing data to and from maps
      Data is passed between adapters and the engine through stream objects. From the adapter perspective, there is no need to create these stream objects; they are already created when either the Get or Put method is called.
    - Threads, connections, and transactions overview
      It is important to understand how threads, connections, and transactions interact.
- 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.

Virtual table example structure

The virtual table (vtable) adapter library contains configuration information about the adapter, including the names of functions, transactional capabilities, and so on. This vtable is exported from the DLL/shared library of each adapter. This is ann example of the vtable structure.

EXPORT MPI_LIBRARY_VTABLE M4MQS_config = 
{
sizeof(MPI_LIBRARY_VTABLE),
InitializeLibrary,  /* InitializeLibrary */
DestroyLibrary,  /* Destroy Library */
CreateAdapterInstance,  /* CreateAdapterInstance */
DestroyAdapterInstance,  /* DestroyAdapterInstance */
CreateConnectionInstance,  /* CreateConnectionInstance */
DestroyConnectionInstance L,  /* DestroyConnectionInstance */
NULL,  /* CombinedListen */
"-QN % -MID %"  /* Command line mask */
MPI_TRANSACTIONS_SINGLE, /* Transactional mode */
MPI_UNITOFWORK_MESSAGE,  /* Unit of work */
TRUE,  /* Listener interface supported */
FALSE,  /* Listener does not block */
FALSE, /* Listener is not transactional */
TRUE,  /* Retries */

/*** Source Settings ***/
FALSE,  /* Resource manage source */
TRUE,  /* Warnings */
MPI_SCOPE_MAP | MPI_SCOPE_BURST | MPI_SCOPE_CARD,  /* Source scopes */
MPI_ACTION_KEEPONCONTENT | MPI_ACTION_KEEP | 
MPI_ACTION_DELETE, /* Source OnSuccess*/
MPI_ACTION_ROLLBACK | MPI_ACTION_COMMIT,  /* Source OnFailure */
MPI_SCOPE_MAP,  /* Default scope */
MPI_ACTION_DELETE,  /* Default OnSuccess */
MPI_ACTION_ROLLBACK,  /* Default OnFailure */
/*** Target Settings ***/

FALSE,  /* Resource manage target */
TRUE,  /* Warnings */
MPI_SCOPE_MAP | MPI_SCOPE_BURST | MPI_SCOPE_CARD,  /* Target scopes */
MPI_ACTION_CREATEONCONTENT | MPI_ACTION_CREATE,  /* Target OnSuccess */
MPI_ACTION_ROLLBACK | MPI_ACTION_COMMIT,  /* Target OnFailure */
MPI_SCOPE_MAP,  /* Default scope */
MPI_ACTION_CREATE,  /* Default OnSuccess */
MPI_ACTION_ROLLBACK  /* Default OnFailure */
};