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__