PortGroup.idl

#ifndef __RADM_PORTGROUP_IDL__
#define __RADM_PORTGROUP_IDL__
 
#include <UserEvent.idl>
#include <KvmPort.idl>
 
module radm {
 
    interface PortGroup {
        constant int ERR_INVALID_ARGUMENT = 1;
 
        /** Group meta data */
        structure Metadata {
            string groupId;     ///< ID of the group
        };
 
        /** Configuration object for a plain port group */
        valueobject GroupConfig {};
 
        /** Configuration object for a multi-monitor group */
        valueobject MultiMonitorConfig extends PortGroup.GroupConfig {
            int columnCount;    ///< Number of columns in the grid fored by the multi-monitor setup
                                ///< (member ports are arranged in left-to-right, top-to-bottom order)
            int primaryIndex;   ///< Index of the port to be considered the primary monitor
        };
 
        structure Settings {
            string name;                    ///< Group name
            vector<KvmPort> members;  ///< Group members
            GroupConfig config;             ///< Configuration object (must not be empty)
        };
 
        /**
         * Get group meta data
         *
         * @return Meta data
         */
        Metadata getMetadata();
 
        /**
         * Get group settings
         *
         * @return Group settings
         */
        Settings getSettings();
 
        /**
         * Set group settings
         *
         * @param settings New group settings
         *
         * @return 0 on success
         * @return 1 if any given setting was invalid
         */
        int setSettings(in Settings settings);
 
        /** Event: Group settings have been changed */
        valueobject SettingsChangedEvent extends event.UserEvent {
            Settings oldSettings;       ///< Settings before change
            Settings newSettings;       ///< Settings after change
        };
    };
}
 
#endif