BasePort.idl

#ifndef __RADM_BASEPORT_IDL__
#define __RADM_BASEPORT_IDL__
#include <UserEvent.idl>
module radm {
    enumeration PowerOperation {
        SWITCH_OFF,
        SWITCH_ON,
        POWER_CYCLE
    };
 
    interface BasePort {
        constant int ERR_INVALID_ARGUMENT = 1;
 
        structure Metadata {
            string label;           ///< Port label
            string privilegeArg;    ///< Privilege argument used during authorization
            string uid;             ///< Unique port ID
            int idx;                ///< Index of this port in the respective port list
        };
 
        /**
         * Get port meta data
         *
         * @return Meta data of this port
         */
        Metadata getMetadata();
 
        /**
         * Get port name
         *
         * @return Name of this port
         */
        string getName();
 
        /**
         * Set port name
         *
         * @param name New port name
         *
         * @return 0 on success
         * @return 1 if given name was invalid
         */
        int setName(in string name);
 
        /** Event: Port name has changed */
        valueobject NameChangedEvent extends event.UserEvent {
            string oldName;     ///< Port name before change
            string newName;     ///< Port name after change
        };
 
    };
}
 
#endif //__RADM_BASEPORT_IDL__