(v13) PluginLib_ip_out_reserve

This page applies to Harlequin v13.1r0 and later; and to Harlequin MultiRIP but not Harlequin Core

PluginLib_ip_out_reserve Function

TEXT

    int32 PluginLib_ip_out_reserve(
      PLUGIN_BUFFER * dataOutBuffer,
      int32 request,
      uint8 ** addr
      );

Assigns to *addr a pointer into the buffer from where request bytes can be read. If request bytes are not available, IPPL_EMPTY is returned. Otherwise, IPPL_OK is returned.

Where the function is used in the writing half of a plugin providing jobs, data should not be allowed to accumulate in the dataOutBuffer , but sent to wherever it is to go as quickly as possible. It is unlikely that large amounts of data will be sent to the plugin, and the buffer may contain timely status information.

Note: Plugins are bi‐directional, and the above paragraph is referring to the section of the plugin that sends data to the RIP. See the “Hello World” input plugin example provided in the kit.

For plugins designed specifically for writing, it may be better to write the data in larger chunks. How‐ ever, there will usually be unwritten data which must be written left over when the close occurs.