| Legrand / Raritan / Server Technology Xerus™ JSON-RPC API
    | 
Data push service configuration interface. More...
import <DataPushService.idl;
| Classes | |
| struct | EntryAddedEvent | 
| Event: A new push destination has been added.  More... | |
| struct | EntryDeletedEvent | 
| Event: A configured push destination has been deleted.  More... | |
| struct | EntryModifiedEvent | 
| Event: A configured push destination has been modified.  More... | |
| struct | EntrySettings | 
| Data Push Entry Settings.  More... | |
| struct | EntryStatus | 
| Data Push Entry Status.  More... | |
| struct | EntryStatusChangedEvent | 
| Event: The status of a configured push destination has changed.  More... | |
| struct | MqttSettings | 
| Data Push Mqtt Settings.  More... | |
| Public Types | |
| enum | EntryType { SENSORLIST , SENSORLOG , AMSLIST , AMSLOG , AUDITLOG } | 
| Data Push Entry Types.  More... | |
| Public Member Functions | |
| int | addEntry (out int entryId, in EntrySettings entrySettings) | 
| Add a new entry. | |
| int | modifyEntry (in int entryId, in EntrySettings entrySettings) | 
| Modify an existing entry. | |
| int | deleteEntry (in int entryId) | 
| Delete an entry. | |
| int | getEntry (out EntrySettings entrySettings, in int entryId) | 
| Retrieve an entry. | |
| map< int, EntrySettings > | listEntries () | 
| Retrieve a list of entries. | |
| int | pushData (in int entryId) | 
| Push data for one specified entry. | |
| void | cancelDataPush (in int entryId) | 
| Cancels an active data push. | |
| int | getEntryStatus (out EntryStatus entryStatus, in int entryId) | 
| Retrieve an entry's status. | |
| Public Attributes | |
| constant int | ERR_NO_SUCH_ID = 1 | 
| Error codes. | |
| constant int | ERR_INVALID_PARAMS = 2 | 
| Invalid parameters. | |
| constant int | ERR_MAX_ENTRIES_REACHED = 3 | 
| Maximum number of entries reached. | |
Data push service configuration interface.
Definition at line 12 of file DataPushService.idl.
Data Push Entry Types.
| Enumerator | |
|---|---|
| SENSORLIST | Sensor values for a set of sensors. | 
| SENSORLOG | Sensor log. | 
| AMSLIST | Asset Management information for a set of AMS strips. | 
| AMSLOG | Asset Management log. | 
| AUDITLOG | Audit log. | 
Definition at line 17 of file DataPushService.idl.
| int event::DataPushService::addEntry | ( | out int | entryId, | 
| in EntrySettings | entrySettings ) | 
Add a new entry.
| entryId | Result: New entry id, automatically assigned | 
| entrySettings | New Model Push Entry settings | 
| void event::DataPushService::cancelDataPush | ( | in int | entryId | ) | 
Cancels an active data push.
If a data push is currently in process for the specified entry, that push is canceled. If no push is in process, this method is a no-op.
| entryId | Entry id | 
| int event::DataPushService::deleteEntry | ( | in int | entryId | ) | 
Delete an entry.
| entryid | Entry id | 
| int event::DataPushService::getEntry | ( | out EntrySettings | entrySettings, | 
| in int | entryId ) | 
Retrieve an entry.
| entrySettings | Result: Model Push Entry settings | 
| entryId | Entry id | 
| int event::DataPushService::getEntryStatus | ( | out EntryStatus | entryStatus, | 
| in int | entryId ) | 
Retrieve an entry's status.
| entryStatus | Result: Entry status | 
| entryId | Entry id | 
| map< int, EntrySettings > event::DataPushService::listEntries | ( | ) | 
Retrieve a list of entries.
| int event::DataPushService::modifyEntry | ( | in int | entryId, | 
| in EntrySettings | entrySettings ) | 
Modify an existing entry.
| entryId | Entry id | 
| entrySettings | New Model Push Entry settings | 
| int event::DataPushService::pushData | ( | in int | entryId | ) | 
Push data for one specified entry.
| entryId | Entry id | 
| constant int event::DataPushService::ERR_INVALID_PARAMS = 2 | 
Invalid parameters.
Definition at line 27 of file DataPushService.idl.
| constant int event::DataPushService::ERR_MAX_ENTRIES_REACHED = 3 | 
Maximum number of entries reached.
Definition at line 28 of file DataPushService.idl.
| constant int event::DataPushService::ERR_NO_SUCH_ID = 1 |