Skip to content

Latest commit

 

History

History
282 lines (206 loc) · 7.93 KB

TimeSyncPlugin.md

File metadata and controls

282 lines (206 loc) · 7.93 KB
Raw

Time Sync Plugin

Version: 1.0

Status: ⚫⚫⚫

TimeSync plugin for Thunder framework.

Table of Contents

Introduction

Scope

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

Case Sensitivity

All identifiers on the interface 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 Time Sync plugin provides time synchronization functionality from various time sources (e.g. NTP).

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: TimeSync)
classname string Class name: TimeSync
locator string Library name: libWPEFrameworkTimeSync.so
autostart boolean Determines if the plugin is to be started automatically along with the framework
deferred boolean (optional) Determines if automatic time sync shall be initially disabled
periodicity number (optional) Periodicity of time synchronization (in hours), 0 for one-off synchronization
retries number (optional) Number of synchronization attempts if the source cannot be reached (may be 0)
interval number (optional) Time to wait (in milliseconds) before retrying a synchronization attempt after a failure
sources array Time sources
sources[#] string (a time source entry)

Methods

The following methods are provided by the TimeSync plugin:

TimeSync interface methods:

Method Description
synchronize Synchronizes time

synchronize method

Synchronizes time.

Description

Use this method to synchronize the system time with the currently configured time source. If automatic time synchronization is initially disabled or stopped, it will be restarted.

Parameters

This method takes no parameters.

Result

Name Type Description
result null Always null

Errors

Code Message Description
12 ERROR_INPROGRESS Returned when the method is called while previously triggered synchronization is in progress.
23 ERROR_INCOMPLETE_CONFIG Returned when the source configuration is missing or invalid.

Example

Request

{
    "jsonrpc": "2.0",
    "id": 1234567890,
    "method": "TimeSync.1.synchronize"
}

Response

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

Properties

The following properties are provided by the TimeSync plugin:

TimeSync interface properties:

Property Description
synctime RO Most recent synchronized time
time Current system time

synctime property

Provides access to the most recent synchronized time.

This property is read-only.

Value

Name Type Description
(property) object Most recent synchronized time
(property).time string Synchronized time (in ISO8601 format); empty string if the time has never been synchronized
(property)?.source string (optional) The synchronization source e.g. an NTP server

Example

Get Request

{
    "jsonrpc": "2.0",
    "id": 1234567890,
    "method": "TimeSync.1.synctime"
}

Get Response

{
    "jsonrpc": "2.0",
    "id": 1234567890,
    "result": {
        "time": "2019-05-07T07:20:26Z",
        "source": "ntp://example.com"
    }
}

time property

Provides access to the current system time.

Description

Upon setting this property automatic time synchronization will be stopped. If not already active, the framework's time subsystem will become activated. If the property is set empty then the time subsystem will still become activated but without setting the time (thereby notifying the framework that the time has been set externally).

Value

Name Type Description
(property) string System time (in ISO8601 format)

Errors

Code Message Description
30 ERROR_BAD_REQUEST The time is invalid

Example

Get Request

{
    "jsonrpc": "2.0",
    "id": 1234567890,
    "method": "TimeSync.1.time"
}

Get Response

{
    "jsonrpc": "2.0",
    "id": 1234567890,
    "result": "2019-05-07T07:20:26Z"
}

Set Request

{
    "jsonrpc": "2.0",
    "id": 1234567890,
    "method": "TimeSync.1.time",
    "params": "2019-05-07T07:20:26Z"
}

Set Response

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

Notifications

Notifications are autonomous events, triggered by the internals of the plugin, 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 TimeSync plugin:

TimeSync interface events:

Event Description
timechange Signals a time change

timechange event

Signals a time change.

Parameters

This event carries no parameters.

Example

{
    "jsonrpc": "2.0",
    "method": "client.events.1.timechange"
}