diff options
Diffstat (limited to 'lib/cosEventDomain/doc/src')
21 files changed, 1902 insertions, 0 deletions
diff --git a/lib/cosEventDomain/doc/src/CosEventDomainAdmin.xml b/lib/cosEventDomain/doc/src/CosEventDomainAdmin.xml new file mode 100644 index 0000000000..d0aac961d7 --- /dev/null +++ b/lib/cosEventDomain/doc/src/CosEventDomainAdmin.xml @@ -0,0 +1,92 @@ +<?xml version="1.0" encoding="latin1" ?> +<!DOCTYPE erlref SYSTEM "erlref.dtd"> + +<erlref> + <header> + <copyright> + <year>2002</year> + <year>2007</year> + <holder>Ericsson AB, All Rights Reserved</holder> + </copyright> + <legalnotice> + 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. + </legalnotice> + + <title>CosEventDomainAdmin</title> + <prepared>Niclas Eklund</prepared> + <responsible>Niclas Eklund</responsible> + <docno></docno> + <approved>Niclas Eklund</approved> + <checked></checked> + <date>2001-08-20</date> + <rev>PA1</rev> + </header> + <module>CosEventDomainAdmin</module> + <modulesummary>This module export functions which return QoS and Admin Properties constants.</modulesummary> + <description> + <p>To get access to all definitions include necessary <c><![CDATA[hrl]]></c> files by using:<br></br><c><![CDATA[-include_lib("cosEventDomain/include/*.hrl").]]></c></p> + </description> + <funcs> + <func> + <name>'CycleDetection'() -> string()</name> + <fsummary>Return the CycleDetection identifier required when defining QoS Properties</fsummary> + <desc> + <p>This function returns the CycleDetection identifier; required when + defining QoS Properties.</p> + </desc> + </func> + <func> + <name>'AuthorizeCycles'() -> short()</name> + <fsummary>Return the AuthorizeCycles value; required when defining QoS Properties</fsummary> + <desc> + <p>This function returns the AuthorizeCycles value; required when + defining QoS Properties.</p> + </desc> + </func> + <func> + <name>'ForbidCycles'() -> short()</name> + <fsummary>Return the ForbidCycles value; required when defining QoS Properties</fsummary> + <desc> + <p>This function returns the ForbidCycles value; required when + defining QoS Properties.</p> + </desc> + </func> + <func> + <name>'DiamondDetection'() -> string()</name> + <fsummary>Return the DiamondDetection identifier required when defining QoS Properties</fsummary> + <desc> + <p>This function returns the DiamondDetection identifier; required when + defining QoS Properties.</p> + </desc> + </func> + <func> + <name>'AuthorizeDiamonds'() -> short()</name> + <fsummary>Return the AuthorizeDiamonds value; required when defining QoS Properties</fsummary> + <desc> + <p>This function returns the AuthorizeDiamonds value; required when + defining QoS Properties.</p> + </desc> + </func> + <func> + <name>'ForbidDiamonds'() -> short()</name> + <fsummary>Return the ForbidDiamonds value; required when defining QoS Properties</fsummary> + <desc> + <p>This function returns the ForbidDiamonds value; required when + defining QoS Properties.</p> + </desc> + </func> + </funcs> + +</erlref> + diff --git a/lib/cosEventDomain/doc/src/CosEventDomainAdmin_EventDomain.xml b/lib/cosEventDomain/doc/src/CosEventDomainAdmin_EventDomain.xml new file mode 100644 index 0000000000..cf1cdab966 --- /dev/null +++ b/lib/cosEventDomain/doc/src/CosEventDomainAdmin_EventDomain.xml @@ -0,0 +1,627 @@ +<?xml version="1.0" encoding="latin1" ?> +<!DOCTYPE erlref SYSTEM "erlref.dtd"> + +<erlref> + <header> + <copyright> + <year>2001</year><year>2009</year> + <holder>Ericsson AB. All Rights Reserved.</holder> + </copyright> + <legalnotice> + 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. + + </legalnotice> + + <title>CosEventDomainAdmin_­EventDomain</title> + <shorttitle>..._EventDomain</shorttitle> + <prepared></prepared> + <docno></docno> + <approved>Niclas Eklund</approved> + <checked></checked> + <date>2001-08-20</date> + <rev>PA1</rev> + </header> + <module>CosEventDomainAdmin_EventDomain</module> + <modulesummary>This module implements the Event Domain interface.</modulesummary> + <description> + <p>To get access to all definitions include necessary <c><![CDATA[hrl]]></c> files by using:<br></br><c><![CDATA[-include_lib("cosEventDomain/include/*.hrl").]]></c></p> + <p>This module also exports the functions described in:</p> + <list type="bulleted"> + <item><em>CosNotification_QoSAdmin</em></item> + <item><em>CosNotification_AdminPropertiesAdmin</em></item> + </list> + </description> + <funcs> + <func> + <name>add_channel(EventDomain, Channel) -> MemberID</name> + <fsummary>Add a new channel to the EventDomain</fsummary> + <type> + <v>EventDomain = Channel = #objref</v> + <v>MemberID = long()</v> + </type> + <desc> + <p>Adds the given channel to the target domain. The channel + must be a <c><![CDATA[CosNotifyChannelAdmin::EventChannel]]></c>.</p> + </desc> + </func> + <func> + <name>get_all_channels(EventDomain) -> MemberIDSeq</name> + <fsummary>Return all channel id's associated with target object</fsummary> + <type> + <v>EventDomain = #objref</v> + <v>MemberIDSeq = [long()]</v> + </type> + <desc> + <p>Returns a a sequence of all channels associated with + the target object.</p> + </desc> + </func> + <func> + <name>get_channel(EventDomain, MemberID) -> Reply</name> + <fsummary>Return the channel associated with the given id</fsummary> + <type> + <v>EventDomain = #objref</v> + <v>MemberID = long()</v> + <v>Reply = Channel | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}</v> + <v>Channel = #objref</v> + </type> + <desc> + <p>If the target domain have a <c><![CDATA[CosNotifyChannelAdmin::EventChannel]]></c> + represented by the given id this channel is returned. Otherwise, + an exception is raised.</p> + </desc> + </func> + <func> + <name>remove_channel(EventDomain, MemberID) -> Reply</name> + <fsummary>Remove the channel associated with the given id and remove all connections of that channel</fsummary> + <type> + <v>EventDomain = #objref</v> + <v>MemberID = long()</v> + <v>Reply = ok | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}</v> + </type> + <desc> + <p>If a <c><![CDATA[CosNotifyChannelAdmin::EventChannel]]></c> with the + <c><![CDATA[MemberID]]></c> exists it will removed and all its <c><![CDATA[Connections]]></c> + terminated. Otherwise an exception is raised.</p> + </desc> + </func> + <func> + <name>add_connection(EventDomain, Connection) -> Reply</name> + <fsummary>If possible, setup a connection described by the <c><![CDATA[#'CosEventDomainAdmin_Connection'{}]]></c>struct</fsummary> + <type> + <v>EventDomain = #objref</v> + <v>Connection = 'CosEventDomainAdmin_Connection'{supplier_id=MemberID, consumer_id=MemberID, ctype=Type, notification_style=Style}</v> + <v>MemberID = long()</v> + <v>Type = 'ANY_EVENT' | 'STRUCTURED_EVENT' | 'SEQUENCE_EVENT'</v> + <v>Style = 'Pull' | 'Push'</v> + <v>Reply = ConnectionID | {'EXCEPTION', Exc}</v> + <v>ConnectionID = long()</v> + <v>Exc = #'CosNotifyChannelAdmin_ChannelNotFound'{} | #'CosNotifyChannelAdmin_TypeError'{} | #'CosEventDomainAdmin_AlreadyExists'{} | #'CosEventDomainAdmin_DiamondCreationForbidden'{diam=RouteSeq} | #'CosEventDomainAdmin_CycleCreationForbidden'{cyc=MemberIDSeq}</v> + <v>RouteSeq = [MemberIDSeq]</v> + <v>MemberIDSeq = [long()]</v> + </type> + <desc> + <p>The Connection parameter must contain valid data to enable + the target domain to setup a connection between two channels. + The struct members <c><![CDATA[supplier_id]]></c> and <c><![CDATA[consumer_id]]></c> + determines which channel should produce and consume events. + which type of events and if the supplier should push or the + consumer pull events is determined by <c><![CDATA[ctype]]></c> and + <c><![CDATA[notification_style]]></c> respectively.</p> + <p>If the target domain is not able to setup the connection + the appropriate exception is raised.</p> + </desc> + </func> + <func> + <name>get_all_connections(EventDomain) -> ConnectionIDSeq</name> + <fsummary>Return a sequence of all connections within the target domain</fsummary> + <type> + <v>EventDomain = #objref</v> + <v>ConnectionIDSeq = [long()]</v> + </type> + <desc> + <p>This operation returns a sequence of all connections within + the target domain.</p> + </desc> + </func> + <func> + <name>get_connection(EventDomain, ConnectionID) -> Reply</name> + <fsummary>Return a <c><![CDATA[#'CosEventDomainAdmin_Connection'{}]]></c>struct describing the connection associated with the given id within the target domain</fsummary> + <type> + <v>EventDomain = #objref</v> + <v>ConnectionID = long()</v> + <v>Reply = Connection | {'EXCEPTION', #'CosEventDomainAdmin_ConnectionNotFound'{}}</v> + <v>Connection = 'CosEventDomainAdmin_Connection'{supplier_id=MemberID, consumer_id=MemberID, ctype=Type, notification_style=Style}</v> + <v>MemberID = long()</v> + <v>Type = 'ANY_EVENT' | 'STRUCTURED_EVENT' | 'SEQUENCE_EVENT'</v> + <v>Style = 'Pull' | 'Push'</v> + </type> + <desc> + <p>If a connection identified by the given id exists within the + target domain, a <c><![CDATA[#'CosEventDomainAdmin_Connection'{}]]></c> which + describe the connection is returned. Otherwise, an exception + is raised.</p> + </desc> + </func> + <func> + <name>remove_connection(EventDomain, ConnectionID) -> Reply</name> + <fsummary>Remove the connection identified by the given id from the target domain</fsummary> + <type> + <v>EventDomain = #objref</v> + <v>ConnectionID = long()</v> + <v>Reply = ok | {'EXCEPTION', #'CosEventDomainAdmin_ConnectionNotFound'{}}</v> + </type> + <desc> + <p>If the supplied connection id exists, the connection the + id represents is terminated. Otherwise, an exception is raised.</p> + </desc> + </func> + <func> + <name>get_offer_channels(EventDomain, MemberID) -> Reply</name> + <fsummary>Return all id's of the channels which produce events received by the channel identified by the given id</fsummary> + <type> + <v>EventDomain = #objref</v> + <v>MemberID = long()</v> + <v>Reply = MemberIDSeq | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}</v> + </type> + <desc> + <p>This operation returns a sequence, containing the member id's + of all channels within the target domain which will supply events + to the channel identified by the given id. But, if no such + id exists in this domain, an exception is raised.</p> + </desc> + </func> + <func> + <name>get_subscription_channels(EventDomain, MemberID) -> Reply</name> + <fsummary>Return all id's of the channels which consume events supplied by the channel identified by the given id</fsummary> + <type> + <v>EventDomain = #objref</v> + <v>Reply = MemberIDSeq | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}</v> + </type> + <desc> + <p>This operations behaves like <c><![CDATA[get_subscription_channels]]></c>; + the difference is that the id's returned identifies channels + which will consume events supplied by the channel associated + with the given id.</p> + </desc> + </func> + <func> + <name>destroy(EventDomain) -> ok</name> + <fsummary>Destroy the event domain and all connections within it</fsummary> + <type> + <v>EventDomain = #objref</v> + </type> + <desc> + <p>Calling this operation will terminate all connections + within the target domain. The domain will terminate but + all channels will not be affected.</p> + </desc> + </func> + <func> + <name>get_cycles(EventDomain) -> RouteSeq</name> + <fsummary>Return a list of all cycles which exists within the target domain</fsummary> + <type> + <v>EventDomain = #objref</v> + <v>RouteSeq = [MemberIDSeq]</v> + <v>MemberIDSeq = [long()]</v> + </type> + <desc> + <p>Returns a list of all cycles within the target domain.</p> + </desc> + </func> + <func> + <name>get_diamonds(EventDomain) -> DiamondSeq</name> + <fsummary>Return a list of all diamonds which exists within the target domain</fsummary> + <type> + <v>EventDomain = #objref</v> + <v>DiamondSeq = [RouteSeq]</v> + <v>RouteSeq = [MemberIDSeq]</v> + <v>MemberIDSeq = [long()]</v> + </type> + <desc> + <p>Returns a list of all diamonds within the target domain</p> + </desc> + </func> + <func> + <name>set_default_consumer_channel(EventDomain, MemberID) -> Reply</name> + <fsummary>Set the channel represented by the given id as default for supplier clients</fsummary> + <type> + <v>EventDomain = #objref</v> + <v>Reply = MemberID | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}</v> + <v>MemberID = long()</v> + </type> + <desc> + <p>If the given id represents a channel within the target domain, + this channel will be used when connection a supplier client + without specifying a certain channel. If no such channel exists + an exceptions is raised.</p> + </desc> + </func> + <func> + <name>set_default_supplier_channel(EventDomain, MemberID) -> Reply</name> + <fsummary>Set the channel represented by the given id as default for supplier clients</fsummary> + <type> + <v>EventDomain = #objref</v> + <v>Reply = MemberID | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}</v> + <v>MemberID = long()</v> + </type> + <desc> + <p>If the given id represents a channel within the target domain, + this channel will be used when connection a consumer client + without specifying a certain channel. If no such channel exists + an exceptions is raised.</p> + </desc> + </func> + <func> + <name>connect_push_consumer(EventDomain, Consumer) -> Reply</name> + <fsummary>Connect the PushConsumer to the default Channel</fsummary> + <type> + <v>EventDomain = #objref</v> + <v>Consumer = CosEventComm::PushConsumer</v> + <v>Reply = CosNotifyChannelAdmin::ProxyPushSupplier | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}</v> + </type> + <desc> + <p>If a default Channel have been set, this operation connects the given + PushConsumer to it. Otherwise, the + <c><![CDATA[#'CosNotifyChannelAdmin_ChannelNotFound'{}]]></c> exception is raised.</p> + </desc> + </func> + <func> + <name>connect_pull_consumer(EventDomain, Consumer) -> Reply</name> + <fsummary>Connect the PullConsumer to the default Channel</fsummary> + <type> + <v>EventDomain = #objref</v> + <v>Consumer = CosEventComm::PullConsumer</v> + <v>Reply = CosNotifyChannelAdmin::ProxyPullSupplier | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}</v> + </type> + <desc> + <p>If a default Channel have been set, this operation connects the given + PullConsumer to it. Otherwise, the + <c><![CDATA[#'CosNotifyChannelAdmin_ChannelNotFound'{}]]></c> exception is raised.</p> + </desc> + </func> + <func> + <name>connect_push_supplier(EventDomain, Supplier) -> Reply</name> + <fsummary>Connect the PushSupplier to the default Channel</fsummary> + <type> + <v>EventDomain = #objref</v> + <v>Supplier = CosEventComm::PushSupplier</v> + <v>Reply = CosNotifyChannelAdmin::ProxyPushConsumer | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}</v> + </type> + <desc> + <p>If a default Channel have been set, this operation connects the given + PushSupplier to it. Otherwise, the + <c><![CDATA[#'CosNotifyChannelAdmin_ChannelNotFound'{}]]></c> exception is raised.</p> + </desc> + </func> + <func> + <name>connect_pull_supplier(EventDomain, Supplier) -> Reply</name> + <fsummary>Connect the PullSupplier to the default Channel</fsummary> + <type> + <v>EventDomain = #objref</v> + <v>Supplier = CosEventComm::PullSupplier</v> + <v>Reply = CosNotifyChannelAdmin::ProxyPushConsumer | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}</v> + </type> + <desc> + <p>If a default Channel have been set, this operation connects the given + PullSupplier to it. Otherwise, the + <c><![CDATA[#'CosNotifyChannelAdmin_ChannelNotFound'{}]]></c> exception is raised.</p> + </desc> + </func> + <func> + <name>connect_structured_push_consumer(EventDomain, Consumer) -> Reply</name> + <fsummary>Connect the StructuredPushConsumer to the default Channel</fsummary> + <type> + <v>EventDomain = #objref</v> + <v>Consumer = CosNotifyComm::StructuredPushConsumer</v> + <v>Reply = CosNotifyChannelAdmin::StructuredProxyPushSupplier | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}</v> + </type> + <desc> + <p>If a default Channel have been set, this operation connects the given + StructuredPushConsumer to it. Otherwise, the + <c><![CDATA[#'CosNotifyChannelAdmin_ChannelNotFound'{}]]></c> exception is raised.</p> + </desc> + </func> + <func> + <name>connect_structured_pull_consumer(EventDomain, Consumer) -> Reply</name> + <fsummary>Connect the StructuredPullConsumer to the default Channel</fsummary> + <type> + <v>EventDomain = #objref</v> + <v>Consumer = CosNotifyComm::StructuredPullConsumer</v> + <v>Reply = CosNotifyChannelAdmin::StructuredProxyPullSupplier | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}</v> + </type> + <desc> + <p>If a default Channel have been set, this operation connects the given + StructuredPullConsumer to it. Otherwise, the + <c><![CDATA[#'CosNotifyChannelAdmin_ChannelNotFound'{}]]></c> exception is raised.</p> + </desc> + </func> + <func> + <name>connect_structured_push_supplier(EventDomain, Supplier) -> Reply</name> + <fsummary>Connect the StructuredPushSupplier to the default Channel</fsummary> + <type> + <v>EventDomain = #objref</v> + <v>Supplier = CosNotifyComm::StructuredPushSupplier</v> + <v>Reply = CosNotifyChannelAdmin::StructuredProxyPushConsumer | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}</v> + </type> + <desc> + <p>If a default Channel have been set, this operation connects the given + StructuredPushSupplier to it. Otherwise, the + <c><![CDATA[#'CosNotifyChannelAdmin_ChannelNotFound'{}]]></c> exception is raised.</p> + </desc> + </func> + <func> + <name>connect_structured_pull_supplier(EventDomain, Supplier) -> Reply</name> + <fsummary>Connect the StructuredPullSupplier to the default Channel</fsummary> + <type> + <v>EventDomain = #objref</v> + <v>Supplier = CosNotifyComm::StructuredPullSupplier</v> + <v>Reply = CosNotifyChannelAdmin::StructuredProxyPullConsume | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}</v> + </type> + <desc> + <p>If a default Channel have been set, this operation connects the given + StructuredPullSupplier to it. Otherwise, the + <c><![CDATA[#'CosNotifyChannelAdmin_ChannelNotFound'{}]]></c> exception is raised.</p> + </desc> + </func> + <func> + <name>connect_sequence_push_consumer(EventDomain, Consumer) -> Reply</name> + <fsummary>Connect the SequencePushConsumer to the default Channel</fsummary> + <type> + <v>EventDomain = #objref</v> + <v>Consumer = CosNotifyComm::SequencePushConsumer</v> + <v>Reply = CosNotifyChannelAdmin::SequenceProxyPushSupplier | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}</v> + </type> + <desc> + <p>If a default Channel have been set, this operation connects the given + SequencePushConsumer to it. Otherwise, the + <c><![CDATA[#'CosNotifyChannelAdmin_ChannelNotFound'{}]]></c> exception is raised.</p> + </desc> + </func> + <func> + <name>connect_sequence_pull_consumer(EventDomain, Consumer) -> Reply</name> + <fsummary>Connect the SequencePullConsumer to the default Channel</fsummary> + <type> + <v>EventDomain = #objref</v> + <v>Consumer = CosNotifyComm::SequencePullConsumer</v> + <v>Reply = CosNotifyChannelAdmin::SequenceProxyPullSupplier | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}</v> + </type> + <desc> + <p>If a default Channel have been set, this operation connects the given + SequencePullConsumer to it. Otherwise, the + <c><![CDATA[#'CosNotifyChannelAdmin_ChannelNotFound'{}]]></c> exception is raised.</p> + </desc> + </func> + <func> + <name>connect_sequence_push_supplier(EventDomain, Supplier) -> Reply</name> + <fsummary>Connect the SequencePushSupplier to the default Channel</fsummary> + <type> + <v>EventDomain = #objref</v> + <v>Supplier = CosNotifyComm::SequencePushSupplier</v> + <v>Reply = CosNotifyChannelAdmin::SequenceProxyPushConsumer | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}</v> + </type> + <desc> + <p>If a default Channel have been set, this operation connects the given + SequencePushSupplier to it. Otherwise, the + <c><![CDATA[#'CosNotifyChannelAdmin_ChannelNotFound'{}]]></c> exception is raised.</p> + </desc> + </func> + <func> + <name>connect_sequence_pull_supplier(EventDomain, Supplier) -> Reply</name> + <fsummary>Connect the SequencePullSupplier to the default Channel</fsummary> + <type> + <v>EventDomain = #objref</v> + <v>Supplier = CosNotifyComm::SequencePullSupplier</v> + <v>Reply = CosNotifyChannelAdmin::SequenceProxyPullConsumer | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}</v> + </type> + <desc> + <p>If a default Channel have been set, this operation connects the given + SequencePullSupplier to it. Otherwise, the + <c><![CDATA[#'CosNotifyChannelAdmin_ChannelNotFound'{}]]></c> exception is raised.</p> + </desc> + </func> + <func> + <name>connect_push_consumer_with_id(EventDomain, Consumer, MemberID) -> Reply</name> + <fsummary>Connect the PushConsumer to the Channel with the given MemberID</fsummary> + <type> + <v>EventDomain = #objref</v> + <v>Consumer = CosEventComm::PushConsumer</v> + <v>MemberID = long()</v> + <v>Reply = CosNotifyChannelAdmin::ProxyPushSupplier | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}</v> + </type> + <desc> + <p>If a Channel associated with the given MemberID exists within the + target Domain, this operation connects the given PushConsumer + to it. Otherwise, the <c><![CDATA[#'CosNotifyChannelAdmin_ChannelNotFound'{}]]></c> + exception is raised.</p> + </desc> + </func> + <func> + <name>connect_pull_consumer_with_id(EventDomain, Consumer, MemberID) -> Reply</name> + <fsummary>Connect the PullConsumer to the Channel with the given MemberID</fsummary> + <type> + <v>EventDomain = #objref</v> + <v>Consumer = CosEventComm::PullConsumer</v> + <v>MemberID = long()</v> + <v>Reply = CosNotifyChannelAdmin::ProxyPullSupplier | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}</v> + </type> + <desc> + <p>If a Channel associated with the given MemberID exists within the + target Domain, this operation connects the given PullConsumer + to it. Otherwise, the <c><![CDATA[#'CosNotifyChannelAdmin_ChannelNotFound'{}]]></c> + exception is raised.</p> + </desc> + </func> + <func> + <name>connect_push_supplier_with_id(EventDomain, Supplier, MemberID) -> Reply</name> + <fsummary>Connect the PushSupplier to the Channel with the given MemberID</fsummary> + <type> + <v>EventDomain = #objref</v> + <v>Supplier = CosEventComm::PushSupplier</v> + <v>MemberID = long()</v> + <v>Reply = CosNotifyChannelAdmin::ProxyPushConsumer | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}</v> + </type> + <desc> + <p>If a Channel associated with the given MemberID exists within the + target Domain, this operation connects the given PushSupplier + to it. Otherwise, the <c><![CDATA[#'CosNotifyChannelAdmin_ChannelNotFound'{}]]></c> + exception is raised.</p> + </desc> + </func> + <func> + <name>connect_pull_supplier_with_id(EventDomain, Supplier, MemberID) -> Reply</name> + <fsummary>Connect the PullSupplier to the Channel with the given MemberID</fsummary> + <type> + <v>EventDomain = #objref</v> + <v>Supplier = CosEventComm::PullSupplier</v> + <v>MemberID = long()</v> + <v>Reply = CosNotifyChannelAdmin::ProxyPushConsumer | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}</v> + </type> + <desc> + <p>If a Channel associated with the given MemberID exists within the + target Domain, this operation connects the given PullSupplier + to it. Otherwise, the <c><![CDATA[#'CosNotifyChannelAdmin_ChannelNotFound'{}]]></c> + exception is raised.</p> + </desc> + </func> + <func> + <name>connect_structured_push_consumer_with_id(EventDomain, Consumer, MemberID) -> Reply</name> + <fsummary>Connect the StructuredPushConsumer to the Channel with the given MemberID</fsummary> + <type> + <v>EventDomain = #objref</v> + <v>Consumer = CosNotifyComm::StructuredPushConsumer</v> + <v>MemberID = long()</v> + <v>Reply = CosNotifyChannelAdmin::StructuredProxyPushSupplier | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}</v> + </type> + <desc> + <p>If a Channel associated with the given MemberID exists within the + target Domain, this operation connects the given StructuredPushConsumer + to it. Otherwise, the <c><![CDATA[#'CosNotifyChannelAdmin_ChannelNotFound'{}]]></c> + exception is raised.</p> + </desc> + </func> + <func> + <name>connect_structured_pull_consumer_with_id(EventDomain, Consumer, MemberID) -> Reply</name> + <fsummary>Connect the StructuredPullConsumer to the Channel with the given MemberID</fsummary> + <type> + <v>EventDomain = #objref</v> + <v>Consumer = CosNotifyComm::StructuredPullConsumer</v> + <v>MemberID = long()</v> + <v>Reply = CosNotifyChannelAdmin::StructuredProxyPullSupplier | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}</v> + </type> + <desc> + <p>If a Channel associated with the given MemberID exists within the + target Domain, this operation connects the given StructuredPullConsumer + to it. Otherwise, the <c><![CDATA[#'CosNotifyChannelAdmin_ChannelNotFound'{}]]></c> + exception is raised.</p> + </desc> + </func> + <func> + <name>connect_structured_push_supplier_with_id(EventDomain, Supplier, MemberID) -> Reply</name> + <fsummary>Connect the StructuredPushSupplier to the Channel with the given MemberID</fsummary> + <type> + <v>EventDomain = #objref</v> + <v>Supplier = CosNotifyComm::StructuredPushSupplier</v> + <v>MemberID = long()</v> + <v>Reply = CosNotifyChannelAdmin::StructuredProxyPushConsumer | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}</v> + </type> + <desc> + <p>If a Channel associated with the given MemberID exists within the + target Domain, this operation connects the given StructuredPushSupplier + to it. Otherwise, the <c><![CDATA[#'CosNotifyChannelAdmin_ChannelNotFound'{}]]></c> + exception is raised.</p> + </desc> + </func> + <func> + <name>connect_structured_pull_supplier_with_id(EventDomain, Supplier, MemberID) -> Reply</name> + <fsummary>Connect the StructuredPullSupplier to the Channel with the given MemberID</fsummary> + <type> + <v>EventDomain = #objref</v> + <v>Supplier = CosNotifyComm::StructuredPullSupplier</v> + <v>MemberID = long()</v> + <v>Reply = CosNotifyChannelAdmin::StructuredProxyPullConsumer | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}</v> + </type> + <desc> + <p>If a Channel associated with the given MemberID exists within the + target Domain, this operation connects the given StructuredPullSupplier + to it. Otherwise, the <c><![CDATA[#'CosNotifyChannelAdmin_ChannelNotFound'{}]]></c> + exception is raised.</p> + </desc> + </func> + <func> + <name>connect_sequence_push_consumer_with_id(EventDomain, Consumer, MemberID) -> Reply</name> + <fsummary>Connect the SequencePushConsumer to the Channel with the given MemberID</fsummary> + <type> + <v>EventDomain = #objref</v> + <v>Consumer = CosNotifyComm::SequencePushConsumer</v> + <v>MemberID = long()</v> + <v>Reply = CosNotifyChannelAdmin::SequenceProxyPushSupplier | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}</v> + </type> + <desc> + <p>If a Channel associated with the given MemberID exists within the + target Domain, this operation connects the given SequencePushConsumer + to it. Otherwise, the <c><![CDATA[#'CosNotifyChannelAdmin_ChannelNotFound'{}]]></c> + exception is raised.</p> + </desc> + </func> + <func> + <name>connect_sequence_pull_consumer_with_id(EventDomain, Consumer, MemberID) -> Reply</name> + <fsummary>Connect the SequencePullConsumer to the Channel with the given MemberID</fsummary> + <type> + <v>EventDomain = #objref</v> + <v>Consumer = CosNotifyComm::SequencePullConsumer</v> + <v>MemberID = long()</v> + <v>Reply = CosNotifyChannelAdmin::SequenceProxyPullSupplier | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}</v> + </type> + <desc> + <p>If a Channel associated with the given MemberID exists within the + target Domain, this operation connects the given SequencePullConsumer + to it. Otherwise, the <c><![CDATA[#'CosNotifyChannelAdmin_ChannelNotFound'{}]]></c> + exception is raised.</p> + </desc> + </func> + <func> + <name>connect_sequence_push_supplier_with_id(EventDomain, Supplier, MemberID) -> Reply</name> + <fsummary>Connect the SequencePushSupplier to the Channel with the given MemberID</fsummary> + <type> + <v>EventDomain = #objref</v> + <v>Supplier = CosNotifyComm::SequencePushSupplier</v> + <v>MemberID = long()</v> + <v>Reply = CosNotifyChannelAdmin::SequenceProxyPushConsumer | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}</v> + </type> + <desc> + <p>If a Channel associated with the given MemberID exists within the + target Domain, this operation connects the given SequencePushSupplier + to it. Otherwise, the <c><![CDATA[#'CosNotifyChannelAdmin_ChannelNotFound'{}]]></c> + exception is raised.</p> + </desc> + </func> + <func> + <name>connect_sequence_pull_supplier_with_id(EventDomain, Supplier, MemberID) -> Reply</name> + <fsummary>Connect the SequencePullSupplier to the Channel with the given MemberID</fsummary> + <type> + <v>EventDomain = #objref</v> + <v>Supplier = CosNotifyComm::SequencePullSupplier</v> + <v>MemberID = long()</v> + <v>Reply = CosNotifyChannelAdmin::SequenceProxyPullConsumer | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}</v> + </type> + <desc> + <p>If a Channel associated with the given MemberID exists within the + target Domain, this operation connects the given SequencePullSupplier + to it. Otherwise, the <c><![CDATA[#'CosNotifyChannelAdmin_ChannelNotFound'{}]]></c> + exception is raised.</p> + </desc> + </func> + </funcs> + +</erlref> + diff --git a/lib/cosEventDomain/doc/src/CosEventDomainAdmin_EventDomainFactory.xml b/lib/cosEventDomain/doc/src/CosEventDomainAdmin_EventDomainFactory.xml new file mode 100644 index 0000000000..0720a4b930 --- /dev/null +++ b/lib/cosEventDomain/doc/src/CosEventDomainAdmin_EventDomainFactory.xml @@ -0,0 +1,88 @@ +<?xml version="1.0" encoding="latin1" ?> +<!DOCTYPE erlref SYSTEM "erlref.dtd"> + +<erlref> + <header> + <copyright> + <year>2001</year> + <year>2007</year> + <holder>Ericsson AB, All Rights Reserved</holder> + </copyright> + <legalnotice> + 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. + </legalnotice> + + <title>CosEventDomainAdmin_­EventDomainFactory</title> + <shorttitle>..._EventChannel</shorttitle> + <prepared>Niclas Eklund</prepared> + <responsible>Niclas Eklund</responsible> + <docno></docno> + <approved>Niclas Eklund</approved> + <checked></checked> + <date>2001-08-20</date> + <rev>PA1</rev> + </header> + <module>CosEventDomainAdmin_EventDomainFactory</module> + <modulesummary>This module implements an Event Domain Factory interface, which is used to create new Event Domain instances.</modulesummary> + <description> + <p>To get access to all definitions include necessary <c><![CDATA[hrl]]></c> files by using:<br></br><c><![CDATA[-include_lib("cosEventDomain/include/*.hrl").]]></c></p> + </description> + <funcs> + <func> + <name>create_event_domain(Factory, QoS, Admin) -> Reply</name> + <fsummary>Create a new ConsumerAdmin object</fsummary> + <type> + <v>Factory = #objref</v> + <v>QoS = CosNotification::QoSProperties</v> + <v>Admin = CosNotification::AdminProperties</v> + <v>Reply = {EventDomain, DomainID} | {'EXCEPTION', #'CosNotification_UnsupportedQoS'{}} | {'EXCEPTION', #'CosNotification_UnsupportedAdmin'{}}</v> + <v>EventDomain = #objref</v> + </type> + <desc> + <p>To create a new EventDomain this operation is used. If it is not + possible to support the given <c><![CDATA[QoSProperties]]></c> or <c><![CDATA[AdminProperties]]></c> + an exception is raised, which list the properties not supported. For more + information see the <c><![CDATA[cosNotification]]></c> user's guide.</p> + </desc> + </func> + <func> + <name>get_all_domains(Factory) -> DomainIDSeq</name> + <fsummary>Return a DomainID sequence of all domains associated with the target object</fsummary> + <type> + <v>Factory = #objref</v> + <v>DomainIDSeq = [long()]</v> + </type> + <desc> + <p>This function returns a DomainID sequence of all domains associated with the + target object.</p> + </desc> + </func> + <func> + <name>get_event_domain(Factory, DomainID) -> Reply</name> + <fsummary>Return the domain associated with the given id</fsummary> + <type> + <v>Factory = #objref</v> + <v>DomainID = long()</v> + <v>Reply = EventDomain | {'EXCEPTION', #'CosEventDomainAdmin_DomainNotFound'{}}</v> + <v>EventDomain = #objref</v> + </type> + <desc> + <p>This operation returns the EventDomain object associated with the + given DomainID. If no such binding exists an exception is raised.</p> + </desc> + </func> + </funcs> + +</erlref> + diff --git a/lib/cosEventDomain/doc/src/Makefile b/lib/cosEventDomain/doc/src/Makefile new file mode 100644 index 0000000000..465b726ad1 --- /dev/null +++ b/lib/cosEventDomain/doc/src/Makefile @@ -0,0 +1,227 @@ +# +# %CopyrightBegin% +# +# Copyright Ericsson AB 2001-2009. 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. +# +# %CopyrightEnd% +# +# +include $(ERL_TOP)/make/target.mk +include $(ERL_TOP)/make/$(TARGET)/otp.mk + +# ---------------------------------------------------- +# Application version +# ---------------------------------------------------- +include ../../vsn.mk +VSN=$(COSEVENTDOMAIN_VSN) +APPLICATION=cosEventDomain + +# ---------------------------------------------------- +# Include dependency +# ---------------------------------------------------- + +ifndef DOCSUPPORT +include make.dep +endif + +# ---------------------------------------------------- +# Release directory specification +# ---------------------------------------------------- +RELSYSDIR = $(RELEASE_PATH)/lib/$(APPLICATION)-$(VSN) + +# ---------------------------------------------------- +# Target Specs +# ---------------------------------------------------- +XML_APPLICATION_FILES = ref_man.xml +XML_REF3_FILES = \ + CosEventDomainAdmin_EventDomainFactory.xml \ + CosEventDomainAdmin_EventDomain.xml \ + CosEventDomainAdmin.xml \ + cosEventDomainApp.xml + +XML_PART_FILES = \ + part.xml \ + part_notes.xml +XML_CHAPTER_FILES = \ + ch_contents.xml \ + ch_introduction.xml \ + ch_QoS.xml \ + ch_event_domain_service.xml \ + notes.xml + +BOOK_FILES = book.xml + +TECHNICAL_DESCR_FILES = + +GIF_FILES = \ + book.gif \ + notes.gif \ + ref_man.gif \ + user_guide.gif + + +PS_FILES = + + +# ---------------------------------------------------- + +INTERNAL_HTML_FILES = $(TECHNICAL_DESCR_FILES:%.xml=$(HTMLDIR)/%.html) + +HTML_FILES = $(XML_APPLICATION_FILES:%.xml=$(HTMLDIR)/%.html) \ + $(XML_PART_FILES:%.xml=$(HTMLDIR)/%.html) + +INFO_FILE = ../../info +EXTRA_FILES = summary.html.src \ + $(DEFAULT_GIF_FILES) \ + $(DEFAULT_HTML_FILES) \ + $(XML_REF3_FILES:%.xml=$(HTMLDIR)/%.html) \ + $(XML_CHAPTER_FILES:%.xml=$(HTMLDIR)/%.html) + +MAN3_FILES = $(XML_REF3_FILES:%.xml=$(MAN3DIR)/%.3) + +ifdef DOCSUPPORT + +HTML_REF_MAN_FILE = $(HTMLDIR)/index.html + +TOP_PDF_FILE = $(PDFDIR)/$(APPLICATION)-$(VSN).pdf + +else + +TEX_FILES_BOOK = \ + $(BOOK_FILES:%.xml=%.tex) +TEX_FILES_REF_MAN = $(XML_REF3_FILES:%.xml=%.tex) \ + $(XML_APPLICATION_FILES:%.xml=%.tex) +TEX_FILES_USERS_GUIDE = \ + $(XML_CHAPTER_FILES:%.xml=%.tex) + +TOP_PDF_FILE = $(APPLICATION)-$(VSN).pdf + +TOP_PS_FILE = $(APPLICATION)-$(VSN).ps + +$(TOP_PDF_FILE): book.dvi ../../vsn.mk + $(DVI2PS) $(DVIPS_FLAGS) -f $< | $(DISTILL) $(DISTILL_FLAGS) > $@ + +$(TOP_PS_FILE): book.dvi ../../vsn.mk + $(DVI2PS) $(DVIPS_FLAGS) -f $< > $@ + +endif + +# ---------------------------------------------------- +# FLAGS +# ---------------------------------------------------- +XML_FLAGS += +DVIPS_FLAGS += + +# ---------------------------------------------------- +# Targets +# ---------------------------------------------------- +$(HTMLDIR)/%.gif: %.gif + $(INSTALL_DATA) $< $@ + +ifdef DOCSUPPORT + +docs: pdf html man + +$(TOP_PDF_FILE): $(XML_FILES) + +pdf: $(TOP_PDF_FILE) + +html: gifs $(HTML_REF_MAN_FILE) + +clean clean_docs: + rm -rf $(HTMLDIR)/* + rm -f $(MAN3DIR)/* + rm -f $(TOP_PDF_FILE) $(TOP_PDF_FILE:%.pdf=%.fo) + rm -f errs core *~ + rm -f $(JD_HTML) $(JD_PACK) + +else + +ifeq ($(DOCTYPE),pdf) +docs: pdf +else +ifeq ($(DOCTYPE),ps) +docs: ps +else +docs: html gifs man +endif +endif + +pdf: $(TOP_PDF_FILE) + +ps: $(TOP_PS_FILE) + +html: $(HTML_FILES) $(INTERNAL_HTML_FILES) + +clean clean_docs clean_tex: + rm -f $(TEX_FILES_USERS_GUIDE) $(TEX_FILES_REF_MAN) $(TEX_FILES_BOOK) + rm -f $(HTML_FILES) $(MAN3_FILES) + rm -f $(TOP_PDF_FILE) $(TOP_PS_FILE) + rm -f errs core *~ *xmls_output *xmls_errs $(LATEX_CLEAN) + +endif + +man: $(MAN3_FILES) + +gifs: $(GIF_FILES:%=$(HTMLDIR)/%) + +$(INDEX_TARGET): $(INDEX_SRC) + sed -e 's;%VSN%;$(VSN);' $(INDEX_SRC) > $(INDEX_TARGET) + +debug opt: + +# ---------------------------------------------------- +# Release Target +# ---------------------------------------------------- +include $(ERL_TOP)/make/otp_release_targets.mk + + +ifdef DOCSUPPORT + +release_docs_spec: docs + $(INSTALL_DIR) $(RELSYSDIR)/doc/pdf + $(INSTALL_DATA) $(TOP_PDF_FILE) $(RELSYSDIR)/doc/pdf + $(INSTALL_DIR) $(RELSYSDIR)/doc/html + $(INSTALL_DATA) $(HTMLDIR)/* \ + $(RELSYSDIR)/doc/html + $(INSTALL_DATA) $(INFO_FILE) $(RELSYSDIR) + $(INSTALL_DIR) $(RELEASE_PATH)/man/man3 + $(INSTALL_DATA) $(MAN3DIR)/* $(RELEASE_PATH)/man/man3 +else + +ifeq ($(DOCTYPE),pdf) +release_docs_spec: pdf + $(INSTALL_DIR) $(RELEASE_PATH)/pdf + $(INSTALL_DATA) $(TOP_PDF_FILE) $(RELEASE_PATH)/pdf +else +ifeq ($(DOCTYPE),ps) +release_docs_spec: ps + $(INSTALL_DIR) $(RELEASE_PATH)/ps + $(INSTALL_DATA) $(TOP_PS_FILE) $(RELEASE_PATH)/ps +else +release_docs_spec: docs + $(INSTALL_DIR) $(RELSYSDIR)/doc/html + $(INSTALL_DATA) $(GIF_FILES) $(EXTRA_FILES) $(HTML_FILES) \ + $(RELSYSDIR)/doc/html + $(INSTALL_DATA) $(INFO_FILE) $(RELSYSDIR) + $(INSTALL_DIR) $(RELEASE_PATH)/man/man3 + $(INSTALL_DATA) $(MAN3_FILES) $(RELEASE_PATH)/man/man3 + +endif +endif + +endif + +release_spec: + diff --git a/lib/cosEventDomain/doc/src/book.gif b/lib/cosEventDomain/doc/src/book.gif Binary files differnew file mode 100644 index 0000000000..94b3868792 --- /dev/null +++ b/lib/cosEventDomain/doc/src/book.gif diff --git a/lib/cosEventDomain/doc/src/book.xml b/lib/cosEventDomain/doc/src/book.xml new file mode 100644 index 0000000000..3a36704355 --- /dev/null +++ b/lib/cosEventDomain/doc/src/book.xml @@ -0,0 +1,48 @@ +<?xml version="1.0" encoding="latin1" ?> +<!DOCTYPE book SYSTEM "book.dtd"> + +<book xmlns:xi="http://www.w3.org/2001/XInclude"> + <header titlestyle="normal"> + <copyright> + <year>2001</year><year>2009</year> + <holder>Ericsson AB. All Rights Reserved.</holder> + </copyright> + <legalnotice> + 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. + + </legalnotice> + + <title>cosEventDomain</title> + <prepared>Niclas Eklund</prepared> + <docno></docno> + <date>2001-08-20</date> + <rev>1.0</rev> + </header> + <insidecover> + </insidecover> + <pagetext>cosEventDomain</pagetext> + <preamble> + <contents level="2"></contents> + </preamble> + <parts lift="no"> + <xi:include href="part.xml"/> + </parts> + <applications> + <xi:include href="ref_man.xml"/> + </applications> + <releasenotes> + <xi:include href="notes.xml"/> + </releasenotes> + <listofterms></listofterms> + <index></index> +</book> + diff --git a/lib/cosEventDomain/doc/src/ch_QoS.xml b/lib/cosEventDomain/doc/src/ch_QoS.xml new file mode 100644 index 0000000000..232cc4021a --- /dev/null +++ b/lib/cosEventDomain/doc/src/ch_QoS.xml @@ -0,0 +1,117 @@ +<?xml version="1.0" encoding="latin1" ?> +<!DOCTYPE chapter SYSTEM "chapter.dtd"> + +<chapter> + <header> + <copyright> + <year>2002</year><year>2009</year> + <holder>Ericsson AB. All Rights Reserved.</holder> + </copyright> + <legalnotice> + 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. + + </legalnotice> + + <title>Quality Of Service and Admin Properties</title> + <prepared></prepared> + <docno></docno> + <date>2000-05-29</date> + <rev></rev> + <file>ch_QoS.xml</file> + </header> + + <section> + <title>Quality Of Service and Admin Properties</title> + <p>This chapter explains the allowed properties it is possible to set for this + application. </p> + + <section> + <title>Quality Of Service</title> + <p>The cosEventDomain application supports the following QoS settings:</p> + <table> + <row> + <cell align="center" valign="middle"><em>QoS</em></cell> + <cell align="center" valign="middle"><em>Range</em></cell> + <cell align="center" valign="middle"><em>Default</em></cell> + </row> + <row> + <cell align="left" valign="middle">CycleDetection</cell> + <cell align="left" valign="middle">AuthorizeCycles/ForbidCycles</cell> + <cell align="left" valign="middle">ForbidCycles</cell> + </row> + <row> + <cell align="left" valign="middle">DiamondDetection</cell> + <cell align="left" valign="middle">AuthorizeDiamonds/ForbidDiamonds</cell> + <cell align="left" valign="middle">ForbidDiamonds</cell> + </row> + <tcaption>Supported QoS settings</tcaption> + </table> +<br></br><br></br><br></br><br></br> <p><em>Comments on the table 'Supported QoS Settings':</em></p> + <taglist> + <tag><em>CycleDetection</em></tag> + <item>If a cycle is created, the user <em>must</em> be aware of the fact + that unless they set timeout on events, events that are not filtered + will loop endlessly through the topology.</item> + <tag><em>DiamondDetection</em></tag> + <item>A Diamond in this context, means that the same + event may reach a point in the graph by more than one route + (i.e. transitive). Hence, it is possible that multiple copies + are delivered.</item> + </taglist> + </section> + + <section> + <title>Setting Quality Of Service</title> + <p>Assume we have a Consumer Admin object which we want to change + the current Quality of Service. Typical usage:</p> + <code type="none"><![CDATA[ +QoS = + [#'CosNotification_Property' + {name='CosEventDomainAdmin':'DiamondDetection'(), + value=any:create(orber_tc:short(), + 'CosEventDomainAdmin':'AuthorizeDiamonds'())}, + #'CosNotification_Property' + {name='CosEventDomainAdmin':'CycleDetection'(), + value=any:create(orber_tc:short(), + 'CosEventDomainAdmin':'ForbidCycles'())}], +'CosEventDomainAdmin_EventDomain':set_qos(ED, QoS), + ]]></code> + <p>If it is not possible to set the requested QoS the <c><![CDATA[UnsupportedQoS]]></c> + exception is raised, which includes a sequence of <c><![CDATA[PropertyError]]></c>'s + describing which QoS, possible range and why is not allowed. The error + codes are:</p> + <list type="bulleted"> + <item>UNSUPPORTED_PROPERTY - QoS not supported for this type of target object.</item> + <item>UNAVAILABLE_PROPERTY - due to current QoS settings the given property + is not allowed.</item> + <item>UNSUPPORTED_VALUE - property value out of range; valid range is returned.</item> + <item>UNAVAILABLE_VALUE - due to current QoS settings the given value is + not allowed; valid range is returned.</item> + <item>BAD_PROPERTY - unrecognized property.</item> + <item>BAD_TYPE - type of supplied property is incorrect.</item> + <item>BAD_VALUE - illegal value.</item> + </list> + <p>The CosEventDomainAdmin_EventDomain interface also supports an operation + called <c><![CDATA[validate_qos/2]]></c>. The purpose of this operations is to check + if a QoS setting is supported by the target object and if so, the operation + returns additional properties which could be optionally added as well.</p> + </section> + + <section> + <title>Admin Properties</title> + <p>The OMG specification do not contain any definitions of Admin Properties. + Hence, the cosEventDomain application currently does not support any Admin + Properties.</p> + </section> + </section> +</chapter> + diff --git a/lib/cosEventDomain/doc/src/ch_contents.xml b/lib/cosEventDomain/doc/src/ch_contents.xml new file mode 100644 index 0000000000..bdb951566f --- /dev/null +++ b/lib/cosEventDomain/doc/src/ch_contents.xml @@ -0,0 +1,68 @@ +<?xml version="1.0" encoding="latin1" ?> +<!DOCTYPE chapter SYSTEM "chapter.dtd"> + +<chapter> + <header> + <copyright> + <year>2001</year><year>2009</year> + <holder>Ericsson AB. All Rights Reserved.</holder> + </copyright> + <legalnotice> + 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. + + </legalnotice> + + <title>The cosEventDomain Application</title> + <prepared>Niclas Eklund</prepared> + <docno></docno> + <date>2001-08-20</date> + <rev>B</rev> + <file>ch_contents.xml</file> + </header> + + <section> + <title>Content Overview</title> + <p>The cosEventDomain documentation is divided into three sections: + </p> + <list type="bulleted"> + <item> + <p>PART ONE - The User's Guide + <br></br>Description of the cosEventDomain Application including + services and a small tutorial demonstrating + the development of a simple service.</p> + </item> + <item> + <p>PART TWO - Release Notes + <br></br>A concise history of cosEventDomain.</p> + </item> + <item> + <p>PART THREE - The Reference Manual + <br></br> A quick reference guide, including a + brief description, to all the functions available in cosEventDomain.</p> + </item> + </list> + </section> + + <section> + <title>Brief Description of the User's Guide</title> + <p>The User's Guide contains the following parts:</p> + <list type="bulleted"> + <item> + <p>CosEventDomain overview</p> + </item> + <item> + <p>CosEventDomain installation and examples</p> + </item> + </list> + </section> +</chapter> + diff --git a/lib/cosEventDomain/doc/src/ch_event_domain_service.xml b/lib/cosEventDomain/doc/src/ch_event_domain_service.xml new file mode 100644 index 0000000000..62378cac91 --- /dev/null +++ b/lib/cosEventDomain/doc/src/ch_event_domain_service.xml @@ -0,0 +1,110 @@ +<?xml version="1.0" encoding="latin1" ?> +<!DOCTYPE chapter SYSTEM "chapter.dtd"> + +<chapter> + <header> + <copyright> + <year>2001</year><year>2009</year> + <holder>Ericsson AB. All Rights Reserved.</holder> + </copyright> + <legalnotice> + 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. + + </legalnotice> + + <title>Event Domain Service</title> + <prepared>Niclas Eklund</prepared> + <docno></docno> + <date>2001-08-20</date> + <rev>A</rev> + <file>ch_event_domain_service.xml</file> + </header> + + <section> + <title>Overview of the CosEventDomain Service</title> + <p>The Event Domain service allows programmers to manage a cluster + of information channels.</p> + + <section> + <title>Event Domain Service Components</title> + <p>There are two components in the OMG CosEventDomainAdmin service architecture:</p> + <list type="bulleted"> + <item><em>EventDomainFactory:</em> a factory for creating EventDomains.</item> + <item><em>EventDomain:</em> supplies a tool, which makes it easy to create + topologies of interconnected channels (i.e. a directed graph).</item> + </list> + </section> + + <section> + <title>A Tutorial on How to Create a Simple Service</title> + <p>To be able to use the cosEventDomain application, the cosNotification + and, possibly, the cosTime application must be installed.</p> + </section> + + <section> + <title>How to Run Everything</title> + <p>Below is a short transcript on how to run cosEventDomain. </p> + <code type="none"><![CDATA[ + +%% Start Mnesia and Orber +mnesia:delete_schema([node()]), +mnesia:create_schema([node()]), +orber:install([node()]), +mnesia:start(), +orber:start(), + +%% Install and start cosNotification. +cosNotificationApp:install(), +cosNotificationApp:start(), + +%% Install and start cosEventDomain. +cosEventDomainApp:install(), +cosEventDomainApp:start(), + +%% Start a CosEventDomainAdmin factory. +AdminFac = cosEventDomainApp:start_factory(), + +%% Define the desired QoS settings: +QoS = + [#'CosNotification_Property' + {name='CosEventDomainAdmin':'DiamondDetection'(), + value=any:create(orber_tc:short(), + 'CosEventDomainAdmin':'AuthorizeDiamonds'())}, + #'CosNotification_Property' + {name='CosEventDomainAdmin':'CycleDetection'(), + value=any:create(orber_tc:short(), + 'CosEventDomainAdmin':'ForbidCycles'())}], + +%% Create a new EventDomain: +{ED, EDId} = 'CosEventDomainAdmin_EventDomainFactory': + create_event_domain(Fac, QoS, []), + +%% Now we can add Notification Channels to the Domain. How this +%% is done, see the cosNotification documentation. Let us assume +%% that we have gained access to two Channel Objects; add them to the +%% domain: +ID1 = 'CosEventDomainAdmin_EventDomain':add_channel(ED, Ch1), +ID2 = 'CosEventDomainAdmin_EventDomain':add_channel(ED, Ch2), + +%% To connect them, we must first define a connection struct: +C1 = #'CosEventDomainAdmin_Connection'{supplier_id=ID1, +\011\011\011\011 consumer_id=ID2, +\011\011\011\011 ctype='STRUCTURED_EVENT', +\011\011\011\011 notification_style='Pull'}, + +%% Connect them: +'CosEventDomainAdmin_EventDomain':add_connection(ED, C1), + ]]></code> + </section> + </section> +</chapter> + diff --git a/lib/cosEventDomain/doc/src/ch_introduction.xml b/lib/cosEventDomain/doc/src/ch_introduction.xml new file mode 100644 index 0000000000..8a85fc052f --- /dev/null +++ b/lib/cosEventDomain/doc/src/ch_introduction.xml @@ -0,0 +1,52 @@ +<?xml version="1.0" encoding="latin1" ?> +<!DOCTYPE chapter SYSTEM "chapter.dtd"> + +<chapter> + <header> + <copyright> + <year>2001</year><year>2009</year> + <holder>Ericsson AB. All Rights Reserved.</holder> + </copyright> + <legalnotice> + 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. + + </legalnotice> + + <title>Introduction to cosEventDomain</title> + <prepared>Niclas Eklund</prepared> + <docno></docno> + <date>2001-08-20</date> + <rev></rev> + <file>ch_introduction.xml</file> + </header> + + <section> + <title>Overview</title> + <p>The cosEventDomain application is a Event Domain Service compliant with the <url href="http://www.omg.org">OMG</url> + Service CosEventDomainAdmin. + </p> + + <section> + <title>Purpose and Dependencies</title> + <p>CosEventDomain is dependent on <em>Orber</em>, which provides CORBA functionality in an Erlang environment.</p> + </section> + + <section> + <title>Prerequisites</title> + <p>To fully understand the concepts presented in the + documentation, it is recommended that the user is familiar + with distributed programming and CORBA. + </p> + </section> + </section> +</chapter> + diff --git a/lib/cosEventDomain/doc/src/cosEventDomainApp.xml b/lib/cosEventDomain/doc/src/cosEventDomainApp.xml new file mode 100644 index 0000000000..fe8df55929 --- /dev/null +++ b/lib/cosEventDomain/doc/src/cosEventDomainApp.xml @@ -0,0 +1,149 @@ +<?xml version="1.0" encoding="latin1" ?> +<!DOCTYPE erlref SYSTEM "erlref.dtd"> + +<erlref> + <header> + <copyright> + <year>2001</year> + <year>2007</year> + <holder>Ericsson AB, All Rights Reserved</holder> + </copyright> + <legalnotice> + 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. + </legalnotice> + + <title>cosEventDomainApp</title> + <prepared>Niclas Eklund</prepared> + <responsible>Niclas Eklund</responsible> + <docno></docno> + <approved>Niclas Eklund</approved> + <checked></checked> + <date>2001-08-20</date> + <rev>PA1</rev> + </header> + <module>cosEventDomainApp</module> + <modulesummary>The main module of the cosEventDomain application.</modulesummary> + <description> + <p>To get access to the record definitions for the structures use:<br></br><c><![CDATA[-include_lib("cosEventDomain/include/*.hrl").]]></c></p> + <p>This module contains the functions for starting and stopping the application.</p> + </description> + <funcs> + <func> + <name>install() -> Return</name> + <fsummary>Install the cosEventDomain application</fsummary> + <type> + <v>Return = ok | {'EXCEPTION', E} | {'EXIT', R}</v> + </type> + <desc> + <p>This operation installs the cosEventDomain application.</p> + </desc> + </func> + <func> + <name>uninstall() -> Return</name> + <fsummary>Uninstall the cosEventDomain application</fsummary> + <type> + <v>Return = ok | {'EXCEPTION', E} | {'EXIT', R}</v> + </type> + <desc> + <p>This operation uninstalls the cosEventDomain application.</p> + </desc> + </func> + <func> + <name>start() -> Return</name> + <fsummary>Start the cosEventDomain application</fsummary> + <type> + <v>Return = ok | {error, Reason}</v> + </type> + <desc> + <p>This operation starts the cosEventDomain application.</p> + </desc> + </func> + <func> + <name>stop() -> Return</name> + <fsummary>Stop the cosEventDomain application</fsummary> + <type> + <v>Return = ok | {error, Reason}</v> + </type> + <desc> + <p>This operation stops the cosEventDomain application.</p> + </desc> + </func> + <func> + <name>start_factory() -> Factory</name> + <fsummary>Start a factory with default settings</fsummary> + <type> + <v>Factory = #objref</v> + </type> + <desc> + <p>This operation creates a new instance of a + <seealso marker="CosEventDomainAdmin_EventDomainFactory">Event Domain Factory</seealso> + using the default settings.</p> + </desc> + </func> + <func> + <name>start_factory(Options) -> Factory</name> + <fsummary>Start a factory with settings defined by the given options</fsummary> + <type> + <v>Options = [Option]</v> + <v>Option = currently no options defined.</v> + <v>Factory = #objref</v> + </type> + <desc> + <p>This operation creates a new instance of a + <seealso marker="CosEventDomainAdmin_EventDomainFactory">Event Domain Factory</seealso></p> + </desc> + </func> + <func> + <name>start_factory_link() -> Factory</name> + <fsummary>Start a factory, which is linked to the invoking process, with default settings</fsummary> + <type> + <v>Factory = #objref</v> + </type> + <desc> + <p>This operation creates a new instance of a + <seealso marker="CosEventDomainAdmin_EventDomainFactory">Event Domain Factory</seealso>, + which is linked to the invoking process, using the default settings.</p> + </desc> + </func> + <func> + <name>start_factory_link(Options) -> Factory</name> + <fsummary>Start a factory, which is linked to the invoking process, with settings defined by the given options</fsummary> + <type> + <v>Options = [Option]</v> + <v>Option = currently no options defined.</v> + <v>Factory = #objref</v> + </type> + <desc> + <p>This operation creates a new instance of a + <seealso marker="CosEventDomainAdmin_EventDomainFactory">Event Domain Factory</seealso>, + which is linked to the invoking process, with settings defined by the + given options. Allowed options are the same as for + <c><![CDATA[cosEventDomainApp:start_factory/1]]></c>.</p> + </desc> + </func> + <func> + <name>stop_factory(Factory) -> Reply</name> + <fsummary>Terminate the target object</fsummary> + <type> + <v>Factory = #objref</v> + <v>Reply = ok | {'EXCEPTION', E}</v> + </type> + <desc> + <p>This operation stop the target factory.</p> + </desc> + </func> + </funcs> + +</erlref> + diff --git a/lib/cosEventDomain/doc/src/fascicules.xml b/lib/cosEventDomain/doc/src/fascicules.xml new file mode 100644 index 0000000000..0678195e07 --- /dev/null +++ b/lib/cosEventDomain/doc/src/fascicules.xml @@ -0,0 +1,18 @@ +<?xml version="1.0" encoding="latin1" ?> +<!DOCTYPE fascicules SYSTEM "fascicules.dtd"> + +<fascicules> + <fascicule file="part" href="part_frame.html" entry="no"> + User's Guide + </fascicule> + <fascicule file="ref_man" href="ref_man_frame.html" entry="yes"> + Reference Manual + </fascicule> + <fascicule file="part_notes" href="part_notes_frame.html" entry="no"> + Release Notes + </fascicule> + <fascicule file="" href="../../../../doc/print.html" entry="no"> + Off-Print + </fascicule> +</fascicules> + diff --git a/lib/cosEventDomain/doc/src/make.dep b/lib/cosEventDomain/doc/src/make.dep new file mode 100644 index 0000000000..2f3f1ae53d --- /dev/null +++ b/lib/cosEventDomain/doc/src/make.dep @@ -0,0 +1,23 @@ +# ---------------------------------------------------- +# >>>> Do not edit this file <<<< +# This file was automaticly generated by +# /home/otp/bin/docdepend +# ---------------------------------------------------- + + +# ---------------------------------------------------- +# TeX files that the DVI file depend on +# ---------------------------------------------------- + +book.dvi: CosEventDomainAdmin.tex CosEventDomainAdmin_EventDomain.tex \ + CosEventDomainAdmin_EventDomainFactory.tex \ + book.tex ch_QoS.tex ch_contents.tex ch_event_domain_service.tex \ + ch_introduction.tex cosEventDomainApp.tex \ + part.tex ref_man.tex + +# ---------------------------------------------------- +# Source inlined when transforming from source to LaTeX +# ---------------------------------------------------- + +book.tex: ref_man.xml + diff --git a/lib/cosEventDomain/doc/src/notes.gif b/lib/cosEventDomain/doc/src/notes.gif Binary files differnew file mode 100644 index 0000000000..e000cca26a --- /dev/null +++ b/lib/cosEventDomain/doc/src/notes.gif diff --git a/lib/cosEventDomain/doc/src/notes.xml b/lib/cosEventDomain/doc/src/notes.xml new file mode 100644 index 0000000000..fdfb21c046 --- /dev/null +++ b/lib/cosEventDomain/doc/src/notes.xml @@ -0,0 +1,168 @@ +<?xml version="1.0" encoding="latin1" ?> +<!DOCTYPE chapter SYSTEM "chapter.dtd"> + +<chapter> + <header> + <copyright> + <year>2001</year><year>2009</year> + <holder>Ericsson AB. All Rights Reserved.</holder> + </copyright> + <legalnotice> + 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. + + </legalnotice> + + <title>cosEventDomain Release Notes</title> + <prepared>Niclas Eklund</prepared> + <docno></docno> + <approved></approved> + <checked></checked> + <date>2001-08-20</date> + <rev>A</rev> + <file>notes.xml</file> + </header> + + <section> + <title>cosEventDomain 1.1.7</title> + + <section> + <title>Improvements and New Features</title> + <list type="bulleted"> + <item> + <p> + The documentation is now built with open source tools (xsltproc and fop) + that exists on most platforms. One visible change is that the frames are removed.</p> + <p> + Own Id: OTP-8201 Aux Id:</p> + </item> + </list> + </section> + </section> + + <section> + <title>cosEventDomain 1.1.6</title> + + <section> + <title>Improvements and New Features</title> + <list type="bulleted"> + <item> + <p>Obsolete guards, e.g. record vs is_record, has been changed + to avoid compiler warnings.</p> + <p>Own id: OTP-7987</p> + </item> + </list> + </section> + </section> + + <section> + <title>cosEventDomain 1.1.5</title> + + <section> + <title>Improvements and New Features</title> + <list type="bulleted"> + <item> + <p>Updated file headers.</p> + <p>Own id: OTP-7837</p> + </item> + </list> + </section> + </section> + + <section> + <title>cosEventDomain 1.1.4</title> + + <section> + <title>Improvements and New Features</title> + <list type="bulleted"> + <item> + <p>Documentation source included in open source releases.</p> + <p>Own id: OTP-7595</p> + </item> + </list> + </section> + </section> + + <section> + <title>cosEventDomain 1.1.3</title> + + <section> + <title>Improvements and New Features</title> + <list type="bulleted"> + <item> + <p>Updated file headers.</p> + <p>Own id: OTP-7011</p> + </item> + </list> + </section> + </section> + + <section> + <title>cosEventDomain 1.1.2</title> + + <section> + <title>Improvements and New Features</title> + <list type="bulleted"> + <item> + <p>The documentation source has been converted from SGML to XML.</p> + <p>Own id: OTP-6754</p> + </item> + </list> + </section> + </section> + + <section> + <title>cosEventDomain 1.1.1</title> + + <section> + <title>Improvements and New Features</title> + <list type="bulleted"> + <item> + <p>Minor Makefile changes.</p> + <p>Own id: OTP-6701</p> + </item> + </list> + </section> + </section> + + <section> + <title>cosEventDomain 1.1</title> + + <section> + <title>Improvements and New Features</title> + <list type="bulleted"> + <item> + <p>The stub/skeleton-files generated by IC have been improved, + i.e., depending on the IDL-files, reduced the size of the + erl- and beam-files and decreased dependencies off Orber's + Interface Repository. It is necessary to re-compile all IDL-files + and use COS-applications, including Orber, compiled with + IC-4.2.</p> + <p>Own id: OTP-4576</p> + </item> + </list> + </section> + </section> + + <section> + <title>cosEventDomain 1.0</title> + + <section> + <title>Improvements and New Features</title> + <list type="bulleted"> + <item> + <p>First release of the cosEventDomain application.</p> + </item> + </list> + </section> + </section> +</chapter> + diff --git a/lib/cosEventDomain/doc/src/part.xml b/lib/cosEventDomain/doc/src/part.xml new file mode 100644 index 0000000000..720a4d3feb --- /dev/null +++ b/lib/cosEventDomain/doc/src/part.xml @@ -0,0 +1,39 @@ +<?xml version="1.0" encoding="latin1" ?> +<!DOCTYPE part SYSTEM "part.dtd"> + +<part xmlns:xi="http://www.w3.org/2001/XInclude"> + <header> + <copyright> + <year>2001</year><year>2009</year> + <holder>Ericsson AB. All Rights Reserved.</holder> + </copyright> + <legalnotice> + 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. + + </legalnotice> + + <title>cosEventDomain User's Guide</title> + <prepared>Niclas Eklund</prepared> + <docno></docno> + <date>2001-08-20</date> + <rev>1.0</rev> + </header> + <description> + <p>The <em>cosEventDomain</em> application is an Erlang implementation of a + CORBA Service CosEventDomainAdmin.</p> + </description> + <xi:include href="ch_contents.xml"/> + <xi:include href="ch_introduction.xml"/> + <xi:include href="ch_QoS.xml"/> + <xi:include href="ch_event_domain_service.xml"/> +</part> + diff --git a/lib/cosEventDomain/doc/src/part_notes.xml b/lib/cosEventDomain/doc/src/part_notes.xml new file mode 100644 index 0000000000..0979d6e491 --- /dev/null +++ b/lib/cosEventDomain/doc/src/part_notes.xml @@ -0,0 +1,36 @@ +<?xml version="1.0" encoding="latin1" ?> +<!DOCTYPE part SYSTEM "part.dtd"> + +<part xmlns:xi="http://www.w3.org/2001/XInclude"> + <header> + <copyright> + <year>2001</year><year>2009</year> + <holder>Ericsson AB. All Rights Reserved.</holder> + </copyright> + <legalnotice> + 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. + + </legalnotice> + + <title>cosEventDomain Release Notes</title> + <prepared>Niclas Eklund</prepared> + <docno></docno> + <date>2001-08-20</date> + <rev>1.0</rev> + </header> + <description> + <p>The cosEventDomain Application is an Erlang implementation of a CORBA Service + CosEventDomainAdmin.</p> + </description> + <xi:include href="notes.xml"/> +</part> + diff --git a/lib/cosEventDomain/doc/src/ref_man.gif b/lib/cosEventDomain/doc/src/ref_man.gif Binary files differnew file mode 100644 index 0000000000..b13c4efd53 --- /dev/null +++ b/lib/cosEventDomain/doc/src/ref_man.gif diff --git a/lib/cosEventDomain/doc/src/ref_man.xml b/lib/cosEventDomain/doc/src/ref_man.xml new file mode 100644 index 0000000000..ddb836e1d6 --- /dev/null +++ b/lib/cosEventDomain/doc/src/ref_man.xml @@ -0,0 +1,39 @@ +<?xml version="1.0" encoding="latin1" ?> +<!DOCTYPE application SYSTEM "application.dtd"> + +<application xmlns:xi="http://www.w3.org/2001/XInclude"> + <header> + <copyright> + <year>2001</year><year>2009</year> + <holder>Ericsson AB. All Rights Reserved.</holder> + </copyright> + <legalnotice> + 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. + + </legalnotice> + + <title>cosEventDomain Reference Manual</title> + <prepared>Niclas Eklund</prepared> + <docno></docno> + <date>2001-08-20</date> + <rev>1.0</rev> + </header> + <description> + <p>The <em>cosEventDomain</em> application is an Erlang implementation of + a CORBA Service CosEventDomainAdmin.</p> + </description> + <xi:include href="cosEventDomainApp.xml"/> + <xi:include href="CosEventDomainAdmin.xml"/> + <xi:include href="CosEventDomainAdmin_EventDomainFactory.xml"/> + <xi:include href="CosEventDomainAdmin_EventDomain.xml"/> +</application> + diff --git a/lib/cosEventDomain/doc/src/summary.html.src b/lib/cosEventDomain/doc/src/summary.html.src new file mode 100644 index 0000000000..922c956633 --- /dev/null +++ b/lib/cosEventDomain/doc/src/summary.html.src @@ -0,0 +1 @@ +Orber OMG Event Domain Service
\ No newline at end of file diff --git a/lib/cosEventDomain/doc/src/user_guide.gif b/lib/cosEventDomain/doc/src/user_guide.gif Binary files differnew file mode 100644 index 0000000000..e6275a803d --- /dev/null +++ b/lib/cosEventDomain/doc/src/user_guide.gif |
