|
Raritan PX2/PX3 JSON-RPC API
|
Date and time configuration methods. More...
import"DateTime.idl";
Classes | |
| struct | Cfg |
| Device date and time configuration. More... | |
| struct | NtpCfg |
| Static NTP server configuration. More... | |
| struct | ZoneCfg |
| Time zone configuration. More... | |
| struct | ZoneInfo |
| Time zone information. More... | |
Public Types | |
| enum | Protocol { STATIC, NTP } |
| Time synchronization protocol. More... | |
Public Member Functions | |
| void | getZoneInfos (out vector< ZoneInfo > zoneInfos, in boolean useOlson) |
| List all supported time zones. More... | |
| boolean | checkNtpServer (in string ntpServer) |
| Check if a specified NTP server is usable. More... | |
| vector< string > | getActiveNtpServers () |
| Get active NTP servers. More... | |
| void | getCfg (out Cfg cfg) |
| Retrieve the device date and time configuration. More... | |
| int | setCfg (in Cfg cfg) |
| Set the device date and time configuration. More... | |
| void | getTime (in boolean useOlson, out ZoneInfo zone, out boolean dstEnabled, out int utcOffset, out time currentTime) |
| Retrieve the current device date and time. More... | |
Public Attributes | |
| valueobject | ConfigurationChangedEvent: idl::Event { } |
| Event that is send when the configuration changes. | |
Date and time configuration methods.
| boolean datetime::DateTime_3_0_2::checkNtpServer | ( | in string | ntpServer | ) |
Check if a specified NTP server is usable.
| ntpServer | NTP server to be checked |
true if the NTP server is usable | vector<string> datetime::DateTime_3_0_2::getActiveNtpServers | ( | ) |
Get active NTP servers.
| void datetime::DateTime_3_0_2::getCfg | ( | out Cfg | cfg | ) |
Retrieve the device date and time configuration.
| cfg | Result: Current date and time configration |
| void datetime::DateTime_3_0_2::getTime | ( | in boolean | useOlson, |
| out ZoneInfo | zone, | ||
| out boolean | dstEnabled, | ||
| out int | utcOffset, | ||
| out time | currentTime | ||
| ) |
Retrieve the current device date and time.
| useOlson | Use Olson zoneinfo name |
| zone | Result: Active time zone |
| dstEnabled | if false, the time zone DST flag is not used |
| utcOffset | Result: Offset (in minutes) between local time and UTC |
| currentTime | Result: Device date and time |
| void datetime::DateTime_3_0_2::getZoneInfos | ( | out vector< ZoneInfo > | zoneInfos, |
| in boolean | useOlson | ||
| ) |
List all supported time zones.
| zoneInfos | Result: List of time zones |
| useOlson | Use Olson zoneinfo names |
| int datetime::DateTime_3_0_2::setCfg | ( | in Cfg | cfg | ) |
Set the device date and time configuration.
Depending on the value of the protocol field either deviceTime or ntpCfg will be used from the cfg parameter.
| cfg | New date and time configuration. |
1.8.14