Public Requests

Worker APIs

Overview

PurposeMessage TypeIcon GlyphFile Prefix

Send message to Worker from external source

Asynchronous

rqp_

The images below are taken from the Workers Fundamentals example project.

Public Request Purpose

A Public Request 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.

A Public Request is a message that can be sent to a Worker from an external source

Public Request usage example

The image below demonstrates the use of a Public Request VI sending a message from a MHL case of Worker A to a MHL case of Worker B. In order for the Public Request VI to know which instance of Worker B to send a message to, the Worker's Data Wire must be wired to the top-left input terminal of the Public Request VI.

Worker A : Main.vi - Public Request VI example

Public Request VI

A Public Request VI is required to be wired in-line with a Caller's Main Data Wire, as shown in the block diagram image above. The Public Request VI will send a message to the Worker who's data wire is connected to its top-left input terminal. The message will be received by the Worker's MHL case that has the same name as the Request VI.

Every Public Request VI filename takes the prefix: rqp_ (request public). Every Public Request VI icon contains a green glyph in its bottom-right corner. An example of a Public Request VI is shown below.

Worker B : rqp_Return Number.vi

Data in

Data that will be sent along with the message. By default, this is a typedef that has the same filename as the Public Request VI.

Message Priority

The priority of the message (default is Normal) can be set to either Low, Normal or High.

Show in Debugger?

When this flag is TRUE, then meta-data about this message will be sent to the Workers Debug Server.

Public Request Typedef

Public Request typedefs are created with the same icon and filename as their matching Public Request VI. Their purpose is to provide a custom container (cluster) for the data that will be sent along with the message to the Public Request's MHL case.

Public Request MHL Cases

For every Public Request, a MHL case will be created to receive the message sent by the Public Request VI. Public Request MHL cases will automatically be added to the Worker's case structure section called --- PUBLIC API CASES ---. To convert the data sent with the message to its specific data type, a Variant to Data node is required at the beginning of every Public Request MHL case (this will automatically be added to the MHL case when the MHL case is created by the Public API Builder tool).

Worker B : Main.vi - Public Request MHL cases

Public Request Folders

Public Request VIs created by the Public API Builder tool are added to a Worker's Public API >> Requests folder. Their scope is set to public because they are designed to be used from code that is external to the Worker that owns them.

Public Request folder structure within a Worker

Last updated