murex rocks

Welcome

About

Install

Change Log

Blog

Technical Docs

Language Tour

Interactive Shell

Rosetta Stone

User Guide

Open Source

Discuss

Contribute

Source Code

Search Site

Murex Event Subsystem (event)

Event driven programming for shell scripts

Description

Create or destroy an event interrupt,

Each event will have subtly different behaviour depending on the event itself due to the differing roles of each event system. Therefore it is recommended that you read the docs on each event to understand its behaviour.

However while they might differ, the event API does try to retain a level of external consistency. For example each event in defined via name=interrupt where name is a user defined handle (like a variable or function would have a name) and interrupt is a system state you wish the event to be fired on.

Each event function will have a payload sent via stdin which would look a little like the following:

{
    "Name": "",
    "Interrupt": {}
}

Name will always refer to the name you passed when defining the event. And Interrupt will carry any event specific metadata that might be useful to the event function. Thus the value of Interrupt will vary from one event to another.

Usage

event event-type name=interrupt { code block }

!event event-type name

Examples

Create an event

event onSecondsElapsed autoquit=60 {
    out "Your 60 second timeout has elapsed. Quitting murex"
    exit 1
}

Destroy an event

!event onSecondsElapsed autoquit

Detail

ANSI constants

The interrupt field in the CLI supports ANSI constants. eg

event onKeyPress f1={F1-VT100} {
    tout qs HintText="Key F1 Pressed"
}

Compiled events

To list compiled event types:

» runtime --events -> formap event ! { out $event }
onCommandCompletion
onFileSystemChange
onKeyPress
onPrompt
onSecondsElapsed

Synonyms

• event
• !event

See Also

• For Each In Map (formap): Iterate through a map or other collection of data
• Open File (open): Open a file with a preferred handler
• Private Function (private): Define a private function block
• Public Function (function): Define a function block
• Shell Runtime (runtime): Returns runtime information on the internal state of Murex

---

This document was generated from builtins/events/events_doc.yaml.