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_StructuredProxyPullConsumer(3erl)      Erlang Module Definition	   CosNotifyChannelAdmin_StructuredProxyPullConsumer(3erl)

NAME

       CosNotifyChannelAdmin_StructuredProxyPullConsumer  -  This  module  implements  the OMG	CosNotifyChannelAdmin::StructuredProxyPullConsumer
       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_NotifyPublish

	 * CosNotification_QoSAdmin

	 * CosNotifyFilter_FilterAdmin

	 * CosNotifyChannelAdmin_ProxyConsumer

EXPORTS

       connect_structured_pull_supplier(StructuredProxyPullConsumer, PullSupplier) -> Reply

	      Types  StructuredProxyPullConsumer = #objref
		     PullSupplier = #objref
		     Reply = ok | {'EXCEPTION', #'CosEventChannelAdmin_AlreadyConnected'{}} | {'EXCEPTION', #'CosEventChannelAdmin_TypeError'{}}

	      This operation connects a PullSupplier to the target object. If a connection already exists or the given client object does not sup-
	      port the functions pull_structured_event and try_pull_structured_event an exception is raised.

       suspend_connection(StructuredProxyPullConsumer) -> Reply

	      Types  StructuredProxyPullConsumer = #objref
		     Reply = ok | {'EXCEPTION', #'CosNotifyChannelAdmin_ConnectionAlreadyInactive'{}} | {'EXCEPTION', #'CosNotifyChannelAdmin_Not-
		     Connected'{}}

	      This operation suspends the connection between the target object and its client. If no connection exists	or  already  suspended	an
	      exception is raised.

       resume_connection(StructuredProxyPullConsumer) -> Reply

	      Types  StructuredProxyPullConsumer = #objref
		     Reply = ok | {'EXCEPTION', #'CosNotifyChannelAdmin_ConnectionAlreadyInactive'{}} | {'EXCEPTION', #'CosNotifyChannelAdmin_Not-
		     Connected'{}}

	      If the connection have been suspended this operation must be used if we want to resume the connection. If the connection already are
	      active or no connection have been created an exception is raised.

       disconnect_structured_pull_consumer(StructuredProxyPullConsumer) -> ok

	      Types  StructuredProxyPullConsumer = #objref

	      This operation cause the target object to close the connection and terminate.

Ericsson AB						      cosNotification 1.1.16	   CosNotifyChannelAdmin_StructuredProxyPullConsumer(3erl)
Man Page