Controller Plugin

Version: 1.0

Status:

Controller plugin for Thunder framework.

Introduction

Scope

This document describes purpose and functionality of the Controller plugin. It includes detailed specification about its configuration, methods and properties as well as sent notifications.

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
FQDN	Fully-Qualified Domain Name
HTTP	Hypertext Transfer Protocol
JSON	JavaScript Object Notation; a data interchange format
JSON-RPC	A remote procedure call protocol encoded in JSON
SSDP	Simple Service Discovery Protocol

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

Configuration

The table below lists configuration options of the plugin.

Name	Type	M/O	Description
callsign	string	mandatory	Plugin instance name (default: Controller)
classname	string	mandatory	Class name: Controller
locator	string	mandatory	Library name: (built-in)
startmode	string	mandatory	Determines in which state the plugin should be moved to at startup of the framework

Interfaces

This plugin implements the following interfaces:

ISystem (IController.h) (version 1.0.0) (compliant format)

This interface uses legacy lowercase naming convention. With the next major release the naming convention will change to camelCase.
IDiscovery (IController.h) (version 1.0.0) (compliant format)

This interface uses legacy lowercase naming convention. With the next major release the naming convention will change to camelCase.
IConfiguration (IController.h) (version 1.0.0) (uncompliant-extended format)

This interface uses legacy lowercase naming convention. With the next major release the naming convention will change to camelCase.
ILifeTime (IController.h) (version 1.0.0) (compliant format)

This interface uses legacy lowercase naming convention. With the next major release the naming convention will change to camelCase.
ISubsystems (IController.h) (version 1.0.0) (uncompliant-collapsed format)

This interface uses legacy lowercase naming convention. With the next major release the naming convention will change to camelCase.
IEvents (IController.h) (version 1.0.0) (compliant format)

This interface uses legacy lowercase naming convention. With the next major release the naming convention will change to camelCase.
IMetadata (IController.h) (version 1.0.0) (compliant format)

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 Controller plugin:

System interface methods:

Method	Description
reboot / harakiri	Reboots the device
delete	Removes contents of a directory from the persistent storage
clone	Creates a clone of given plugin with a new callsign
destroy	Destroy given plugin

Discovery interface methods:

Method	Description
startdiscovery	Starts SSDP network discovery

Configuration interface methods:

Method	Description
persist / storeconfig	Stores all configuration to the persistent memory

LifeTime interface methods:

Method	Description
activate	Activates a plugin
deactivate	Deactivates a plugin
unavailable	Makes a plugin unavailable for interaction
hibernate	Hibernates a plugin
suspend	Suspends a plugin
resume	Resumes a plugin

reboot ^method

Reboots the device.

harakiri is an alternative name for this method. This name is deprecated and may be removed in the future. It is not recommended for use in new implementations.

Description

Depending on the device this call may not generate a response.

Parameters

This method takes no parameters.

Result

Name	Type	M/O	Description
result	null	mandatory	Always null

Example

Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "Controller.1.reboot"
}

Response

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

delete ^method

Removes contents of a directory from the persistent storage.

Parameters

Name	Type	M/O	Description
params	object	mandatory	...
params.path	string	mandatory	Path to the directory within the persisent storage

Result

Name	Type	M/O	Description
result	null	mandatory	Always null

Example

Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "Controller.1.delete",
  "params": {
    "path": "..."
  }
}

Response

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

clone ^method

Creates a clone of given plugin with a new callsign.

Parameters

Name	Type	M/O	Description
params	object	mandatory	...
params.callsign	string	mandatory	Callsign of the plugin
params.newcallsign	string	mandatory	Callsign for the cloned plugin

Result

Name	Type	M/O	Description
result	string	mandatory	...

Example

Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "Controller.1.clone",
  "params": {
    "callsign": "...",
    "newcallsign": "..."
  }
}

Response

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

destroy ^method

Destroy given plugin.

Parameters

Name	Type	M/O	Description
params	object	mandatory	...
params.callsign	string	mandatory	Callsign of the plugin

Result

Name	Type	M/O	Description
result	null	mandatory	Always null

Example

Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "Controller.1.destroy",
  "params": {
    "callsign": "..."
  }
}

Response

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

startdiscovery ^method

Starts SSDP network discovery.

Parameters

Name	Type	M/O	Description
params	object	mandatory	...
params?.ttl	integer	optional	Time to live, parameter for SSDP discovery (default: 1) Value must be in range [1..255].

Result

Name	Type	M/O	Description
result	null	mandatory	Always null

Example

Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "Controller.1.startdiscovery",
  "params": {
    "ttl": 1
  }
}

Response

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

persist ^method

Stores all configuration to the persistent memory.

storeconfig is an alternative name for this method.

Parameters

This method takes no parameters.

Result

Name	Type	M/O	Description
result	null	mandatory	Always null

Example

Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "Controller.1.persist"
}

Response

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

activate ^method

Activates a plugin.

Description

Use this method to activate a plugin, i.e. move from Deactivated, via Activating to Activated state. If a plugin is in Activated state, it can handle JSON-RPC requests that are coming in. The plugin is loaded into memory only if it gets activated.

Parameters

Name	Type	M/O	Description
params	object	mandatory	...
params.callsign	string	mandatory	Callsign of plugin to be activated

Result

Name	Type	M/O	Description
result	null	mandatory	Always null

Example

Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "Controller.1.activate",
  "params": {
    "callsign": "..."
  }
}

Response

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

deactivate ^method

Deactivates a plugin.

Description

Use this method to deactivate a plugin, i.e. move from Activated, via Deactivating to Deactivated state. If a plugin is deactivated, the actual plugin (.so) is no longer loaded into the memory of the process. In a Deactivated state the plugin will not respond to any JSON-RPC requests.

Parameters

Name	Type	M/O	Description
params	object	mandatory	...
params.callsign	string	mandatory	Callsign of plugin to be deactivated

Result

Name	Type	M/O	Description
result	null	mandatory	Always null

Example

Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "Controller.1.deactivate",
  "params": {
    "callsign": "..."
  }
}

Response

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

unavailable ^method

Makes a plugin unavailable for interaction.

Description

Use this method to mark a plugin as unavailable, i.e. move from Deactivated to Unavailable state. It can not be started unless it is first deactivated (what triggers a state transition).

Parameters

Name	Type	M/O	Description
params	object	mandatory	...
params.callsign	string	mandatory	Callsign of plugin to be set as unavailable

Result

Name	Type	M/O	Description
result	null	mandatory	Always null

Example

Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "Controller.1.unavailable",
  "params": {
    "callsign": "..."
  }
}

Response

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

hibernate ^method

Hibernates a plugin.

Description

Use activate to wake up a hibernated plugin. In a Hibernated state the plugin will not respond to any JSON-RPC requests.

Parameters

Name	Type	M/O	Description
params	object	mandatory	...
params.callsign	string	mandatory	Callsign of plugin to be hibernated
params.timeout	integer	mandatory	Allowed time

Result

Name	Type	M/O	Description
result	null	mandatory	Always null

Errors

Message	Description
`ERROR_INPROC`	The plugin is running in-process and thus cannot be hibernated

Example

Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "Controller.1.hibernate",
  "params": {
    "callsign": "...",
    "timeout": 0
  }
}

Response

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

suspend ^method

Suspends a plugin.

Description

This is a more intelligent method, compared to deactivate, to move a plugin to a suspended state depending on its current state. Depending on the startmode flag this method will deactivate the plugin or only suspend the plugin.

Parameters

Name	Type	M/O	Description
params	object	mandatory	...
params.callsign	string	mandatory	Callsign of plugin to be suspended

Result

Name	Type	M/O	Description
result	null	mandatory	Always null

Example

Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "Controller.1.suspend",
  "params": {
    "callsign": "..."
  }
}

Response

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

resume ^method

Resumes a plugin.

Description

This is a more intelligent method, compared to activate, to move a plugin to a resumed state depending on its current state. If required it will activate and move to the resumed state, regardless of the flags in the config (i.e. startmode, resumed)

Parameters

Name	Type	M/O	Description
params	object	mandatory	...
params.callsign	string	mandatory	Callsign of plugin to be resumed

Result

Name	Type	M/O	Description
result	null	mandatory	Always null

Example

Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "Controller.1.resume",
  "params": {
    "callsign": "..."
  }
}

Response

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

Properties

The following properties are provided by the Controller plugin:

System interface properties:

Property	R/W	Description
environment	read-only	Environment variable value

Discovery interface properties:

Property	R/W	Description
discoveryresults	read-only	SSDP network discovery results

Configuration interface properties:

Property	R/W	Description
configuration	read/write	Service configuration

Subsystems interface properties:

Property	R/W	Description
subsystems	read-only	Subsystems status

Metadata interface properties:

Property	R/W	Description
services / status	read-only	Services metadata
links	read-only	Connections list of Thunder connections
proxies	read-only	Proxies list
version	read-only	Framework version
threads	read-only	Workerpool threads
pendingrequests	read-only	Pending requests
callstack	read-only	Thread callstack
buildinfo	read-only	Build information

environment ^property

Provides access to the environment variable value.

This property is read-only.

The variable parameter shall be passed as the index to the property, i.e. environment@<variable>.

Index

Name	Type	M/O	Description
variable	string	mandatory	...

Value

Name	Type	M/O	Description
(property)	string	mandatory	Environment variable value

Example

Get Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "Controller.1.environment@xyz"
}

Get Response

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

discoveryresults ^property

Provides access to the SSDP network discovery results.

This property is read-only.

Value

Name	Type	M/O	Description
(property)	array	mandatory	SSDP network discovery results
(property)[#]	object	mandatory	...
(property)[#].locator	string	mandatory	Locator for the discovery
(property)[#].latency	integer	mandatory	Latency for the discovery
(property)[#]?.model	string	optional	Model
(property)[#].secure	boolean	mandatory	Secure or not

Example

Get Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "Controller.1.discoveryresults"
}

Get Response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": [
    {
      "locator": "...",
      "latency": 0,
      "model": "...",
      "secure": false
    }
  ]
}

configuration ^property

Provides access to the service configuration.

The callsign parameter shall be passed as the index to the property, i.e. configuration@<callsign>.

Index (Get)

Name	Type	M/O	Description
callsign	string	mandatory	...

Index (Set)

Name	Type	M/O	Description
callsign	string	mandatory	...

Value

Name	Type	M/O	Description
(property)	opaque object	mandatory	Service configuration

Name	Type	M/O	Description
(property)	opaque object	mandatory	Service configuration

Example

Get Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "Controller.1.configuration@xyz"
}

Get Response

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

Set Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "Controller.1.configuration@xyz",
  "params": {}
}

Set Response

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

subsystems ^property

Provides access to the subsystems status.

This property is read-only.

Value

Name	Type	M/O	Description
(property)	array	mandatory	Subsystems status
(property)[#]	object	mandatory	...
(property)[#].subsystem	string	mandatory	Name of the subsystem (must be one of the following: Bluetooth, Cryptography, Decryption, Graphics, Identifier, Installation, Internet, Location, Network, Platform, Provisioning, Security, Streaming, Time, WebSource)
(property)[#].active	boolean	mandatory	Denotes if the subsystem is currently active

Example

Get Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "Controller.1.subsystems"
}

Get Response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": [
    {
      "subsystem": "Security",
      "active": false
    }
  ]
}

services ^property

Provides access to the services metadata.

This property is read-only.

status is an alternative name for this property. This name is deprecated and may be removed in the future. It is not recommended for use in new implementations.

Description

If callsign is omitted, metadata of all services is returned.

The callsign parameter shall be passed as the index to the property, i.e. services@<callsign>.

Index

Name	Type	M/O	Description
callsign	string	mandatory	...

Value

Name	Type	M/O	Description
(property)	array	mandatory	Services metadata (if only one element is present then the array will be omitted)
(property)[#]	object	mandatory	...
(property)[#].callsign	string	mandatory	Plugin callsign
(property)[#].locator	string	mandatory	Shared library path
(property)[#].classname	string	mandatory	Plugin class name
(property)[#].module	string	mandatory	Module name
(property)[#].state	string	mandatory	Current state (must be one of the following: Activated, Activation, Deactivated, Deactivation, Destroyed, Hibernated, Precondition, Resumed, Suspended, Unavailable)
(property)[#].startmode	string	mandatory	Startup mode (must be one of the following: Activated, Deactivated, Unavailable)
(property)[#].resumed	boolean	mandatory	Determines if the plugin is to be activated in resumed or suspended mode
(property)[#].version	object	mandatory	Version
(property)[#].version.hash	string	mandatory	SHA256 hash identifying the source code String length must be equal to 64 chars.
(property)[#].version.major	integer	mandatory	Major number
(property)[#].version.minor	integer	mandatory	Minor number
(property)[#].version.patch	integer	mandatory	Patch number
(property)[#]?.communicator	string	optional	Communicator
(property)[#]?.persistentpathpostfix	string	optional	Postfix of persistent path
(property)[#]?.volatilepathpostfix	string	optional	Postfix of volatile path
(property)[#]?.systemrootpath	string	optional	Path of system root
(property)[#]?.precondition	opaque object	optional	Activation conditons
(property)[#]?.termination	opaque object	optional	Deactivation conditions
(property)[#]?.control	opaque object	optional	Conditions controlled by this service
(property)[#].configuration	opaque object	mandatory	Plugin configuration
(property)[#].observers	integer	mandatory	Number or observers
(property)[#]?.processedrequests	integer	optional	Number of API requests that have been processed by the plugin
(property)[#]?.processedobjects	integer	optional	Number of objects that have been processed by the plugin

Example

Get Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "Controller.1.services@xyz"
}

Get Response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": [
    {
      "callsign": "...",
      "locator": "...",
      "classname": "...",
      "module": "...",
      "state": "Deactivated",
      "startmode": "Deactivated",
      "resumed": false,
      "version": {
        "hash": "...",
        "major": 0,
        "minor": 0,
        "patch": 0
      },
      "communicator": "...",
      "persistentpathpostfix": "...",
      "volatilepathpostfix": "...",
      "systemrootpath": "...",
      "precondition": {},
      "termination": {},
      "control": {},
      "configuration": {},
      "observers": 0,
      "processedrequests": 0,
      "processedobjects": 0
    }
  ]
}

links ^property

Provides access to the connections list of Thunder connections.

This property is read-only.

Value

Name	Type	M/O	Description
(property)	array	mandatory	Connections list of Thunder connections
(property)[#]	object	mandatory	...
(property)[#].remote	string	mandatory	IP address (or FQDN) of the other side of the connection
(property)[#].state	string	mandatory	State of the link (must be one of the following: COMRPC, Closed, RawSocket, Suspended, WebServer, WebSocket)
(property)[#].id	integer	mandatory	A unique number identifying the connection
(property)[#].activity	boolean	mandatory	Denotes if there was any activity on this connection
(property)[#]?.name	string	optional	Name of the connection

Example

Get Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "Controller.1.links"
}

Get Response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": [
    {
      "remote": "...",
      "state": "WebServer",
      "id": 0,
      "activity": false,
      "name": "..."
    }
  ]
}

proxies ^property

Provides access to the proxies list.

This property is read-only.

The linkid parameter shall be passed as the index to the property, i.e. proxies@<linkid>.

Index

Name	Type	M/O	Description
linkid	string	mandatory	...

Value

Name	Type	M/O	Description
(property)	array	mandatory	Proxies list
(property)[#]	object	mandatory	...
(property)[#].interface	integer	mandatory	Interface ID
(property)[#].name	string	mandatory	The fully qualified name of the interface
(property)[#].instance	instanceid	mandatory	Instance ID
(property)[#].count	integer	mandatory	Reference count
(property)[#]?.origin	string	optional	The Origin of the assocated connection

Example

Get Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "Controller.1.proxies@xyz"
}

Get Response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": [
    {
      "interface": 0,
      "name": "...",
      "instance": "0x...",
      "count": 0,
      "origin": "..."
    }
  ]
}

version ^property

Provides access to the framework version.

This property is read-only.

Value

Name	Type	M/O	Description
(property)	object	mandatory	Framework version
(property).hash	string	mandatory	SHA256 hash identifying the source code String length must be equal to 64 chars.
(property).major	integer	mandatory	Major number
(property).minor	integer	mandatory	Minor number
(property).patch	integer	mandatory	Patch number

Example

Get Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "Controller.1.version"
}

Get Response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": {
    "hash": "...",
    "major": 0,
    "minor": 0,
    "patch": 0
  }
}

threads ^property

Provides access to the workerpool threads.

This property is read-only.

Value

Name	Type	M/O	Description
(property)	array	mandatory	Workerpool threads
(property)[#]	object	mandatory	...
(property)[#].id	instanceid	mandatory	Thread ID
(property)[#].job	string	mandatory	Job name
(property)[#].runs	integer	mandatory	Number of runs

Example

Get Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "Controller.1.threads"
}

Get Response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": [
    {
      "id": "0x...",
      "job": "...",
      "runs": 0
    }
  ]
}

pendingrequests ^property

Provides access to the pending requests.

This property is read-only.

Value

Name	Type	M/O	Description
(property)	array	mandatory	Pending requests
(property)[#]	string	mandatory	...

Example

Get Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "Controller.1.pendingrequests"
}

Get Response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": [
    "..."
  ]
}

callstack ^property

Provides access to the thread callstack.

This property is read-only.

The thread parameter shall be passed as the index to the property, i.e. callstack@<thread>.

Index

Name	Type	M/O	Description
thread	integer	mandatory	...

Value

Name	Type	M/O	Description
(property)	array	mandatory	Thread callstack
(property)[#]	object	mandatory	...
(property)[#].address	instanceid	mandatory	Memory address
(property)[#].module	string	mandatory	Module name
(property)[#]?.function	string	optional	Function name
(property)[#]?.line	integer	optional	Line number

Example

Get Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "Controller.1.callstack@0"
}

Get Response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": [
    {
      "address": "0x...",
      "module": "...",
      "function": "...",
      "line": 0
    }
  ]
}

buildinfo ^property

Provides access to the build information.

This property is read-only.

Value

Name	Type	M/O	Description
(property)	object	mandatory	Build information
(property).systemtype	string	mandatory	System type (must be one of the following: Linux, MacOS, Windows)
(property).buildtype	string	mandatory	Build type (must be one of the following: Debug, DebugOptimized, Production, Release, ReleaseWithDebugInfo)
(property)?.extensions	array	optional	...
(property)?.extensions[#]	string	mandatory	... (must be one of the following: Bluetooth, Hiberbate, ProcessContainers, WarningReporting)
(property).messaging	boolean	mandatory	Denotes whether Messaging is enabled
(property).exceptioncatching	boolean	mandatory	Denotes whether there is an exception
(property).deadlockdetection	boolean	mandatory	Denotes whether deadlock detection is enabled
(property).wcharsupport	boolean	mandatory	...
(property).instanceidbits	integer	mandatory	Core instance bits
(property)?.tracelevel	integer	optional	Trace level
(property).threadpoolcount	integer	mandatory	...
(property).comrpctimeout	integer	mandatory	...

Example

Get Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "Controller.1.buildinfo"
}

Get Response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": {
    "systemtype": "Linux",
    "buildtype": "DebugOptimized",
    "extensions": [
      "Bluetooth"
    ],
    "messaging": false,
    "exceptioncatching": false,
    "deadlockdetection": false,
    "wcharsupport": false,
    "instanceidbits": 0,
    "tracelevel": 0,
    "threadpoolcount": 0,
    "comrpctimeout": 0
  }
}

Notifications

Notifications are autonomous events triggered by the internals of the implementation and broadcasted via JSON-RPC to all registered observers. Refer to [Thunder] for information on how to register for a notification.

The following events are provided by the Controller plugin:

LifeTime interface events:

Notification	Description
statechange	Notifies of a plugin state change
statecontrolstatechange	Notifies of a plugin state change controlled by IStateControl

Subsystems interface events:

Notification	Description
subsystemchange	Notifies a subsystem change

Events interface events:

Notification	Description
all	Notifies all events forwarded by the framework

statechange ^notification

Notifies of a plugin state change.

Notification Parameters

Name	Type	M/O	Description
params	object	mandatory	...
params.callsign	string	mandatory	Plugin callsign
params.state	string	mandatory	New state of the plugin (must be one of the following: Activated, Activation, Deactivated, Deactivation, Destroyed, Hibernated, Precondition, Unavailable)
params.reason	string	mandatory	Reason for state change (must be one of the following: Automatic, Conditions, Failure, InitializationFailed, MemoryExceeded, Requested, Shutdown, Startup, WatchdogExpired)

Example

Registration

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "Controller.1.register",
  "params": {
    "event": "statechange",
    "id": "myid"
  }
}

Notification

{
  "jsonrpc": "2.0",
  "method": "myid.statechange",
  "params": {
    "callsign": "...",
    "state": "Deactivated",
    "reason": "Automatic"
  }
}

The client ID parameter is passed within the notification designator, i.e. <client-id>.statechange.

statecontrolstatechange ^notification

Notifies of a plugin state change controlled by IStateControl.

Notification Parameters

Name	Type	M/O	Description
params	object	mandatory	...
params.callsign	string	mandatory	Plugin callsign
params.state	string	mandatory	New state of the plugin (must be one of the following: Resumed, Suspended, Unknown)

Example

Registration

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "Controller.1.register",
  "params": {
    "event": "statecontrolstatechange",
    "id": "myid"
  }
}

Notification

{
  "jsonrpc": "2.0",
  "method": "myid.statecontrolstatechange",
  "params": {
    "callsign": "...",
    "state": "Suspended"
  }
}

The client ID parameter is passed within the notification designator, i.e. <client-id>.statecontrolstatechange.

subsystemchange ^notification

Notifies a subsystem change.

Notification Parameters

Name	Type	M/O	Description
params	array	mandatory	Subsystems that have changed
params[#]	object	mandatory	...
params[#].subsystem	string	mandatory	Name of the subsystem (must be one of the following: Bluetooth, Cryptography, Decryption, Graphics, Identifier, Installation, Internet, Location, Network, Platform, Provisioning, Security, Streaming, Time, WebSource)
params[#].active	boolean	mandatory	Denotes if the subsystem is currently active

Example

Registration

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "Controller.1.register",
  "params": {
    "event": "subsystemchange",
    "id": "myid"
  }
}

Notification

{
  "jsonrpc": "2.0",
  "method": "myid.subsystemchange",
  "params": [
    {
      "subsystem": "Security",
      "active": false
    }
  ]
}

The client ID parameter is passed within the notification designator, i.e. <client-id>.subsystemchange.

all ^notification

Notifies all events forwarded by the framework.

Description

The Controller plugin is an aggregator of all the events triggered by a specific plugin. All notifications send by any plugin are forwarded over the Controller socket as an event.

Notification Parameters

Name	Type	M/O	Description
params	object	mandatory	...
params.event	string	mandatory	Name of the message
params?.callsign	string	optional	Origin of the message
params?.params	opaque object	optional	Contents of the message

Example

Registration

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "Controller.1.register",
  "params": {
    "event": "all",
    "id": "myid"
  }
}

Notification

{
  "jsonrpc": "2.0",
  "method": "myid.all",
  "params": {
    "event": "...",
    "callsign": "...",
    "params": {}
  }
}

The client ID parameter is passed within the notification designator, i.e. <client-id>.all.

Controller Plugin

Table of Contents

Introduction

Scope

Case Sensitivity

Acronyms, Abbreviations and Terms

References

Configuration

Interfaces

Methods

reboot method

Description

Parameters

Result

Example

Request

Response

delete method

Parameters

Result

Example

Request

Response

clone method

Parameters

Result

Example

Request

Response

destroy method

Parameters

Result

Example

Request

Response

startdiscovery method

Parameters

Result

Example

Request

Response

persist method

Parameters

Result

Example

Request

Response

activate method

Description

Parameters

Result

Example

Request

Response

deactivate method

Description

Parameters

Result

Example

Request

Response

unavailable method

Description

Parameters

Result

Example

Request

Response

hibernate method

Description

Parameters

Result

Errors

Example

Request

Response

suspend method

Description

Parameters

Result

reboot ^method

delete ^method

clone ^method

destroy ^method

startdiscovery ^method

persist ^method

activate ^method

deactivate ^method

unavailable ^method

hibernate ^method

suspend ^method

resume ^method

environment ^property

discoveryresults ^property

configuration ^property

subsystems ^property

services ^property

links ^property

proxies ^property

version ^property

threads ^property

pendingrequests ^property

callstack ^property