Loading...
Searching...
No Matches
RawConfiguration.idl
/* SPDX-License-Identifier: BSD-3-Clause */
/*
* Copyright 2018 Raritan Inc. All rights reserved.
*/
#include <UserEvent.idl>
/** Raw Configuration */
module rawcfg {
/** Raw Configuration Interface */
interface RawConfiguration {
/** Status of the last raw configuration update operation */
enumeration Status {
UNKNOWN, ///< No raw configuration was done yet
UPLOAD_FAILED, ///< Uploading a raw configuration failed
UPDATE_PENDING, ///< Update is pending
UPDATE_OK, ///< Updating raw configuration successful
UPDATE_FAILED ///< Updating raw configuration failed
};
/**
* Retrieve the status of the last raw configuration update
* operation.
*
* @param status Result: Raw configuration update status
* @param timeStamp Result: Time of last update operation (UNIX timestamp, UTC)
*/
void getStatus(out Status status, out time timeStamp);
/** Event: Raw configuration downloaded */
valueobject RawConfigDownloadedEvent extends event.UserEvent {};
/** Event: Raw configuration updated */
valueobject RawConfigUpdatedEvent extends event.UserEvent {};
};
}
rawcfg::RawConfiguration
Raw Configuration Interface.
Definition RawConfiguration.idl:12
rawcfg::RawConfiguration::Status
Status
Status of the last raw configuration update operation.
Definition RawConfiguration.idl:15
rawcfg::RawConfiguration::UPLOAD_FAILED
@ UPLOAD_FAILED
Uploading a raw configuration failed.
Definition RawConfiguration.idl:17
rawcfg::RawConfiguration::UPDATE_OK
@ UPDATE_OK
Updating raw configuration successful.
Definition RawConfiguration.idl:19
rawcfg::RawConfiguration::UPDATE_FAILED
@ UPDATE_FAILED
Updating raw configuration failed.
Definition RawConfiguration.idl:20
rawcfg::RawConfiguration::UNKNOWN
@ UNKNOWN
No raw configuration was done yet.
Definition RawConfiguration.idl:16
rawcfg::RawConfiguration::UPDATE_PENDING
@ UPDATE_PENDING
Update is pending.
Definition RawConfiguration.idl:18
rawcfg::RawConfiguration::getStatus
void getStatus(out Status status, out time timeStamp)
Retrieve the status of the last raw configuration update operation.
rawcfg
Raw Configuration.
Definition RawConfiguration.idl:9
rawcfg::RawConfiguration::RawConfigDownloadedEvent
Event: Raw configuration downloaded.
Definition RawConfiguration.idl:33
rawcfg::RawConfiguration::RawConfigUpdatedEvent
Event: Raw configuration updated.
Definition RawConfiguration.idl:35