2000 2013 Ericsson AB, All Rights Reserved Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. The Initial Developer of the Original Code is Ericsson AB. CosNotifyChannelAdmin_SupplierAdmin Niclas Eklund 2000-02-01 1.0
CosNotifyChannelAdmin_SupplierAdmin This module implements the OMG CosNotifyChannelAdmin::SupplierAdmin 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_NotifyPublish

CosNotifyFilter_FilterAdmin

 _get_MyID(SupplierAdmin) -> AdminID Return the objects Id SupplierAdmin = #objref AdminID = long()

When a SupplierAdmin object is created it is given a unique Id by the creating channel. This readonly attribute maintains this Id.

 _get_MyChannel(SupplierAdmin) -> Channel Return the objects associated channel SupplierAdmin = #objref Channel = #objref

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

 _get_MyOperator(SupplierAdmin) -> OpType Return the filter scheme SupplierAdmin = #objref OpType = 'AND_OP' | 'OR_OP'

The Operation Type, which determines the semantics the target object will use for any associated Filters, is maintained by this readonly attribute.

 _get_pull_consumers(SupplierAdmin) -> ProxyIDSeq Return all associated pull consumers Id:s SupplierAdmin = #objref ProxyIDSeq = [ProxyID] ProxyID = long()

A sequence of all associated PullProxy Id's is maintained by this readonly attribute.

 _get_push_consumers(SupplierAdmin) -> ProxyIDSeq Return all associated push consumers Id:s SupplierAdmin = #objref ProxyIDSeq = [ProxyID] ProxyID = long()

This operation returns all PushProxy Id's created by the target object.

 get_proxy_consumer(SupplierAdmin, ProxyID) -> Reply Return the Proxy which corresponds to the given Id SupplierAdmin = #objref ProxyID = long() Reply = Proxy | {'EXCEPTION', #'CosNotifyChannelAdmin_ProxyNotFound'{}} Proxy = #objref

The Proxy which corresponds to the given Id is returned by this operation.

 obtain_notification_pull_consumer(SupplierAdmin, SupplierType) -> Reply Create a new proxy SupplierAdmin = #objref SupplierType = 'ANY_EVENT' | 'STRUCTURED_EVENT' | 'SEQUENCE_EVENT' Reply = {Proxy, ProxyID} Proxy = #objref ProxyID = long()

This operation creates a new proxy and returns its object reference along with its ID. The SupplierType parameter determines the event type accepted by the proxy.

 obtain_pull_consumer(SupplierAdmin) -> Proxy Create a new proxy SupplierAdmin = #objref Proxy = #objref

A proxy which accepts #any{} events is created by this operation.

 obtain_notification_push_consumer(SupplierAdmin, SupplierType) -> Reply Create a new proxy SupplierAdmin = #objref SupplierType = 'ANY_EVENT' | 'STRUCTURED_EVENT' | 'SEQUENCE_EVENT' Reply = {Proxy, ProxyID} Proxy = #objref ProxyID = long()

Determined by the SupplierType parameter a compliant proxy is created and its object reference along with its Id is returned by this operation.

 obtain_push_consumer(SupplierAdmin) -> Proxy Create a new proxy SupplierAdmin = #objref Proxy = #objref

A proxy which accepts #any{} events is created by this operation.

 destroy(SupplierAdmin) -> ok Terminate the target object SupplierAdmin = #objref

This operation terminates the SupplierAdmin object and notifies the creating channel that the target object no longer is active.