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
  • Local Request Purpose
  • Local Request usage example
  • Local Request VI
  • Local Request Typedef
  • Local Request MHL Cases
  • Local Request Folders
  1. Worker APIs

Local Requests

Worker APIs

PreviousOverviewNextCreating Local Requests

Last updated 10 months ago

Overview

Purpose
Message Type
Icon Glyph
File Prefix

Send message to self

Asynchronous

rql_

The images below are taken from the example project.

Local Request Purpose

A Local Request is a message that a Worker can send to itself. You can use Local Request VIs to send a message from a Worker's EHL to its MHL, or between MHL cases of the same Worker.

Local Request usage example

The image below demonstrates the use of a Local Request VI sending a message from the EHL to the MHL of this Worker's QMH, and from the MHL case to another MHL case of the same Worker.

Local Request VI

Data in

Message Priority

Show in Debugger?

Local Request Typedef

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

Local Request MHL Cases

Local Request Folders

A Local Request VI is required to be wired inline with a Worker's , and can be used from within a Worker's EHL or MHL. This VI will send a message to the Worker's MHL case that has the same name as the Request VI.

Every Local Request VI filename takes the prefix: rql_ (request local). Every Local Request VI icon contains a blue glyph in its bottom-right corner. An example of a Local 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 Local 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 Local Request, a MHL case will be created to receive the message sent by the . Local Request MHL cases will automatically be added to the Worker's case structure section called --- LOCAL 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 Local Request MHL case (this will automatically be added to the MHL case when the MHL case is created by the ).

Local Request VIs created by the are added to a Worker's Local API >> Requests folder. Their scope is set to protected because they are designed to be used only from within the Worker that owns them.

priority
Workers Debug Server
Create MHL Case tool
typedef
Create MHL Case tool
Local Request VI
Workers Fundamentals
Main Data Wire
A local request is a message that a Worker can only send to itself
Worker A : Main.vi - Local Request VI example
Worker A : rql_Send String.vi
Worker A : Main.vi - Local Request MHL cases
Local Request folder structure within a Worker