Loading...
Searching...
No Matches
DsamManager.idl
/* SPDX-License-Identifier: BSD-3-Clause */
/*
* Copyright 2022 Raritan Inc. All rights reserved.
*/
#ifndef __DSAMMANAGER_IDL__
#define __DSAMMANAGER_IDL__
#include <DsamDevice.idl>
#include <UserEvent.idl>
module dsam {
/** DSAM manager interface */
interface DsamManager {
/** Event that is send when a DSAM module has been attached */
valueobject DsamAttachedEvent extends idl.Event {
DsamDevice.Info info; ///< DSAM info
DsamDevice device; ///< DSAM device
};
/** Event that is send when a DSAM module has been removed */
valueobject DsamDetachedEvent extends idl.Event {
DsamDevice.Info info; ///< DSAM info
};
/** Event that is send when a DSAM controller has been reset or recovery is in progress */
valueobject DsamControllerChangedEvent extends idl.Event {
int dsamNumber; ///< DSAM number (1-based)
boolean reset; ///< \c true if controller was reset; \c false if recovery started
string resetReason; ///< reset reason (only set when reset is \c true)
};
/**
* Retrieve the current DSAM devices.
*
* @return Map with DSAM devices. Index is the DSAM number (1-based).
*/
map<int, DsamDevice> getDsamDevices();
/**
* Get the version of the firmware file provided with the device that will be installed on the DSAM
* either by explicit request or when the DSAM needs to be recovered.
*
* @return Firmware version
*/
DsamDevice.FirmwareVersion getFirmwareUpdateFileVersion();
};
}
#endif // __DSAMMANAGER_IDL__
dsam::DsamDevice
DSAM device interface.
Definition DsamDevice.idl:14
dsam::DsamManager
DSAM manager interface.
Definition DsamManager.idl:15
dsam::DsamManager::getFirmwareUpdateFileVersion
DsamDevice::FirmwareVersion getFirmwareUpdateFileVersion()
Get the version of the firmware file provided with the device that will be installed on the DSAM eith...
dsam::DsamManager::getDsamDevices
map< int, DsamDevice > getDsamDevices()
Retrieve the current DSAM devices.
idl
Basic IDL definitions.
Definition Event.idl:10
dsam::DsamDevice::FirmwareVersion
Firmware version.
Definition DsamDevice.idl:20
dsam::DsamDevice::Info
DSAm device info.
Definition DsamDevice.idl:26
dsam::DsamManager::DsamAttachedEvent
Event that is send when a DSAM module has been attached.
Definition DsamManager.idl:18
dsam::DsamManager::DsamAttachedEvent::info
DsamDevice::Info info
DSAM info.
Definition DsamManager.idl:19
dsam::DsamManager::DsamAttachedEvent::device
DsamDevice device
DSAM device.
Definition DsamManager.idl:20
dsam::DsamManager::DsamControllerChangedEvent
Event that is send when a DSAM controller has been reset or recovery is in progress.
Definition DsamManager.idl:29
dsam::DsamManager::DsamControllerChangedEvent::resetReason
string resetReason
reset reason (only set when reset is true)
Definition DsamManager.idl:32
dsam::DsamManager::DsamControllerChangedEvent::dsamNumber
int dsamNumber
DSAM number (1-based)
Definition DsamManager.idl:30
dsam::DsamManager::DsamControllerChangedEvent::reset
boolean reset
true if controller was reset; false if recovery started
Definition DsamManager.idl:31
dsam::DsamManager::DsamDetachedEvent
Event that is send when a DSAM module has been removed.
Definition DsamManager.idl:24
dsam::DsamManager::DsamDetachedEvent::info
DsamDevice::Info info
DSAM info.
Definition DsamManager.idl:25
idl::Event
Common base for all events.
Definition Event.idl:13