WatchDog API

Version: 1.0.0

Status:

WatchDog interface for Thunder framework.

(Defined with IWatchDog in IWatchDog.h)

Introduction

Scope

This document describes purpose and functionality of the WatchDog interface (version 1.0.0). It includes detailed specification about its methods provided.

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

WatchDog JSON-RPC interface.

This interface uses legacy lowercase naming convention. With the next major release the naming convention will change to camelCase.

Methods

The following methods are provided by the WatchDog interface:

WatchDog interface methods:

Method	Description
touch	Touch the watchdog as a sign of life

touch ^method

Touch the watchdog as a sign of life.

Parameters

Name	Type	M/O	Description
params	object	mandatory	...
params.callsign	string	mandatory	In case a specific watchdog needs to be padded pass the name of the callsign for which we want to touch

Result

Name	Type	M/O	Description
result	null	mandatory	Always null

Example

Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "<callsign>.1.touch",
  "params": {
    "callsign": "..."
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": null
}