org.omg.CosNotification
Interface QoSAdminOperations
public
interface
QoSAdminOperations
The QoSAdmin interface defines operations which enable clients to get and set the
values of QoS properties. It also defines an operation that can verify whether or not a
set of requested QoS property settings can be satisfied, along with returning
information about the range of possible settings for additional QoS properties.
QoSAdmin is intended to be an abstract interface which is inherited by the Proxy,
Admin, and Event Channel interfaces defined in the CosNotifyChannelAdmin and
CosTypedNotifyChannelAmin modules. The semantics of the operations supported
by this interface are defined below.
Method Summary |
Property[] | get_qos()
The get_qos operation takes no input parameters, and returns a sequence of name-value
pairs which encapsulates the current quality of service settings for the target
object (which could be an Event Channel, Admin, or Proxy object).
|
void | set_qos(Property[] qos)
The set_qos operation takes as an input parameter a sequence of name-value pairs
which encapsulates quality of service property settings that a client is requesting that
the target object (which could be an Event Channel, Admin, or Proxy object) support
as its default quality of service. |
void | validate_qos(Property[] required_qos, NamedPropertyRangeSeqHolder available_qos)
The validate_qos operation accepts as input a sequence of QoS property name-value
pairs which specify a set of QoS settings that a client would like to know if the target
object is capable of supporting. |
The get_qos operation takes no input parameters, and returns a sequence of name-value
pairs which encapsulates the current quality of service settings for the target
object (which could be an Event Channel, Admin, or Proxy object).
Returns: Object QosProperties
The set_qos operation takes as an input parameter a sequence of name-value pairs
which encapsulates quality of service property settings that a client is requesting that
the target object (which could be an Event Channel, Admin, or Proxy object) support
as its default quality of service. If the implementation of the target object is not
capable of supporting any of the requested quality of service settings, or if any of the
requested settings would be in conflict with a QoS property defined at a higher level of
the object hierarchy with respect to QoS , the UnsupportedQoS
exception is raised. This exception contains as data a sequence of data structures, each
of which identifies the name of a QoS property in the input list whose requested setting
could not be satisfied, along with an error code and a range of settings for the property
which could be satisfied. The meanings of the error codes which might be returned are
described in Table 2-5 of CosNotification Service specification
Parameters: qos QosProperties to assign to object
Throws: org.omg.CosNotification.UnsupportedQoS
The validate_qos operation accepts as input a sequence of QoS property name-value
pairs which specify a set of QoS settings that a client would like to know if the target
object is capable of supporting. If the any of the requested settings could not be
satisfied by the target object, the operation raises the UnsupportedQoS exception.
This exception contains as data a sequence of data structures, each of which identifies
the name of a QoS property in the input list whose requested setting could not be
satisfied, along with an error code and a range of settings for the property which could
be satisfied. The meanings of the error codes which might be returned are described in
Table 2-5.
If all requested QoS property value settings could be satisfied by the target object, the
operation returns successfully (without actually setting the QoS properties on the target
object) with an output parameter that contains a sequence of PropertyRange data
structures. Each element in this sequence includes the name of a an additional QoS
property supported by the target object which could have been included on the input
list and resulted in a successful return from the operation., along with the range of
values that would have been acceptable for each such property.
Parameters: required_qos available_qos
Throws: org.omg.CosNotification.UnsupportedQoS