Public Requests w/Reply

Public API Builder tool

A Public Request with Reply is a message that can be sent to a Worker from an external source, such as from a Worker's Caller (within a Workers application), from another LabVIEW application or framework, or from TestStand. The VI that sends the message will wait until a Reply message is received back from the Worker that the Request message was sent to. You can create and edit a Worker's Public Request with Reply in the Requests w/Reply tab of the Public API Builder tool, as shown in the image below:

Requests with Reply tab (Public API Builder tool)

1. Create new Request w/Reply

See section Creating Public Requests w/Reply.

2. Right Click Menu

Edit Request

This option allows you to edit a Public Request with Reply that already exists. When selected, the following dialog window will appear:

Public API Request Editor

Current Request Name

The current name of the selected Public Request with Reply.

New Request Name

The new name of the Public Request with Reply. The new name will be updated in the following places:

1. The filenames of the associated Public Request with Reply VIs and typedefs.

2. The associated MHL case name that will receive the Public Request with Reply message

3. The internal Case Label constant within the Public Request with Reply VI.

Icon Text

Text that will be written on the Public Request with Reply VI and typedef icons, to help users understand which MHL Case will receive the Public Request with Reply message.

MHL Case Description

A new description for the Public Request with Reply MHL case. This description will also be written to the Public Request with Reply VI description.

Good to know

If this tool is being used to edit a Public Request with Reply in a Worker base class, then all Workers that inherit from the Worker base class (within the scope of the open LabVIEW project) that override the Public Request with Reply will also have the override MHL case name and description updated.

Show Request VI

This option will open the front panel of the associated Public Request with Reply VI.

Show Request Data

This option will open the front panel of the associated Request message data typedef.

Show Request Reply Data

This option will open the front panel of the associated Reply message data typedef.

Show MHL Case

This option will open the associated MHL case on the block-diagram of the Worker that owns the Public Request with Reply.