diff options
Diffstat (limited to 'lib/cosEvent/doc/src')
19 files changed, 0 insertions, 1848 deletions
diff --git a/lib/cosEvent/doc/src/CosEventChannelAdmin.xml b/lib/cosEvent/doc/src/CosEventChannelAdmin.xml deleted file mode 100644 index 29336c1878..0000000000 --- a/lib/cosEvent/doc/src/CosEventChannelAdmin.xml +++ /dev/null @@ -1,78 +0,0 @@ -<?xml version="1.0" encoding="utf-8" ?> -<!DOCTYPE erlref SYSTEM "erlref.dtd"> - -<erlref> - <header> - <copyright> - <year>1997</year><year>2016</year> - <holder>Ericsson AB. All Rights Reserved.</holder> - </copyright> - <legalnotice> - 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. - - </legalnotice> - - <title>CosEventChannelAdmin</title> - <prepared></prepared> - <responsible></responsible> - <docno></docno> - <approved></approved> - <checked></checked> - <date>1997-11-13</date> - <rev>PA1</rev> - <file>CosEventChannelAdmin.xml</file> - </header> - <module>CosEventChannelAdmin</module> - <modulesummary>The CosEventChannelAdmin defines a set if event service interfaces that enables decoupled asynchronous communication between objects and implements generic (untyped) version of the OMG COSS standard event service.</modulesummary> - <description> - <p>The event service defines two roles for objects: the supplier role and - the consumer role. Suppliers supply event data to the event channel and - consumers receive event data from the channel. Suppliers do not need to - know the identity of the consumers, and vice versa. Consumers and - suppliers are connected to the event channel via proxies, which are managed - by ConsumerAdmin and SupplierAdmin objects.</p> - <p>There are four general models of communication. These are: </p> - <list type="bulleted"> - <item>The canonical push model. It allows the suppliers of events to initiate the - transfer of event data to consumers. Event channels play the role of - <c><![CDATA[Notifier]]></c>. Active suppliers use event channel to push data to - passive consumers registered with the event channel.</item> - <item>The canonical pull model. It allows consumers to request events from - suppliers. Event channels play the role of <c><![CDATA[Procure]]></c> since they - procure events on behalf of consumers. Active consumers can explicitly - pull data from passive suppliers via the event channels.</item> - <item>The hybrid push/pull model. It allows consumers request events queued at - a channel by suppliers. Event channels play the role of <c><![CDATA[Queue]]></c>. - Active consumers explicitly pull data deposited by active suppliers via - the event channels.</item> - <item>The hybrid pull/push model. It allows the channel to pull events from - suppliers and push them to consumers. Event channels play the role of - <c><![CDATA[Intelligent agent]]></c>. Active event channels can pull data from - passive suppliers to push it to passive consumers.</item> - </list> - <p>To get access to all definitions, e.g., exceptions, - include necessary <c><![CDATA[hrl]]></c> files by using:<br></br><c><![CDATA[-include_lib("cosEvent/include/*.hrl").]]></c></p> - <p>There are seven different interfaces supported in the service:</p> - <list type="bulleted"> - <item>ProxyPushConsumer</item> - <item>ProxyPullSupplier</item> - <item>ProxyPullConsumer</item> - <item>ProxyPushSupplier</item> - <item>ConsumerAdmin</item> - <item>SupplierAdmin</item> - <item>EventChannel</item> - </list> - </description> - -</erlref> - diff --git a/lib/cosEvent/doc/src/CosEventChannelAdmin_ConsumerAdmin.xml b/lib/cosEvent/doc/src/CosEventChannelAdmin_ConsumerAdmin.xml deleted file mode 100644 index 80d36ba5c5..0000000000 --- a/lib/cosEvent/doc/src/CosEventChannelAdmin_ConsumerAdmin.xml +++ /dev/null @@ -1,73 +0,0 @@ -<?xml version="1.0" encoding="utf-8" ?> -<!DOCTYPE erlref SYSTEM "erlref.dtd"> - -<erlref> - <header> - <copyright> - <year>1997</year> - <year>2016</year> - <holder>Ericsson AB, All Rights Reserved</holder> - </copyright> - <legalnotice> - 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. - </legalnotice> - - <title>CosEventChannelAdmin_ConsumerAdmin</title> - <prepared></prepared> - <responsible></responsible> - <docno></docno> - <approved></approved> - <checked></checked> - <date>1997-11-13</date> - <rev>PA1</rev> - <file>CosEventChannelAdmin_ConsumerAdmin.xml</file> - </header> - <module>CosEventChannelAdmin_ConsumerAdmin</module> - <modulesummary>This module implements a ConsumerAdmin interface, which allows consumers to be connected to the event channel.</modulesummary> - <description> - <p>The ConsumerAdmin interface defines the first step for connecting consumers - to the event channel. It acts as a factory for creating proxy suppliers. - Both consumer administration and supplier administration are defined as separate - objects so that the creator of the channel can control the addition of - suppliers and consumers. </p> - <p>To get access to all definitions include necessary <c><![CDATA[hrl]]></c> files by using:<br></br><c><![CDATA[-include_lib("cosEvent/include/*.hrl").]]></c></p> - </description> - <funcs> - <func> - <name>obtain_push_supplier(Object) -> Return</name> - <fsummary>Create a ProxyPushSupplier object</fsummary> - <type> - <v>Object = #objref</v> - <v>Return = #objref</v> - </type> - <desc> - <p>This operation returns a ProxyPushSupplier object reference.</p> - </desc> - </func> - <func> - <name>obtain_pull_supplier(Object) -> Return</name> - <fsummary>Create a ProxyPullSupplier object</fsummary> - <type> - <v>Object = #objref</v> - <v>Return = #objref</v> - </type> - <desc> - <p>This operation returns a ProxyPullSupplier object reference.</p> - </desc> - </func> - </funcs> - -</erlref> - diff --git a/lib/cosEvent/doc/src/CosEventChannelAdmin_EventChannel.xml b/lib/cosEvent/doc/src/CosEventChannelAdmin_EventChannel.xml deleted file mode 100644 index f32e742240..0000000000 --- a/lib/cosEvent/doc/src/CosEventChannelAdmin_EventChannel.xml +++ /dev/null @@ -1,95 +0,0 @@ -<?xml version="1.0" encoding="utf-8" ?> -<!DOCTYPE erlref SYSTEM "erlref.dtd"> - -<erlref> - <header> - <copyright> - <year>1997</year> - <year>2016</year> - <holder>Ericsson AB, All Rights Reserved</holder> - </copyright> - <legalnotice> - 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. - </legalnotice> - - <title>CosEventChannelAdmin_EventChannel</title> - <prepared></prepared> - <responsible></responsible> - <docno></docno> - <approved></approved> - <checked></checked> - <date>1997-11-13</date> - <rev>PA1</rev> - <file>CosEventChannelAdmin_EventChannel.xml</file> - </header> - <module>CosEventChannelAdmin_EventChannel</module> - <modulesummary>This module implements an Event Channel interface, which plays the role of a mediator between consumers and suppliers.</modulesummary> - <description> - <p>An event channel is an object that allows multiple suppliers to communicate - with multiple consumers in a highly decoupled, asynchronous manner. The event - channel is built up incrementally. When an event channel is - created no suppliers or consumers are connected to it. Event Channel can - implement group communication by serving as a replicator, broadcaster, or - multicaster that forward events from one or more suppliers to multiple - consumers.</p> - <p>It is up to the user to decide when an event channel is created and how - references to the event channel are obtained. By representing the event - channel as an object, it has all of the properties that apply to objects. - One way to manage an event channel is to register it in a naming context, - or export it through an operation on an object.</p> - <p>To get access to all definitions include necessary <c><![CDATA[hrl]]></c> files by using:<br></br><c><![CDATA[-include_lib("cosEvent/include/*.hrl").]]></c></p> - <p>Any object that possesses an object reference that supports the ProxyPullConsumer - interface can perform the following operations:</p> - </description> - <funcs> - <func> - <name>for_consumers(Object) -> Return</name> - <fsummary>Return a ConsumerAdmin object</fsummary> - <type> - <v>Object = #objref</v> - <v>Return = #objref</v> - </type> - <desc> - <p>This operation returns a ConsumerAdmin object reference. If ConsumerAdmin - object does not exist already it creates one.</p> - </desc> - </func> - <func> - <name>for_suppliers(Object) -> Return</name> - <fsummary>Return a SupplierAdmin object</fsummary> - <type> - <v>Object = #objref</v> - <v>Return = #objref</v> - </type> - <desc> - <p>This operation returns a SupplierAdmin object reference. If SupplierAdmin - object does not exist already it creates one.</p> - </desc> - </func> - <func> - <name>destroy(Object) -> Return</name> - <fsummary>Destroy the event channel</fsummary> - <type> - <v>Object = #objref</v> - <v>Return = #objref</v> - </type> - <desc> - <p></p> - </desc> - </func> - </funcs> - -</erlref> - diff --git a/lib/cosEvent/doc/src/CosEventChannelAdmin_ProxyPullConsumer.xml b/lib/cosEvent/doc/src/CosEventChannelAdmin_ProxyPullConsumer.xml deleted file mode 100644 index 83bf8acbf2..0000000000 --- a/lib/cosEvent/doc/src/CosEventChannelAdmin_ProxyPullConsumer.xml +++ /dev/null @@ -1,85 +0,0 @@ -<?xml version="1.0" encoding="utf-8" ?> -<!DOCTYPE erlref SYSTEM "erlref.dtd"> - -<erlref> - <header> - <copyright> - <year>1997</year> - <year>2016</year> - <holder>Ericsson AB, All Rights Reserved</holder> - </copyright> - <legalnotice> - 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. - </legalnotice> - - <title>CosEventChannelAdmin_ProxyPullConsumer</title> - <prepared></prepared> - <responsible></responsible> - <docno></docno> - <approved></approved> - <checked></checked> - <date>1997-11-13</date> - <rev>PA1</rev> - <file>CosEventChannelAdmin_ProxyPullConsumer.xml</file> - </header> - <module>CosEventChannelAdmin_ProxyPullConsumer</module> - <modulesummary>This module implements a ProxyPullConsumer interface which acts as a middleman between pull supplier and the event channel.</modulesummary> - <description> - <p>The ProxyPullConsumer interface defines the second step for connecting pull - suppliers to the event channel. A proxy consumer is similar to a normal consumer, - but includes an additional method for connecting a supplier to the proxy - consumer.</p> - <p>To get access to all definitions, e.g., exceptions, - include necessary <c><![CDATA[hrl]]></c> files by using:<br></br><c><![CDATA[-include_lib("cosEvent/include/*.hrl").]]></c></p> - <p>Any object that possesses an object reference that supports the ProxyPullConsumer - interface can perform the following operations:</p> - </description> - <funcs> - <func> - <name>connect_pull_supplier(Object, PullSupplier) -> Return</name> - <fsummary>Connect the pull supplier to the proxy pull consumer</fsummary> - <type> - <v>Object = #objref</v> - <v>PullSupplier = #objref of PullSupplier type</v> - <v>Return = ok | {'EXCEPTION', E}</v> - <v>E = #'CosEventChannelAdmin_AlreadyConnected'{} | #'CosEventChannelAdmin_TypeError'{}</v> - </type> - <desc> - <p>This operation connects PullSupplier object to the ProxyPullConsumer object. - If a nil object reference is passed CORBA standard <c><![CDATA[BAD_PARAM]]></c> exception - is raised. If the ProxyPullConsumer is already connected to a PullSupplier, - then the <c><![CDATA[CosEventChannelAdmin_AlreadyConnected]]></c> exception is raised. - Implementations of ProxyPullConsumers may require additional interface - functionality; if these requirements are not met the - <c><![CDATA[CosEventChannelAdmin_TypeError]]></c> exception will be raised.</p> - </desc> - </func> - <func> - <name>disconnect_pull_consumer(Object) -> Return</name> - <fsummary>Disconnect the ProxyPullConsumer object from the event channel.</fsummary> - <type> - <v>Object = #objref</v> - <v>Return = ok</v> - </type> - <desc> - <p>This operation disconnects proxy pull consumer from the event channel and - sends a notification about the loss of the connection to the pull supplier - attached to it.</p> - </desc> - </func> - </funcs> - -</erlref> - diff --git a/lib/cosEvent/doc/src/CosEventChannelAdmin_ProxyPullSupplier.xml b/lib/cosEvent/doc/src/CosEventChannelAdmin_ProxyPullSupplier.xml deleted file mode 100644 index 0060e71e2b..0000000000 --- a/lib/cosEvent/doc/src/CosEventChannelAdmin_ProxyPullSupplier.xml +++ /dev/null @@ -1,112 +0,0 @@ -<?xml version="1.0" encoding="utf-8" ?> -<!DOCTYPE erlref SYSTEM "erlref.dtd"> - -<erlref> - <header> - <copyright> - <year>1997</year> - <year>2016</year> - <holder>Ericsson AB, All Rights Reserved</holder> - </copyright> - <legalnotice> - 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. - </legalnotice> - - <title>CosEventChannelAdmin_ProxyPullSupplier</title> - <prepared></prepared> - <responsible></responsible> - <docno></docno> - <approved>Lars Thors</approved> - <checked></checked> - <date>1997-11-13</date> - <rev>PA1</rev> - <file>CosEventChannelAdmin_ProxyPullSupplier.xml</file> - </header> - <module>CosEventChannelAdmin_ProxyPullSupplier</module> - <modulesummary>This module implements a ProxyPullSupplier interface which acts as a middleman between pull consumer and the event channel.</modulesummary> - <description> - <p>The ProxyPullSupplier interface defines the second step for connecting pull consumers to the event channel. A proxy supplier is similar to a normal supplier, - but includes an additional method for connecting a consumer to the proxy - supplier.</p> - <p>To get access to all definitions, e.g., exceptions, - include necessary <c><![CDATA[hrl]]></c> files by using:<br></br><c><![CDATA[-include_lib("cosEvent/include/*.hrl").]]></c></p> - <p>Any object that possesses an object reference that supports the ProxyPullSupplier - interface can perform the following operations:</p> - </description> - <funcs> - <func> - <name>connect_pull_consumer(Object, PullConsumer) -> Return</name> - <fsummary>Connect the pull consumer to the proxy pull supplier</fsummary> - <type> - <v>Object = #objref</v> - <v>PullConsumer = #objref of PullConsumer type</v> - <v>Return = ok | {'EXCEPTION', #'CosEventChannelAdmin_AlreadyConnected'{}}</v> - </type> - <desc> - <p>This operation connects PullConsumer object to the ProxyPullSupplier object. - A nil object reference can be passed to this operation. If so a channel - cannot invoke the disconnect_pull_consumer operation on the consumer; - the consumer may be disconnected from the channel without being - informed. If the ProxyPullSupplier is already connected to a - PullConsumer, then the <c><![CDATA[CosEventChannelAdmin_AlreadyConnected]]></c> - exception is raised.</p> - </desc> - </func> - <func> - <name>disconnect_pull_supplier(Object) -> Return</name> - <fsummary>Disconnect the ProxyPullSupplier object from the event channel.</fsummary> - <type> - <v>Object = #objref</v> - <v>Return = ok</v> - </type> - <desc> - <p>This operation disconnects proxy pull supplier from the event channel. - It sends a notification about the loss of the connection to the pull consumer - attached to it, unless nil object reference was passed at the connection - time.</p> - </desc> - </func> - <func> - <name>pull(Object) -> Return</name> - <fsummary>Transmit data from suppliers to consumers.</fsummary> - <type> - <v>Object = #objref</v> - <v>Return = any</v> - </type> - <desc> - <p>This operation blocks until the event data is available or the - <c><![CDATA[CosEventComm_Disconnected]]></c> exception is raised. - It returns the event data to the consumer.</p> - </desc> - </func> - <func> - <name>try_pull(Object) -> Return</name> - <fsummary>Transmit data from suppliers to consumers.</fsummary> - <type> - <v>Object = #objref</v> - <v>Return = {any, bool()}</v> - </type> - <desc> - <p>This operation does not block: if the event data is available, it returns - the event data and sets the data availability flag to true; otherwise - it returns a long with an undefined value and sets the data availability to - false. If the event communication has already been disconnected, the - <c><![CDATA[CosEventComm_Disconnected]]></c> exception is raised.</p> - </desc> - </func> - </funcs> - -</erlref> - diff --git a/lib/cosEvent/doc/src/CosEventChannelAdmin_ProxyPushConsumer.xml b/lib/cosEvent/doc/src/CosEventChannelAdmin_ProxyPushConsumer.xml deleted file mode 100644 index 9f19d001f9..0000000000 --- a/lib/cosEvent/doc/src/CosEventChannelAdmin_ProxyPushConsumer.xml +++ /dev/null @@ -1,99 +0,0 @@ -<?xml version="1.0" encoding="utf-8" ?> -<!DOCTYPE erlref SYSTEM "erlref.dtd"> - -<erlref> - <header> - <copyright> - <year>1997</year> - <year>2016</year> - <holder>Ericsson AB, All Rights Reserved</holder> - </copyright> - <legalnotice> - 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. - </legalnotice> - - <title>CosEventChannelAdmin_ProxyPushConsumer</title> - <prepared></prepared> - <responsible></responsible> - <docno></docno> - <approved></approved> - <checked></checked> - <date>1997-11-13</date> - <rev>PA1</rev> - <file>CosEventChannelAdmin_ProxyPushConsumer.xml</file> - </header> - <module>CosEventChannelAdmin_ProxyPushConsumer</module> - <modulesummary>This module implements a ProxyPushConsumer interface which acts as a middleman between push supplier and the event channel.</modulesummary> - <description> - <p>The ProxyPushConsumer interface defines the second step for connecting push - suppliers to the event channel. A proxy consumer is similar to a normal consumer, - but includes an additional method for connecting a supplier to the proxy - consumer.</p> - <p>To get access to all definitions, e.g., exceptions, - include necessary <c><![CDATA[hrl]]></c> files by using:<br></br><c><![CDATA[-include_lib("cosEvent/include/*.hrl").]]></c></p> - <p>Any object that possesses an object reference that supports the ProxyPushConsumer - interface can perform the following operations:</p> - </description> - <funcs> - <func> - <name>connect_push_supplier(Object, PushSupplier) -> Return</name> - <fsummary>Connect the push supplier to the proxy push consumer</fsummary> - <type> - <v>Object = #objref</v> - <v>PushSupplier = #objref of PushSupplier type</v> - <v>Return = ok | {'EXCEPTION', #'CosEventChannelAdmin_AlreadyConnected'{}}</v> - </type> - <desc> - <p>This operation connects PushSupplier object to the ProxyPushConsumer object. - A nil object reference can be passed to this operation. If so a channel - cannot invoke the disconnect_push_supplier operation on the supplier; - the supplier may be disconnected from the channel without being - informed. If the ProxyPushConsumer is already connected to a - PushSupplier, then the <c><![CDATA[CosEventChannelAdmin_AlreadyConnected]]></c> - exception is raised.</p> - </desc> - </func> - <func> - <name>disconnect_push_consumer(Object) -> Return</name> - <fsummary>Disconnect the ProxyPushConsumer object from the event channel.</fsummary> - <type> - <v>Object = #objref</v> - <v>Return = ok</v> - </type> - <desc> - <p>This operation disconnects proxy push consumer from the event channel. - Sends a notification about the loss of the connection to the push supplier - attached to it, unless nil object reference was passed at the connection - time.</p> - </desc> - </func> - <func> - <name>push(Object, Data) -> Return</name> - <fsummary>Communicate event data to the consumers.</fsummary> - <type> - <v>Object = #objref</v> - <v>Data = any</v> - <v>Return = ok | {'EXCEPTION', #'CosEventComm_Disconnected'{}}</v> - </type> - <desc> - <p>This operation sends event data to all connected consumers via the - event channel. If the event communication has already been disconnected, - the <c><![CDATA[CosEventComm_Disconnected]]></c> is raised.</p> - </desc> - </func> - </funcs> - -</erlref> - diff --git a/lib/cosEvent/doc/src/CosEventChannelAdmin_ProxyPushSupplier.xml b/lib/cosEvent/doc/src/CosEventChannelAdmin_ProxyPushSupplier.xml deleted file mode 100644 index 2b1098b9a7..0000000000 --- a/lib/cosEvent/doc/src/CosEventChannelAdmin_ProxyPushSupplier.xml +++ /dev/null @@ -1,85 +0,0 @@ -<?xml version="1.0" encoding="utf-8" ?> -<!DOCTYPE erlref SYSTEM "erlref.dtd"> - -<erlref> - <header> - <copyright> - <year>1997</year> - <year>2016</year> - <holder>Ericsson AB, All Rights Reserved</holder> - </copyright> - <legalnotice> - 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. - </legalnotice> - - <title>CosEventChannelAdmin_ProxyPushSupplier</title> - <prepared></prepared> - <responsible></responsible> - <docno></docno> - <approved></approved> - <checked></checked> - <date>1997-11-13</date> - <rev>PA1</rev> - <file>CosEventChannelAdmin_ProxyPushSupplier.xml</file> - </header> - <module>CosEventChannelAdmin_ProxyPushSupplier</module> - <modulesummary>This module implements a ProxyPushSupplier interface which acts as a middleman between push consumer and the event channel.</modulesummary> - <description> - <p>The ProxyPushSupplier interface defines the second step for connecting push - consumers to the event channel. A proxy supplier is similar to a normal supplier, - but includes an additional method for connecting a consumer to the proxy - supplier.</p> - <p>To get access to all definitions, e.g., exceptions, - include necessary <c><![CDATA[hrl]]></c> files by using:<br></br><c><![CDATA[-include_lib("cosEvent/include/*.hrl").]]></c></p> - <p>Any object that possesses an object reference that supports the ProxyPushSupplier - interface can perform the following operations:</p> - </description> - <funcs> - <func> - <name>connect_push_consumer(Object, PushConsumer) -> Return</name> - <fsummary>Connect the push consumer to the proxy push supplier</fsummary> - <type> - <v>Object = #objref</v> - <v>PushConsumer = #objref of PushConsumer type</v> - <v>Return = ok | {'EXCEPTION', E}</v> - <v>E = #'CosEventChannelAdmin_AlreadyConnected'{} | #'CosEventChannelAdmin_TypeError'{}</v> - </type> - <desc> - <p>This operation connects PushConsumer object to the ProxyPushSupplier object. - If a nil object reference is passed CORBA standard <c><![CDATA[BAD_PARAM]]></c> exception - is raised. If the ProxyPushSupplier is already connected to a PushConsumer, - then the <c><![CDATA[CosEventChannelAdmin_AlreadyConnected]]></c> exception is raised. - Implementations of ProxyPushSuppliers may require additional interface - functionality; if these requirements are not met the - <c><![CDATA[CosEventChannelAdmin_TypeError]]></c> exception will be raised.</p> - </desc> - </func> - <func> - <name>disconnect_push_supplier(Object) -> Return</name> - <fsummary>Disconnect the ProxyPushSupplier object from the event channel.</fsummary> - <type> - <v>Object = #objref</v> - <v>Return = ok</v> - </type> - <desc> - <p>This operation disconnects proxy push supplier from the event channel and - sends a notification about the loss of the connection to the push consumer - attached to it.</p> - </desc> - </func> - </funcs> - -</erlref> - diff --git a/lib/cosEvent/doc/src/CosEventChannelAdmin_SupplierAdmin.xml b/lib/cosEvent/doc/src/CosEventChannelAdmin_SupplierAdmin.xml deleted file mode 100644 index 2a58c0a873..0000000000 --- a/lib/cosEvent/doc/src/CosEventChannelAdmin_SupplierAdmin.xml +++ /dev/null @@ -1,73 +0,0 @@ -<?xml version="1.0" encoding="utf-8" ?> -<!DOCTYPE erlref SYSTEM "erlref.dtd"> - -<erlref> - <header> - <copyright> - <year>1997</year> - <year>2016</year> - <holder>Ericsson AB, All Rights Reserved</holder> - </copyright> - <legalnotice> - 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. - </legalnotice> - - <title>CosEventChannelAdmin_SupplierAdmin</title> - <prepared></prepared> - <responsible></responsible> - <docno></docno> - <approved></approved> - <checked></checked> - <date>1997-11-13</date> - <rev>PA1</rev> - <file>CosEventChannelAdmin_SupplierAdmin.xml</file> - </header> - <module>CosEventChannelAdmin_SupplierAdmin</module> - <modulesummary>This module implements a SupplierAdmin interface, which allows suppliers to be connected to the event channel.</modulesummary> - <description> - <p>The SupplierAdmin interface defines the first step for connecting suppliers - to the event channel. It acts as a factory for creating proxy consumers. - Both consumer administration and supplier administration are defined as separate - objects so that the creator of the channel can control the addition of - suppliers and consumers.</p> - <p>To get access to all definitions include necessary <c><![CDATA[hrl]]></c> files by using:<br></br><c><![CDATA[-include_lib("cosEvent/include/*.hrl").]]></c></p> - </description> - <funcs> - <func> - <name>obtain_push_consumer(Object) -> Return</name> - <fsummary>Create a ProxyPushConsumer object</fsummary> - <type> - <v>Object = #objref</v> - <v>Return = #objref</v> - </type> - <desc> - <p>This operation returns a ProxyPushConsumer object reference.</p> - </desc> - </func> - <func> - <name>obtain_pull_consumer(Object) -> Return</name> - <fsummary>Create a ProxyPullConsumer object</fsummary> - <type> - <v>Object = #objref</v> - <v>Return = #objref</v> - </type> - <desc> - <p>This operation returns a ProxyPullConsumer object reference.</p> - </desc> - </func> - </funcs> - -</erlref> - diff --git a/lib/cosEvent/doc/src/Makefile b/lib/cosEvent/doc/src/Makefile deleted file mode 100644 index 4fcb210e5a..0000000000 --- a/lib/cosEvent/doc/src/Makefile +++ /dev/null @@ -1,145 +0,0 @@ -# -# %CopyrightBegin% -# -# Copyright Ericsson AB 1999-2017. 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. -# -# %CopyrightEnd% -# -# -include $(ERL_TOP)/make/target.mk -include $(ERL_TOP)/make/$(TARGET)/otp.mk - -# ---------------------------------------------------- -# Application version -# ---------------------------------------------------- -include ../../vsn.mk -VSN=$(COSEVENT_VSN) -APPLICATION=cosEvent - -# ---------------------------------------------------- -# Release directory specification -# ---------------------------------------------------- -RELSYSDIR = $(RELEASE_PATH)/lib/$(APPLICATION)-$(VSN) - -# ---------------------------------------------------- -# Target Specs -# ---------------------------------------------------- -XML_APPLICATION_FILES = ref_man.xml -XML_REF3_FILES = \ - CosEventChannelAdmin.xml \ - CosEventChannelAdmin_ConsumerAdmin.xml \ - CosEventChannelAdmin_SupplierAdmin.xml \ - CosEventChannelAdmin_EventChannel.xml \ - CosEventChannelAdmin_ProxyPullConsumer.xml \ - CosEventChannelAdmin_ProxyPullSupplier.xml \ - CosEventChannelAdmin_ProxyPushConsumer.xml \ - CosEventChannelAdmin_ProxyPushSupplier.xml \ - cosEventApp.xml - -XML_PART_FILES = \ - part.xml -XML_CHAPTER_FILES = \ - ch_contents.xml \ - ch_introduction.xml \ - ch_event_service.xml \ - notes.xml - -BOOK_FILES = book.xml - -XML_FILES = $(BOOK_FILES) $(XML_APPLICATION_FILES) $(XML_REF3_FILES) \ - $(XML_PART_FILES) $(XML_CHAPTER_FILES) - -TECHNICAL_DESCR_FILES = - -GIF_FILES = \ - e_s_components.gif \ - e_s_models.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 = \ - $(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) - -HTML_REF_MAN_FILE = $(HTMLDIR)/index.html - -TOP_PDF_FILE = $(PDFDIR)/$(APPLICATION)-$(VSN).pdf - -# ---------------------------------------------------- -# FLAGS -# ---------------------------------------------------- -XML_FLAGS += -DVIPS_FLAGS += - -# ---------------------------------------------------- -# Targets -# ---------------------------------------------------- -$(HTMLDIR)/%.gif: %.gif - $(INSTALL_DATA) $< $@ - -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) - -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 - -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" - -release_spec: diff --git a/lib/cosEvent/doc/src/book.xml b/lib/cosEvent/doc/src/book.xml deleted file mode 100644 index 5c0172b4cd..0000000000 --- a/lib/cosEvent/doc/src/book.xml +++ /dev/null @@ -1,50 +0,0 @@ -<?xml version="1.0" encoding="utf-8" ?> -<!DOCTYPE book SYSTEM "book.dtd"> - -<book xmlns:xi="http://www.w3.org/2001/XInclude"> - <header titlestyle="normal"> - <copyright> - <year>1999</year><year>2016</year> - <holder>Ericsson AB. All Rights Reserved.</holder> - </copyright> - <legalnotice> - 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. - - </legalnotice> - - <title>cosEvent</title> - <prepared></prepared> - <docno></docno> - <date>1998-04-25</date> - <rev>1.0</rev> - <file>book.xml</file> - </header> - <insidecover> - </insidecover> - <pagetext>cosEvent</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/cosEvent/doc/src/ch_contents.xml b/lib/cosEvent/doc/src/ch_contents.xml deleted file mode 100644 index 07773877ea..0000000000 --- a/lib/cosEvent/doc/src/ch_contents.xml +++ /dev/null @@ -1,71 +0,0 @@ -<?xml version="1.0" encoding="utf-8" ?> -<!DOCTYPE chapter SYSTEM "chapter.dtd"> - -<chapter> - <header> - <copyright> - <year>1999</year> - <year>2016</year> - <holder>Ericsson AB, All Rights Reserved</holder> - </copyright> - <legalnotice> - 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. - </legalnotice> - - <title>The cosEvent Application</title> - <prepared>Niclas Eklund</prepared> - <docno></docno> - <date>1999-09-17</date> - <rev>B</rev> - <file>ch_contents.xml</file> - </header> - - <section> - <title>Content Overview</title> - <p>The cosEvent documentation is divided into three sections: - </p> - <list type="bulleted"> - <item> - <p>PART ONE - The User's Guide - <br></br>Description of the cosEvent 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 cosEvent.</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 cosEvent.</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>CosEvent overview</p> - </item> - <item> - <p>CosEvent installation and examples</p> - </item> - </list> - </section> -</chapter> - diff --git a/lib/cosEvent/doc/src/ch_event_service.xml b/lib/cosEvent/doc/src/ch_event_service.xml deleted file mode 100644 index 3a783234af..0000000000 --- a/lib/cosEvent/doc/src/ch_event_service.xml +++ /dev/null @@ -1,222 +0,0 @@ -<?xml version="1.0" encoding="utf-8" ?> -<!DOCTYPE chapter SYSTEM "chapter.dtd"> - -<chapter> - <header> - <copyright> - <year>1997</year><year>2016</year> - <holder>Ericsson AB. All Rights Reserved.</holder> - </copyright> - <legalnotice> - 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. - - </legalnotice> - - <title>Event Service</title> - <prepared></prepared> - <docno></docno> - <date>97-11-19</date> - <rev>A</rev> - <file>ch_es_intro.xml</file> - </header> - - <section> - <title>Overview of the CosEvent Service</title> - <p>The Event service allows programmers to subscribe to - information channels. Suppliers can generate events without knowing the - consumer identities and the consumer can receive events without knowing - the supplier identity. Both push and pull event delivery are supported. - The Event service will queue information and processes. - </p> - <p>The CORBA Event service provides a flexible model for - asynchronous, decoupled communication between objects. This - chapter outlines communication models and the roles and - relationships of key components in the CosEvent service. It - shows a simple example on use of this service.</p> - </section> - - <section> - <title>Event Service Components</title> - <p>There are five components in the OMG CosEvent service architecture. These - are described below:</p> - <marker id="e_s_components"></marker> - <image file="e_s_components.gif"> - <icaption> -Figure 1: Event service Components</icaption> - </image> - <list type="bulleted"> - <item><em>Suppliers and consumers:</em> Consumers are the ultimate targets of - events generated by suppliers. Consumers and suppliers can both play active - and - passive roles. There could be two types of consumers and suppliers: push - or pull. A PushSupplier object can actively push an event to a passive - PushConsumer object. Likewise, a PullSupplier object can passively - wait for a PullConsumer object to actively pull an event from it.</item> - <item><em>EventChannel:</em> The central abstraction in the CosEvent service is the - EventChannel which plays the role of a mediator between consumers and - suppliers. Consumers and suppliers register their interest with the - EventChannel. It can provide many-to-many communication. The channel - consumes events from one or more suppliers, and supplies events to one - or more consumers. An EventChannel can support consumers and suppliers - using different communication models.</item> - <item><em>ProxySuppliers and ProxyConsumers:</em> ProxySuppliers act as middlemen - between consumers and the EventChannel. A ProxySupplier is similar to - a normal supplier, but includes an additional method for connecting a - consumer to the ProxySupplier. Likewise, ProxyConsumers act as - middlemen between suppliers and the EventChannel. A ProxyConsumer is - similar to a normal consumer, but includes an additional method for - connecting a supplier to the ProxyConsumer.</item> - <item><em>Supplier and consumer administrations:</em> Consumer administration acts as - a factory for creating ProxySuppliers. Supplier administration acts as - a factory for creating ProxyConsumers.</item> - </list> - </section> - - <section> - <title>Event Service Communication Models</title> - <p>There are four general models of component collaboration in the OMG CosEvent service - architecture. The following describes these models: - (Please note that proxies are not shown in the diagrams for simplicity).</p> - <marker id="e_s_models"></marker> - <image file="e_s_models.gif"> - <icaption> -Figure 2: Event service Communication Models</icaption> - </image> - <list type="bulleted"> - <item><em>The Canonical Push Model:</em> The Canonical push model shown in figure 2(A) allows - the suppliers of events to initiate the transfer of event data to consumers. - In this model, suppliers are active initiators and consumers are the passive - targets of the requests. EventChannels play the role of <c><![CDATA[Notifier]]></c>. - Thus, active suppliers use EventChannels to push data to passive consumers that - have registered with the EventChannels.</item> - <item><em>The Canonical Pull Model:</em>The Canonical pull model shown - in figure 2(B) - allows consumers to request events from suppliers. In this model, - Consumers are - active initiators and suppliers are the passive targets of the pull - requests. - EventChannel plays the role of <c><![CDATA[Procurer]]></c> since it procures - events - on behalf of consumers. Thus, active consumers can explicitly pull - data - from passive suppliers via the EventChannels.</item> - <item><em>The Hybrid Push/Pull Model:</em> The push/pull model shown in figure 2(C) is a - hybrid that allows consumers to request events queued at an EventChannel - by suppliers. In this model, both suppliers and consumers are active - initiators of the requests. EventChannels play the role of <c><![CDATA[Queue]]></c>. - Thus, active consumers can explicitly pull data deposited by active - suppliers via the EventChannels.</item> - <item><em>The Hybrid Pull/Push Model:</em> The pull/push model shown in figure 2(D) is another - hybrid that allows the channel to pull events from suppliers and push them - to consumers. In this model, suppliers are passive targets of pull requests - and consumers are passive targets of pushes. EventChannels play the role of - <c><![CDATA[Intelligent Agent]]></c>. Thus, active EventChannels can pull data from - passive suppliers and push that data to passive consumers.</item> - </list> - </section> - - <section> - <title>A Tutorial on How to Create a Simple Service</title> - <p>To be able to use the cosEvent application supplier and consumer objects - must be implemented, which must inherit from the appropriate interface - defined in the <em>CosEventComm.idl</em> specification.</p> - <p>We start by creating an interface which inherits from the correct interface, - e.g., CosEventComm::PushConsumer. Hence, we must also implement all - operations defined in the PushConsumer interface. The IDL-file could look like: - </p> - <code type="c"><![CDATA[ -#ifndef _MYCLIENT_IDL -#define _MYCLIENT_IDL -#include <CosEventComm.idl> - -module myClientImpl { - - interface ownInterface:CosEventComm::PushConsumer { - - void ownFunctions(in any NeededArguments) - raises(OwnExceptions); - - }; -}; - -#endif - ]]></code> - <p>Run the IDL compiler on this file by calling the <c><![CDATA[ic:gen/1]]></c> function. - This will produce the API named <c><![CDATA[myClientImpl_ownInterface.erl]]></c>. - After generating the API stubs and the server skeletons it is time to - implement the servers and if no special options are sent - to the IDl compiler the file name is <c><![CDATA[myClientImpl_ownInterface_impl.erl]]></c>.</p> - </section> - - <section> - <title>How to Run Everything</title> - <p>Below is a short transcript on how to run cosEvent. </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 cosEvent in the IFR. -cosEventApp:install(), - -%% Register the application specific Client implementations -%% in the IFR. -'oe_myClientImpl':'oe_register'(), - -%% Start the cosEvent application. -cosEventApp:start(), - -%% Start a channel using the default configuration -Ch = cosEventApp:start_channel(), -%% ... or use configuration parameters. -Ch = cosEventApp:start_channel([{pull_interval, 10}, {maxEvents, 50}]), - -%% Retrieve a SupplierAdmin and a ConsumerAdmin. -AdminSupplier = 'CosEventChannelAdmin_EventChannel':for_suppliers(Ch), -AdminConsumer = 'CosEventChannelAdmin_EventChannel':for_consumers(Ch), - -%% Use the corresponding Admin object to get access to wanted Proxies - -%% Create a Push Consumer Proxy, which the Client Push Supplier will push -%% events to. -ProxyPushConsumer = - 'CosEventChannelAdmin_SupplierAdmin':obtain_push_consumer(AdminSupplier), - -%% Create a Push Supplier Proxy, which will push events to the registered -%% Push Consumer. -ProxyPushSupplier = - 'CosEventChannelAdmin_ConsumerAdmin':obtain_push_supplier(AdminConsumer), - - -%% Create application Clients. We can, for example, start the Clients -%% our selves or look them up in the naming service. This is application -%% specific. -Consumer = myClientImpl_ownInterface:oe_create(), -Supplier = ... - -%% Connect each Client to the corresponding Proxy. -'CosEventChannelAdmin_ProxyPushConsumer': - connect_push_supplier(ProxyPushConsumer, Supplier), -'CosEventChannelAdmin_ProxyPushSupplier': - connect_push_consumer(ProxyPushSupplier, Consumer), - ]]></code> - <p>The example above, exemplifies a event system, i.e., the <em>Canonical Push Model</em>, where the Supplier client in some way generates event - and pushes them to the proxy. The push supplier proxies will eventually - push the events to each Consumer client.</p> - </section> -</chapter> - diff --git a/lib/cosEvent/doc/src/ch_introduction.xml b/lib/cosEvent/doc/src/ch_introduction.xml deleted file mode 100644 index c88e96e40d..0000000000 --- a/lib/cosEvent/doc/src/ch_introduction.xml +++ /dev/null @@ -1,57 +0,0 @@ -<?xml version="1.0" encoding="utf-8" ?> -<!DOCTYPE chapter SYSTEM "chapter.dtd"> - -<chapter> - <header> - <copyright> - <year>1999</year> - <year>2016</year> - <holder>Ericsson AB, All Rights Reserved</holder> - </copyright> - <legalnotice> - 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. - </legalnotice> - - <title>Introduction to cosEvent</title> - <prepared>Niclas Eklund</prepared> - <docno></docno> - <date>1999-09-17</date> - <rev></rev> - <file>ch_introduction.xml</file> - </header> - - <section> - <title>Overview</title> - <p>The cosEvent application is a Event Service compliant with the <url href="http://www.omg.org">OMG</url> - Event Service CosEvent. - </p> - - <section> - <title>Purpose and Dependencies</title> - <p>CosEvent 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> - <p>Recommended reading includes <em>CORBA, Fundamentals and Programming - Jon Siegel</em> and <em>Open Telecom Platform Documentation Set</em>. It is also helpful to have read - <em>Concurrent Programming in Erlang</em>.</p> - </section> - </section> -</chapter> - diff --git a/lib/cosEvent/doc/src/cosEventApp.xml b/lib/cosEvent/doc/src/cosEventApp.xml deleted file mode 100644 index d26512e0c3..0000000000 --- a/lib/cosEvent/doc/src/cosEventApp.xml +++ /dev/null @@ -1,169 +0,0 @@ -<?xml version="1.0" encoding="utf-8" ?> -<!DOCTYPE erlref SYSTEM "erlref.dtd"> - -<erlref> - <header> - <copyright> - <year>2001</year> - <year>2016</year> - <holder>Ericsson AB, All Rights Reserved</holder> - </copyright> - <legalnotice> - 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. - </legalnotice> - - <title>cosEventApp</title> - <prepared>Niclas Eklund</prepared> - <responsible>Niclas Eklund</responsible> - <docno></docno> - <approved>Niclas Eklund</approved> - <checked></checked> - <date>2000-01-31</date> - <rev>PA1</rev> - <file>cosEventApp.xml</file> - </header> - <module>cosEventApp</module> - <modulesummary>The main module of the cosEvent application.</modulesummary> - <description> - <p>To get access to the record definitions for the structures use:<br></br><c><![CDATA[-include_lib("cosEvent/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 cosEvent application</fsummary> - <type> - <v>Return = ok | {'EXCEPTION', E} | {'EXIT', R}</v> - </type> - <desc> - <p>This operation installs the cosEvent application.</p> - </desc> - </func> - <func> - <name>uninstall() -> Return</name> - <fsummary>Uninstall the cosEvent application</fsummary> - <type> - <v>Return = ok | {'EXCEPTION', E} | {'EXIT', R}</v> - </type> - <desc> - <p>This operation uninstalls the cosEvent application.</p> - </desc> - </func> - <func> - <name>start() -> Return</name> - <fsummary>Start the cosEvent application</fsummary> - <type> - <v>Return = ok | {error, Reason}</v> - </type> - <desc> - <p>This operation starts the cosEvent application.</p> - </desc> - </func> - <func> - <name>stop() -> Return</name> - <fsummary>Stop the cosEvent application</fsummary> - <type> - <v>Return = ok | {error, Reason}</v> - </type> - <desc> - <p>This operation stops the cosEvent application.</p> - </desc> - </func> - <func> - <name>start_channel() -> Channel</name> - <fsummary>Start a channel with default settings</fsummary> - <type> - <v>Channel = #objref</v> - </type> - <desc> - <p>This operation creates a new instance of a - <seealso marker="CosEventChannelAdmin_EventChannel">Event Channel</seealso> - using the default settings.</p> - </desc> - </func> - <func> - <name>start_channel(Options) -> Channel</name> - <fsummary>Start a channel with settings defined by the given options</fsummary> - <type> - <v>Options = [Option]</v> - <v>Option = {pull_interval, Seconds} | {typecheck, Boolean} | {maxEvents, Integer} | {blocking, Boolean}</v> - <v>Channel = #objref</v> - </type> - <desc> - <p>This operation creates a new instance of a - <seealso marker="CosEventChannelAdmin_EventChannel">Event Channel</seealso></p> - <p></p> - <list type="bulleted"> - <item><c><![CDATA[{pull_interval, Seconds}]]></c> - determine how often Proxy Pull - Consumers will check for new events with the client application. The - default value is 20 seconds.</item> - <item><c><![CDATA[{typecheck, Boolean}]]></c> - if this option is set to true the - proxies will check if the supplied client object is of correct type. - The default value is false.</item> - <item><c><![CDATA[{maxEvents, Integer}]]></c> - this option determine how many events - the <c><![CDATA[ProxyPullSuppliers]]></c> will store before discarding events. - If the limit is reached events will be discarded in any order. - The default value is 300.</item> - <item><c><![CDATA[{blocking, Boolean}]]></c> - this option determine the behavior of - the channel when handling events internally. If set to <c><![CDATA[true]]></c> the - risk of a single event supplier floods the system is reduced, but - the performance may also be reduced. - The default value is <c><![CDATA[true]]></c>.</item> - </list> - </desc> - </func> - <func> - <name>start_channel_link() -> Channel</name> - <fsummary>Start a channel, which is linked to the invoking process, with default settings</fsummary> - <type> - <v>Channel = #objref</v> - </type> - <desc> - <p>This operation creates a new instance of a - <seealso marker="CosEventChannelAdmin_EventChannel">Event Channel</seealso>, - which is linked to the invoking process, using the default settings.</p> - </desc> - </func> - <func> - <name>start_channel_link(Options) -> Channel</name> - <fsummary>Start a channel, which is linked to the invoking process, with settings defined by the given options</fsummary> - <type> - <v>Options = [Option]</v> - <v>Option = {pull_interval, Seconds} | {typecheck, Boolean} | {maxEvents, Integer} | {blocking, Boolean}</v> - <v>Channel = #objref</v> - </type> - <desc> - <p>This operation creates a new instance of a - <seealso marker="CosEventChannelAdmin_EventChannel">Event Channel</seealso>, - which is linked to the invoking process, with settings defined by the - given options. Allowed options are the same as for - <c><![CDATA[cosEventApp:start_channel/1]]></c>.</p> - </desc> - </func> - <func> - <name>stop_channel(Channel) -> Reply</name> - <fsummary>Terminate the target object</fsummary> - <type> - <v>Channel = #objref</v> - <v>Reply = ok | {'EXCEPTION', E}</v> - </type> - <desc> - <p>This operation stop the target event channel.</p> - </desc> - </func> - </funcs> - -</erlref> - diff --git a/lib/cosEvent/doc/src/e_s_components.gif b/lib/cosEvent/doc/src/e_s_components.gif Binary files differdeleted file mode 100644 index a448c14ce0..0000000000 --- a/lib/cosEvent/doc/src/e_s_components.gif +++ /dev/null diff --git a/lib/cosEvent/doc/src/e_s_models.gif b/lib/cosEvent/doc/src/e_s_models.gif Binary files differdeleted file mode 100644 index 329b0858d1..0000000000 --- a/lib/cosEvent/doc/src/e_s_models.gif +++ /dev/null diff --git a/lib/cosEvent/doc/src/notes.xml b/lib/cosEvent/doc/src/notes.xml deleted file mode 100644 index ba0b0d88db..0000000000 --- a/lib/cosEvent/doc/src/notes.xml +++ /dev/null @@ -1,348 +0,0 @@ -<?xml version="1.0" encoding="utf-8" ?> -<!DOCTYPE chapter SYSTEM "chapter.dtd"> - -<chapter> - <header> - <copyright> - <year>1999</year><year>2016</year> - <holder>Ericsson AB. All Rights Reserved.</holder> - </copyright> - <legalnotice> - 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. - - </legalnotice> - - <title>cosEvent Release Notes</title> - <prepared></prepared> - <responsible></responsible> - <docno></docno> - <approved></approved> - <checked></checked> - <date>99-02-12</date> - <rev>A</rev> - <file>notes.xml</file> - </header> - - <section><title>cosEvent 2.2.2</title> - - <section><title>Fixed Bugs and Malfunctions</title> - <list> - <item> - <p> Removed all old unused files in the documentation. - </p> - <p> - Own Id: OTP-14475 Aux Id: ERL-409, PR-1493 </p> - </item> - </list> - </section> - -</section> - -<section><title>cosEvent 2.2.1</title> - - <section><title>Improvements and New Features</title> - <list> - <item> - <p> - Internal changes</p> - <p> - Own Id: OTP-13551</p> - </item> - </list> - </section> - -</section> - -<section><title>cosEvent 2.2</title> - - <section><title>Improvements and New Features</title> - <list> - <item> - <p> Remove the usage of erlang:now() from all Corba - applications and use the new rand module instead of - random. </p> - <p> - Own Id: OTP-12687</p> - </item> - </list> - </section> - -</section> - -<section><title>cosEvent 2.1.15</title> - - <section><title>Improvements and New Features</title> - <list> - <item> - <p> The default encoding of Erlang files has been changed - from ISO-8859-1 to UTF-8. </p> <p> The encoding of XML - files has also been changed to UTF-8. </p> - <p> - Own Id: OTP-10907</p> - </item> - </list> - </section> - -</section> - -<section><title>cosEvent 2.1.14</title> - - <section><title>Improvements and New Features</title> - <list> - <item> - <p> Postscript files no longer needed for the generation - of PDF files have been removed. </p> - <p> - Own Id: OTP-11016</p> - </item> - </list> - </section> - -</section> - -<section><title>cosEvent 2.1.13</title> - - <section><title>Improvements and New Features</title> - <list> - <item> - <p> - Misc build updates</p> - <p> - Own Id: OTP-10784</p> - </item> - </list> - </section> - -</section> - -<section><title>cosEvent 2.1.12</title> - - <section><title>Improvements and New Features</title> - <list> - <item> - <p>Erlang/OTP can now be built using parallel make if you - limit the number of jobs, for instance using '<c>make - -j6</c>' or '<c>make -j10</c>'. '<c>make -j</c>' does not - work at the moment because of some missing - dependencies.</p> - <p> - Own Id: OTP-9451</p> - </item> - </list> - </section> - -</section> - -<section> - <title>cosEvent 2.1.11</title> - - <section> - <title>Improvements and New Features</title> - <list type="bulleted"> - <item> - <p> - Removed superfluous usage of shy in the documentation since it can cause problem if - a buggy tool is used.</p> - <p> - Own Id: OTP-9319 Aux Id:</p> - </item> - </list> - </section> - </section> - - <section> - <title>cosEvent 2.1.10</title> - - <section> - <title>Improvements and New Features</title> - <list type="bulleted"> - <item> - <p> - Eliminated Dialyzer warnings when using exit or throw.</p> - <p> - Own Id: OTP-9050 Aux Id:</p> - </item> - </list> - </section> - </section> - - <section> - <title>cosEvent 2.1.9</title> - - <section> - <title>Improvements and New Features</title> - <list type="bulleted"> - <item> - <p> - Test suites published.</p> - <p> - Own Id: OTP-8543 Aux Id:</p> - </item> - </list> - </section> - </section> - - <section> - <title>cosEvent 2.1.8</title> - - <section> - <title>Improvements and New Features</title> - <list type="bulleted"> - <item> - <p> - Removed the usage of the codeinclude tag in the documentation.</p> - <p> - Own Id: OTP-8409 Aux Id:</p> - </item> - </list> - </section> - </section> - - <section> - <title>cosEvent 2.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>cosEvent 2.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>cosEvent 2.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>cosEvent 2.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>cosEvent 2.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>cosEvent 2.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>cosEvent 2.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>cosEvent 2.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>cosEvent 2.0</title> - - <section> - <title>Fixed Bugs and Malfunctions</title> - <list type="bulleted"> - <item> - <p>This version is a completely new version of the cosEvent - application; older versions was <em>not</em> compliant with the OMG - specification. The <c><![CDATA[look and feel]]></c> have been changed - to be more uniform with the other COS-services.</p> - </item> - </list> - </section> - </section> -</chapter> - diff --git a/lib/cosEvent/doc/src/part.xml b/lib/cosEvent/doc/src/part.xml deleted file mode 100644 index 5e32455ebb..0000000000 --- a/lib/cosEvent/doc/src/part.xml +++ /dev/null @@ -1,40 +0,0 @@ -<?xml version="1.0" encoding="utf-8" ?> -<!DOCTYPE part SYSTEM "part.dtd"> - -<part xmlns:xi="http://www.w3.org/2001/XInclude"> - <header> - <copyright> - <year>1999</year><year>2016</year> - <holder>Ericsson AB. All Rights Reserved.</holder> - </copyright> - <legalnotice> - 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. - - </legalnotice> - - <title>cosEvent User's Guide</title> - <prepared></prepared> - <docno></docno> - <date>1998-04-26</date> - <rev>1.0</rev> - <file>part.xml</file> - </header> - <description> - <p>The <em>cosEvent</em> application is an Erlang implementation of a - CORBA Service CosEvent.</p> - </description> - <xi:include href="ch_contents.xml"/> - <xi:include href="ch_introduction.xml"/> - <xi:include href="ch_event_service.xml"/> -</part> - diff --git a/lib/cosEvent/doc/src/ref_man.xml b/lib/cosEvent/doc/src/ref_man.xml deleted file mode 100644 index 5db5626478..0000000000 --- a/lib/cosEvent/doc/src/ref_man.xml +++ /dev/null @@ -1,46 +0,0 @@ -<?xml version="1.0" encoding="utf-8" ?> -<!DOCTYPE application SYSTEM "application.dtd"> - -<application xmlns:xi="http://www.w3.org/2001/XInclude"> - <header> - <copyright> - <year>1999</year><year>2016</year> - <holder>Ericsson AB. All Rights Reserved.</holder> - </copyright> - <legalnotice> - 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. - - </legalnotice> - - <title>cosEvent Reference Manual</title> - <prepared></prepared> - <docno></docno> - <date>1998-05-05</date> - <rev>2.0</rev> - <file>ref_man.xml</file> - </header> - <description> - <p>The <em>cosEvent</em> application is an Erlang implementation of - a CORBA Service CosEvent.</p> - </description> - <xi:include href="cosEventApp.xml"/> - <xi:include href="CosEventChannelAdmin.xml"/> - <xi:include href="CosEventChannelAdmin_ConsumerAdmin.xml"/> - <xi:include href="CosEventChannelAdmin_SupplierAdmin.xml"/> - <xi:include href="CosEventChannelAdmin_EventChannel.xml"/> - <xi:include href="CosEventChannelAdmin_ProxyPullConsumer.xml"/> - <xi:include href="CosEventChannelAdmin_ProxyPushConsumer.xml"/> - <xi:include href="CosEventChannelAdmin_ProxyPullSupplier.xml"/> - <xi:include href="CosEventChannelAdmin_ProxyPushSupplier.xml"/> -</application> - |
