Skip to content

Latest commit

 

History

History
81 lines (57 loc) · 3.46 KB

ResourceMonitorPlugin.md

File metadata and controls

81 lines (57 loc) · 3.46 KB

ResourceMonitor Plugin

Version: 1.0

Status: ⚫⚪⚪

ResourceMonitor plugin for Thunder framework.

Table of Contents

Introduction

Scope

This document describes purpose and functionality of the ResourceMonitor plugin. It includes detailed specification about its configuration.

Case Sensitivity

All identifiers of the interfaces described in this document are case-sensitive. Thus, unless stated otherwise, all keywords, entities, properties, relations and actions should be treated as such.

Acronyms, Abbreviations and Terms

The table below provides and overview of acronyms used in this document and their definitions.

Acronym Description
API Application Programming Interface
HTTP Hypertext Transfer Protocol
JSON JavaScript Object Notation; a data interchange format
JSON-RPC A remote procedure call protocol encoded in JSON

The table below provides and overview of terms and abbreviations used in this document and their definitions.

Term Description
callsign The name given to an instance of a plugin. One plugin can be instantiated multiple times, but each instance the instance name, callsign, must be unique.

References

Ref ID Description
HTTP HTTP specification
JSON-RPC JSON-RPC 2.0 specification
JSON JSON specification
Thunder Thunder API Reference

Description

The ResourceMonitor plugin provides web browsing functionality based on the ResourceMonitor engine.

The plugin is designed to be loaded and executed within the Thunder framework. For more information about the framework refer to [Thunder].

Configuration

The table below lists configuration options of the plugin.

Name Type Description
callsign string Plugin instance name (default: ResourceMonitor)
classname string Class name: ResourceMonitor
locator string Library name: libThunderResourceMonitor.so
startmode string Determines if the plugin shall be started automatically along with the framework
configuration object (optional)
configuration?.path string (optional) Path of resource
configuration?.interval number (optional) Duration between measurements (default: 5)
configuration?.mode string (optional) Mode (options: "single", "multiple", "callsign", "classname")
configuration?.parent-name string (optional) Name of parent process