Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

cosnotification_qosadmin(3erl) [linux man page]

CosNotification_QoSAdmin(3erl)				     Erlang Module Definition				    CosNotification_QoSAdmin(3erl)

NAME

       CosNotification_QoSAdmin - This module implements the OMG  CosNotification::QoSAdmin interface.

DESCRIPTION

       To get access to the record definitions for the structures use:
       -include_lib("cosNotification/include/*.hrl").

       All objects, which inherit this interface, export functions described in this module.

EXPORTS

       get_qos(Object) -> Reply

	      Types  Object = #objref
		     Reply = [QoSProperty]
		     QoSProperty = #'CosNotification_Property'{name, value}
		     name = string()
		     value = #any

	      This operation returns a list of name-value pairs which encapsulates the current QoS settings for the target object.

       set_qos(Object, QoS) -> Reply

	      Types  Object = #objref
		     QoS = [QoSProperty]
		     QoSProperty = #'CosNotification_Property'{name, value}
		     name = string()
		     value = #any
		     Reply = ok | {'EXCEPTION', #'CosNotification_UnsupportedQoS'{qos_err}}
		     qos_err = PropertyErrorSeq
		     PropertyErrorSeq = [PropertyError]
		     PropertyError = #'CosNotification_PropertyError'{code, name, available_range}
		     code  =  'UNSUPPORTED_PROPERTY'  |  'UNAVAILABLE_PROPERTY'  |  'UNSUPPORTED_VALUE'  |  'UNAVAILABLE_VALUE' | 'BAD_PROPERTY' |
		     'BAD_TYPE' | 'BAD_VALUE'
		     name = string()
		     available_range = PropertyRange
		     PropertyRange = #CosNotification_PropertyRange{low_val, high_val}
		     low_val = high_val = #any

	      To alter the current QoS settings for the target object this function must be used. If it is not possible to set the  requested  QoS
	      the  UnsupportedQoS  exception is raised, which includes a sequence of PropertyError 's describing which QoS, possible range and why
	      is not allowed.

       validate_qos(Object, QoS) -> Reply

	      Types  Object = #objref
		     QoS = [QoSProperty]
		     QoSProperty = #'Property'{name, value}
		     name = string()
		     value = #any
		     Reply = {ok, NamedPropertyRangeSeq} | {'EXCEPTION', CosNotification_UnsupportedQoS{}}
		     NamedPropertyRangeSeq = [NamedPropertyRange]
		     NamedPropertyRange = #CosNotification_NamedPropertyRange{name, range}
		     name = string()
		     range = #CosNotification_PropertyRange{low_val, high_val}
		     low_val = #any
		     high_val = #any

	      The purpose of this operations is to check if a QoS setting is supported by the target object and if so, the operation returns addi-
	      tional properties which could be optionally added as well.

Ericsson AB						      cosNotification 1.1.16				    CosNotification_QoSAdmin(3erl)

Check Out this Related Man Page

CosNotifyChannelAdmin_ProxyPullSupplier(3erl)		     Erlang Module Definition		     CosNotifyChannelAdmin_ProxyPullSupplier(3erl)

NAME

       CosNotifyChannelAdmin_ProxyPullSupplier - This module implements the OMG  CosNotifyChannelAdmin::ProxyPullSupplier interface.

DESCRIPTION

       To get access to the record definitions for the structures use:
       -include_lib("cosNotification/include/*.hrl").

       This module also exports the functions described in:

	 * CosNotifyComm_NotifySubscribe

	 * CosNotification_QoSAdmin

	 * CosNotifyFilter_FilterAdmin

	 * CosNotifyChannelAdmin_ProxySupplier

EXPORTS

       connect_any_pull_consumer(ProxyPullSupplier, PullConsumer) -> Reply

	      Types  ProxyPullSupplier = #objref
		     PullConsumer = #objref
		     Reply = ok | {'EXCEPTION', #'CosEventChannelAdmin_AlreadyConnected'{}}

	      This  operation  connects the given PullConsumer to the target object. If a connection already exists the AlreadyConnected exception
	      is raised.

       pull(ProxyPullSupplier) -> Reply

	      Types  ProxyPullSupplier = #objref
		     Reply = #any | {'EXCEPTION', #'CosEventChannelAdmin_Disconnected'{}}

	      This operation pulls next #any{} event, and blocks, if the target object have no events to forward, until an event can be delivered.
	      If no client have been connected the Disconnected exception is raised.

       try_pull(ProxyPullSupplier) -> Reply

	      Types  ProxyPullSupplier = #objref
		     Reply = {#any, HasEvent} | {'EXCEPTION', #'CosEventChannelAdmin_Disconnected'{}}
		     HasEvent = boolean()

	      This  operation  pulls  next event, but do not block if the target object have no event to forward. If no client have been connected
	      the Disconnected exception is raised.

       disconnect_pull_supplier(ProxyPullSupplier) -> ok

	      Types  ProxyPullSupplier = #objref

	      Invoking this operation will cause the target object to close the connection and terminate.

Ericsson AB						      cosNotification 1.1.16		     CosNotifyChannelAdmin_ProxyPullSupplier(3erl)
Man Page