2000 2013 Ericsson AB, All Rights Reserved The contents of this file are subject to the Erlang Public License, Version 1.1, (the "License"); you may not use this file except in compliance with the License. You should have received a copy of the Erlang Public License along with this software. If not, it can be retrieved online at http://www.erlang.org/. Software distributed under the License is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the specific language governing rights and limitations under the License. The Initial Developer of the Original Code is Ericsson AB. CosNotifyChannelAdmin_ConsumerAdmin 2000-02-01 1.0
CosNotifyChannelAdmin_ConsumerAdmin This module implements the OMG CosNotifyChannelAdmin::ConsumerAdmin interface.

To get access to the record definitions for the structures use:

-include_lib("cosNotification/include/*.hrl").

This module also exports the functions described in:

CosNotification_QoSAdmin

CosNotifyComm_NotifySubscribe

CosNotifyFilter_FilterAdmin

 _get_MyID(ConsumerAdmin) -> AdminID Return the target object's Id ConsumerAdmin = #objref AdminID = long()

The ID returned by the creating channel is equal to the value encapsulated by this readonly attribute.

 _get_MyChannel(ConsumerAdmin) -> Channel Return the ancestor channel ConsumerAdmin = #objref Channel = #objref

The creating channel's reference is maintained by this readonly attribute.

 _get_MyOperator(ConsumerAdmin) -> OpType Return the filtering schema used by the target object ConsumerAdmin = #objref OpType = 'AND_OP' | 'OR_OP'

When ConsumerAdmin's are created an operation type, i.e., 'AND_OP' or 'OR_OP', is supplied, which determines the semantics used by the target object concerning evaluation against any associated Filter objects.

 _get_priority_filter(ConsumerAdmin) -> MappingFilter Return the associated priority MappingFilter ConsumerAdmin = MappingFilter = #objref

If set, this operation returns the associated priority MappingFilter, otherwise a NIL object reference is returned.

 _set_priority_filter(ConsumerAdmin, MappingFilter) -> ok Set the priority MappingFilter ConsumerAdmin = MappingFilter = #objref

To associate a priority MappingFilter with the target object this operation must be used.

 _get_lifetime_filter(ConsumerAdmin) -> MappingFilter Return the associated lifetime MappingFilter ConsumerAdmin = MappingFilter = #objref

Unless a lifetime MappingFilter have been associated with the target object a NIL object reference is returned by this operation.

 _set_lifetime_filter(ConsumerAdmin, MappingFilter) -> ok Set the lifetime MappingFilter ConsumerAdmin = MappingFilter = #objref

This operation associate a lifetime MappingFilter with the target object.

 _get_pull_suppliers(ConsumerAdmin) -> ProxyIDSeq Return a list of all associated pull supplier Id:s ConsumerAdmin = #objref ProxyIDSeq = [ProxyID] ProxyID = long()

This readonly attribute maintains the Id's for all PullProxies created by the target object and still alive.

 _get_push_suppliers(ConsumerAdmin) -> ProxyIDSeq Return a list of all associated push supplier Id:s ConsumerAdmin = #objref ProxyIDSeq = [ProxyID] ProxyID = long()

This attribute is similar to the _get_pull_suppliers attribute but maintains the Id's for all PushProxies created by the target object and still alive.

 get_proxy_supplier(ConsumerAdmin, ProxyID) -> Reply Return the proxy supplier with matching Id ConsumerAdmin = #objref ProxyID = long() Reply = Proxy | {'EXCEPTION', #'CosNotifyChannelAdmin_ProxyNotFound'{}} Proxy = #objref

If a proxy with the given Id exists the reference to the object is returned, but if the object have terminated, or an incorrect Id is supplied, an exception is raised.

 obtain_notification_pull_supplier(ConsumerAdmin, ConsumerType) -> Reply Create a supplier proxy ConsumerAdmin = #objref ConsumerType = 'ANY_EVENT' | 'STRUCTURED_EVENT' | 'SEQUENCE_EVENT' Reply = {Proxy, ProxyID} Proxy = #objref ProxyID = long()

Determined by the parameter ConsumerType, a proxy which will accept events of the defined type is created. Along with the object reference an Id is returned.

obtain_pull_supplier(ConsumerAdmin) -> Proxy Create a supplier proxy ConsumerAdmin = #objref Proxy = #objref

This operation creates a new proxy which accepts #any{} events.

 obtain_notification_push_supplier(ConsumerAdmin, ConsumerType) -> Reply Create a supplier proxy ConsumerAdmin = #objref ConsumerType = 'ANY_EVENT' | 'STRUCTURED_EVENT' | 'SEQUENCE_EVENT' Reply = {Proxy, ProxyID} Proxy = #objref ProxyID = long()

A proxy which accepts events of the type described by the parameter ConsumerType is created by this operation. A unique Id is returned as an out parameter.

 obtain_push_supplier(ConsumerAdmin) -> Proxy Create a supplier proxy ConsumerAdmin = #objref Proxy = #objref

The object created by this function is a proxy which accepts #any{} events.

 destroy(ConsumerAdmin) -> ok Terminate the target object and all its children ConsumerAdmin = #objref

To terminate the target object this operation should be used. The associated Channel will be notified.