PortGroupManager.idl

#ifndef __RADMPORTGROUPMANAGER_IDL__
#define __RADMPORTGROUPMANAGER_IDL__
 
#include <KvmPort.idl>
#include <PortGroup.idl>
#include <Device.idl>
 
module radm {
 
    interface PortGroupManager {
        constant int ERR_INVALID_ARGUMENT = 1;
        constant int ERR_NO_SUCH_ID = 2;
        constant int ERR_MAX_GROUP_COUNT_REACHED = 3;
 
        /**
         * Create a new port group
         *
         * @param settings Settings to create the new port group with
         * @param group    Output value: newly created port group
         *
         * @return 0 on success
         * @return 1 if any of the given settings is invalid
         * @return 3 if the maximum number of port groups is reached already
         */
        int createPortGroup(in PortGroup.Settings settings, out PortGroup group);
 
        /**
         * Delete an existing port group
         *
         * @param groupId ID of the group (as per it's {@link PortGroup.Metadata})
         *
         * @return 0 on success
         * @return 2 if the group ID is unknown
         */
        int deletePortGroup(in string groupId);
 
        /**
         * Get all existing port groups
         *
         * @return Map of port groups, keyed by group ID
         */
        map<string, PortGroup> getAllPortGroups();
 
        /**
         * Get a specific port group
         *
         * @param groupId ID of the group (as per its {@link PortGroup.Metadata})
         * @param group   Output value: requested port group
         *
         * @return 0 on success
         * @return 2 if the group ID is unknown
         */
        int getPortGroup(in string groupId, out PortGroup group);
 
        /** Event: The group list has changed (group was added or removed) */
        valueobject PortGroupListChangedEvent extends event.UserEvent {
            map<string, PortGroup> portGroups;      ///< New group map after change
        };
 
        /** Event: A port group was created */
        valueobject PortGroupCreatedEvent extends PortGroupListChangedEvent {
            string groupId;                 ///< ID of the created port group
            PortGroup group;                ///< Newly created port group
            PortGroup.Settings settings;    ///< Settings the new port group was created with
        };
 
        /** Event: A port group was deleted */
        valueobject PortGroupDeletedEvent extends PortGroupListChangedEvent {
            string groupId;     ///< ID of the deleted port group
        };
    };
}
 
#endif