Raritan PX2/PX3 JSON-RPC API
Classes | Public Types | Public Member Functions | Public Attributes | List of all members
event::DataPushService Interface Reference

Data push service configuration interface. More...

import"DataPushService.idl";

Classes

struct  EntrySettings
 Data Push Entry 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. More...
 
int modifyEntry (in int entryId, in EntrySettings entrySettings)
 Modify an existing entry. More...
 
int deleteEntry (in int entryId)
 Delete an entry. More...
 
int getEntry (out EntrySettings entrySettings, in int entryId)
 Retrieve an entry. More...
 
map< int, EntrySettingslistEntries ()
 Retrieve a list of entries. More...
 
int pushData (in int entryId)
 Push data for one specified entry. More...
 

Public Attributes

constant int ERR_NO_SUCH_ID = 1
 Error codes. More...
 
constant int ERR_INVALID_PARAMS = 2
 Invalid parameters.
 
constant int ERR_MAX_ENTRIES_REACHED = 3
 Maximum number of entries reached.
 

Detailed Description

Data push service configuration interface.

Member Enumeration Documentation

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.

Member Function Documentation

int event::DataPushService::addEntry ( out int  entryId,
in EntrySettings  entrySettings 
)

Add a new entry.

Parameters
entryIdResult: New entry id, automatically assigned
entrySettingsNew Model Push Entry settings
Returns
0 if OK
2 if the settings are invalid
3 if the maximum number of entries is reached
int event::DataPushService::deleteEntry ( in int  entryId)

Delete an entry.

Parameters
entryidEntry id
Returns
0 if OK
1 if the entry does not exist
int event::DataPushService::getEntry ( out EntrySettings  entrySettings,
in int  entryId 
)

Retrieve an entry.

Parameters
entrySettingsResult: Model Push Entry settings
entryIdEntry id
Returns
0 if OK
1 if the entry does not exist
map<int, EntrySettings> event::DataPushService::listEntries ( )

Retrieve a list of entries.

Returns
List of Entry Settings
int event::DataPushService::modifyEntry ( in int  entryId,
in EntrySettings  entrySettings 
)

Modify an existing entry.

Parameters
entryIdEntry id
entrySettingsNew Model Push Entry settings
Returns
0 if OK
1 if the entry does not exist
2 if the settings are invalid
int event::DataPushService::pushData ( in int  entryId)

Push data for one specified entry.

Parameters
entryIdEntry id
Returns
0 if OK
1 if entry does not exist

Member Data Documentation

constant int event::DataPushService::ERR_NO_SUCH_ID = 1

Error codes.

No such ID


The documentation for this interface was generated from the following file: