Workers for LabVIEW
HomeDownload Follow ProjectAbout
  • Welcome to Workers for LabVIEW
  • What's New in v5.0
    • Upgrading to v5.0
    • New Features
      • Development Tools
      • Functional Changes
      • API Changes
      • Example Projects
      • Change Log
  • Fundamental Concepts
    • What is a Worker?
    • Important Terms
    • The Workers Main VI
      • Default Framework Cases
    • subWorker Types
    • Initialization Sequence
    • Shutdown Sequence
    • Priority Queue
    • Launcher VIs
  • Worker APIs
    • Overview
    • Local Requests
      • Creating Local Requests
    • Public Requests
      • Creating Public Requests
    • Public Requests w/Reply
      • Creating Public Requests w/Reply
    • Public Responses
      • Creating Public Responses
      • Registering Public Responses
    • Case Labels
    • Deleting API Items
  • Workers Tools
    • Workers Tools Menu
      • Create/Add Worker
        • Removing Workers
        • Creating Worker Templates
        • Troubleshooting
      • Workers Debug Server
        • Workers Application Manager
          • Right click menu
        • Worker Message Logs
          • Right click menu
        • Settings
        • Troubleshooting
      • Worker Call-Chain Viewer
      • Worker User Library
        • Config File Editor
      • RT Worker Convert
      • Public API Builder
        • Public Requests
        • Public Requests w/Reply
        • Public Responses
        • Override MHL Cases
      • Create Launcher VI
      • Create Worker Base Class
      • Change Inheritance
      • MHL Case Viewer
      • Change Worker Properties
    • Quickdrop Shortcuts
      • Show Private Data (Ctrl+0)
      • Create MHL Case tool (Ctrl+9)
      • Go To MHL Case (Ctrl+8)
  • Getting Started
    • Creating your first application
    • Example Projects
  • Legal
    • Disclaimer
    • Licenses
Powered by GitBook
On this page
  • Overview
  • Public Request Purpose
  • Public Request usage example
  • Public Request VI
  • Public Request Typedef
  • Public Request MHL Cases
  • Public Request Folders
  1. Worker APIs

Public Requests

Worker APIs

PreviousCreating Local RequestsNextCreating Public Requests

Last updated 7 months ago

Overview

Purpose
Message Type
Icon Glyph
File Prefix

Send message to Worker from external source

Asynchronous

rqp_

The images below are taken from the 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.

Public Request usage example

Public Request VI

Data in

Message Priority

Show in Debugger?

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

Public Request Folders

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 must be wired to the top-left input terminal of the Public Request VI.

A Public Request VI is required to be wired in-line with a Caller's , 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.

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

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

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

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 Request VIs created by the 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.

priority
Workers Debug Server
Public API Builder tool
Public API Builder tool
typedef
Workers Fundamentals
Handle
Main Data Wire
A Public Request is a message that can be sent to a Worker from an external source
Worker A : Main.vi - Public Request VI example
Worker B : rqp_Return Number.vi
Worker B : Main.vi - Public Request MHL cases
Public Request folder structure within a Worker