User's Guide
Reference Manual
Release Notes
PDF
Top

Inviso
Reference Manual
Version 0.6.1

Expand All
Contract All

Table of Contents

# inviso_as_lib

### MODULE

inviso_as_lib

### MODULE SUMMARY

The Inviso Autostart Utility Library

### DESCRIPTION

The purpose of the Inviso autostart utility library is to facilitate the creation and modification of autostart configuration files used by the standard autostart.

### EXPORTS

setup_autostart(Node, R, Opts, TracerData, CmdFiles, Bindings, Transl, RTtag) -> ok | {error, Reason}

Types:

Node = atom()
R = int()
Opts -- see inviso:add_nodes/2,3
TracerData -- see inviso:init_tracing/1,2
CmdFiles = [CmdFile]
CmdFile = string()
Bindings = [{Var,Val}]
Var = atom()
Val = term()
Transl = [{{M1,F1,Arity}, {M2,F2,{Mt,Ft}}}]
M1 = F1 = M2 = F2 = Mt = Ft = atom()
Arity = int()
RTtag = term()
Reason = term()

Creates an autostart configuration file on Node. The name of the file is automatically deducted from consulting the Runtime_Tools configuration parameters at Node.

R is the number of allowed autostarts remaining.

Opts is the options which shall be given to the runtime component. See inviso:add_nodes/2,3.

TracerData is used when initiating tracing on this node. See inviso:init_tracing/1,2.

CmdFiles points out files containing instructions understood by the inviso_autostart_server implementation of an autostart initiator.

Bindings is a list of {Var, Val} tuples, where Var is the name of a variable and Val the actual value of the variable.

Transl means that M1:F1/Arity shall be translated into M2:F2.

RTtag is the incarnation tag of the runtime component. See See inviso:add_nodes/2,3.

set_repeat(Node, R) -> ok | {error, Reason}

Types:

Node = atom()
R = int()
Reason = term()

Sets the repeat parameter in the autostart file at Node without changing any of its other contents. The autostart configuration file must exist.

R is the number of allowed autostarts remaining.

inhibit_autostart(Node) -> ok | {error, Reason}

Types:

Node = atom()
Reason = term()

Sets the repeat parameter in the autostart file at Node to 0. Equivalent to set_repeat(Node, 0).