From 84adefa331c4159d432d22840663c38f155cd4c1 Mon Sep 17 00:00:00 2001 From: Erlang/OTP Date: Fri, 20 Nov 2009 14:54:40 +0000 Subject: The R13B03 release. --- .../src/CosNotifyChannelAdmin_SupplierAdmin.xml | 195 +++++++++++++++++++++ 1 file changed, 195 insertions(+) create mode 100644 lib/cosNotification/doc/src/CosNotifyChannelAdmin_SupplierAdmin.xml (limited to 'lib/cosNotification/doc/src/CosNotifyChannelAdmin_SupplierAdmin.xml') diff --git a/lib/cosNotification/doc/src/CosNotifyChannelAdmin_SupplierAdmin.xml b/lib/cosNotification/doc/src/CosNotifyChannelAdmin_SupplierAdmin.xml new file mode 100644 index 0000000000..0f262accb8 --- /dev/null +++ b/lib/cosNotification/doc/src/CosNotifyChannelAdmin_SupplierAdmin.xml @@ -0,0 +1,195 @@ + + + + +
+ + 2000 + 2007 + 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_­SupplierAdmin + ..._SupplierAdmin + Niclas Eklund + Niclas Eklund + + 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.

+ + + + + + -- cgit v1.2.3