diff options
Diffstat (limited to 'lib/cosNotification/doc')
46 files changed, 0 insertions, 6131 deletions
diff --git a/lib/cosNotification/doc/html/.gitignore b/lib/cosNotification/doc/html/.gitignore deleted file mode 100644 index e69de29bb2..0000000000 --- a/lib/cosNotification/doc/html/.gitignore +++ /dev/null diff --git a/lib/cosNotification/doc/man3/.gitignore b/lib/cosNotification/doc/man3/.gitignore deleted file mode 100644 index e69de29bb2..0000000000 --- a/lib/cosNotification/doc/man3/.gitignore +++ /dev/null diff --git a/lib/cosNotification/doc/man6/.gitignore b/lib/cosNotification/doc/man6/.gitignore deleted file mode 100644 index e69de29bb2..0000000000 --- a/lib/cosNotification/doc/man6/.gitignore +++ /dev/null diff --git a/lib/cosNotification/doc/pdf/.gitignore b/lib/cosNotification/doc/pdf/.gitignore deleted file mode 100644 index e69de29bb2..0000000000 --- a/lib/cosNotification/doc/pdf/.gitignore +++ /dev/null diff --git a/lib/cosNotification/doc/src/CosNotification.xml b/lib/cosNotification/doc/src/CosNotification.xml deleted file mode 100644 index 6aac312d5e..0000000000 --- a/lib/cosNotification/doc/src/CosNotification.xml +++ /dev/null @@ -1,235 +0,0 @@ -<?xml version="1.0" encoding="utf-8" ?> -<!DOCTYPE erlref SYSTEM "erlref.dtd"> - -<erlref> - <header> - <copyright> - <year>2002</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>CosNotification</title> - <prepared>Niclas Eklund</prepared> - <responsible>Niclas Eklund</responsible> - <docno></docno> - <approved>Niclas Eklund</approved> - <checked></checked> - <date>2002-02-05</date> - <rev>PA1</rev> - </header> - <module>CosNotification</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>hrl</c> files by using: <br></br> -<c>-include_lib("cosNotification/include/*.hrl").</c></p> - </description> - <funcs> - <func> - <name>'EventReliability'() -> string()</name> - <fsummary>Return the EventReliability QoS identifier</fsummary> - <desc> - <p>This function returns the EventReliability QoS identifier</p> - </desc> - </func> - <func> - <name>'BestEffort'() -> short()</name> - <fsummary>Return the BestEffort QoS value</fsummary> - <desc> - <p>This function returns the BestEffort QoS value.</p> - </desc> - </func> - <func> - <name>'Persistent'() -> short()</name> - <fsummary>Return the Persistent QoS value</fsummary> - <desc> - <p>This function returns the Persistent QoS value.</p> - </desc> - </func> - <func> - <name>'ConnectionReliability'() -> string()</name> - <fsummary>Return the ConnectionReliability QoS identifier</fsummary> - <desc> - <p>This function returns the ConnectionReliability QoS identifier.</p> - </desc> - </func> - <func> - <name>'Priority'() -> string()</name> - <fsummary>Return the Priority QoS identifier</fsummary> - <desc> - <p>This function returns the Priority QoS identifier.</p> - </desc> - </func> - <func> - <name>'LowestPriority'() -> short()</name> - <fsummary>Return the LowestPriority QoS value</fsummary> - <desc> - <p>This function returns the LowestPriority QoS value.</p> - </desc> - </func> - <func> - <name>'HighestPriority'() -> short()</name> - <fsummary>Return the HighestPriority QoS value</fsummary> - <desc> - <p>This function returns the HighestPriority QoS value.</p> - </desc> - </func> - <func> - <name>'DefaultPriority'() -> short()</name> - <fsummary>Return the DefaultPriority QoS value</fsummary> - <desc> - <p>This function returns the DefaultPriority QoS value.</p> - </desc> - </func> - <func> - <name>'StartTime'() -> string()</name> - <fsummary>Return the StartTime QoS identifier</fsummary> - <desc> - <p>This function returns the StartTime QoS identifier.</p> - </desc> - </func> - <func> - <name>'StopTime'() -> string()</name> - <fsummary>Return the StopTime QoS identifier</fsummary> - <desc> - <p>This function returns the StopTime QoS identifier.</p> - </desc> - </func> - <func> - <name>'Timeout'() -> string()</name> - <fsummary>Return the Timeout QoS identifier</fsummary> - <desc> - <p>This function returns the Timeout QoS identifier.</p> - </desc> - </func> - <func> - <name>'OrderPolicy'() -> string()</name> - <fsummary>Return the OrderPolicy QoS identifier</fsummary> - <desc> - <p>This function returns the OrderPolicy QoS identifier.</p> - </desc> - </func> - <func> - <name>'AnyOrder'() -> short()</name> - <fsummary>Return the AnyOrder QoS value</fsummary> - <desc> - <p>This function returns the AnyOrder QoS value.</p> - </desc> - </func> - <func> - <name>'FifoOrder'() -> short()</name> - <fsummary>Return the FifoOrder QoS value</fsummary> - <desc> - <p>This function returns the FifoOrder QoS value.</p> - </desc> - </func> - <func> - <name>'PriorityOrder'() -> short()</name> - <fsummary>Return the PriorityOrder QoS value</fsummary> - <desc> - <p>This function returns the PriorityOrder QoS value.</p> - </desc> - </func> - <func> - <name>'DeadlineOrder'() -> short()</name> - <fsummary>Return the DeadlineOrder QoS value</fsummary> - <desc> - <p>This function returns the DeadlineOrder QoS value.</p> - </desc> - </func> - <func> - <name>'DiscardPolicy'() -> string()</name> - <fsummary>Return the DiscardPolicy QoS identifier</fsummary> - <desc> - <p>This function returns the DiscardPolicy QoS identifier.</p> - </desc> - </func> - <func> - <name>'LifoOrder'() -> short()</name> - <fsummary>Return the LifoOrder QoS value</fsummary> - <desc> - <p>This function returns the LifoOrder QoS value.</p> - </desc> - </func> - <func> - <name>'RejectNewEvents'() -> short()</name> - <fsummary>Return the RejectNewEvents QoS value</fsummary> - <desc> - <p>This function returns the RejectNewEvents QoS value.</p> - </desc> - </func> - <func> - <name>'MaximumBatchSize'() -> string()</name> - <fsummary>Return the MaximumBatchSize QoS identifier</fsummary> - <desc> - <p>This function returns the MaximumBatchSize QoS identifier.</p> - </desc> - </func> - <func> - <name>'PacingInterval'() -> string()</name> - <fsummary>Return the PacingInterval QoS identifier</fsummary> - <desc> - <p>This function returns the PacingInterval QoS identifier.</p> - </desc> - </func> - <func> - <name>'StartTimeSupported'() -> string()</name> - <fsummary>Return the StartTimeSupported QoS identifier</fsummary> - <desc> - <p>This function returns the StartTimeSupported QoS identifier.</p> - </desc> - </func> - <func> - <name>'StopTimeSupported'() -> string()</name> - <fsummary>Return the StopTimeSupported QoS identifier</fsummary> - <desc> - <p>This function returns the StopTimeSupported QoS identifier.</p> - </desc> - </func> - <func> - <name>'MaxEventsPerConsumer'() -> string()</name> - <fsummary>Return the MaxEventsPerConsumer QoS identifier</fsummary> - <desc> - <p>This function returns the MaxEventsPerConsumer QoS identifier.</p> - </desc> - </func> - <func> - <name>'MaxQueueLength'() -> string()</name> - <fsummary>Return the MaxQueueLength Admin identifier</fsummary> - <desc> - <p>This function returns the MaxQueueLength Admin identifier.</p> - </desc> - </func> - <func> - <name>'MaxConsumers'() -> string()</name> - <fsummary>Return the MaxConsumers Admin identifier</fsummary> - <desc> - <p>This function returns the MaxConsumers Admin identifier.</p> - </desc> - </func> - <func> - <name>'MaxSuppliers'() -> string()</name> - <fsummary>Return the MaxSuppliers Admin identifier</fsummary> - <desc> - <p>This function returns the MaxSuppliers Admin identifier.</p> - </desc> - </func> - </funcs> - -</erlref> - diff --git a/lib/cosNotification/doc/src/CosNotification_AdminPropertiesAdmin.xml b/lib/cosNotification/doc/src/CosNotification_AdminPropertiesAdmin.xml deleted file mode 100644 index 6086402f1a..0000000000 --- a/lib/cosNotification/doc/src/CosNotification_AdminPropertiesAdmin.xml +++ /dev/null @@ -1,79 +0,0 @@ -<?xml version="1.0" encoding="utf-8" ?> -<!DOCTYPE erlref SYSTEM "erlref.dtd"> - -<erlref> - <header> - <copyright> - <year>2000</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>CosNotification_AdminPropertiesAdmin</title> - <prepared></prepared> - <responsible></responsible> - <docno></docno> - <approved>Niclas Eklund</approved> - <checked></checked> - <date>2000-02-01</date> - <rev>1.0</rev> - </header> - <module>CosNotification_AdminPropertiesAdmin</module> - <modulesummary>This module implements the OMG CosNotification::AdminPropertiesAdmin interface.</modulesummary> - <description> - <p>To get access to the record definitions for the structures use: <br></br> -<c>-include_lib("cosNotification/include/*.hrl").</c></p> - <p>All objects, which inherit this interface, export functions described in this module.</p> - </description> - <funcs> - <func> - <name>get_admin(Object) -> AdminProperties</name> - <fsummary>Return a list of <c>AdminProperties</c>associated with the target object</fsummary> - <type> - <v>Object = #objref</v> - <v>AdminProperties = [AdminProperty]</v> - <v>AdminProperty = #'CosNotification_Property'{name, value}</v> - <v>name = string()</v> - <v>value = #any</v> - </type> - <desc> - <p>This operation returns sequence of name-value pairs which encapsulates the - current administrative properties of the target object.</p> - </desc> - </func> - <func> - <name>set_admin(Object, AdminProperties) -> Reply</name> - <fsummary>Update the <c>AdminProperties</c>for the target object</fsummary> - <type> - <v>Object = #objref</v> - <v>AdminProperties = [AdminProperty]</v> - <v>AdminProperty = #'CosNotification_Property'{name, value}</v> - <v>name = string()</v> - <v>value = #any</v> - <v>Reply = ok | {'EXCEPTION', CosNotification_UnsupportedAdmin}</v> - </type> - <desc> - <p>As input, this operation accepts a sequence of name-value pairs encapsulating the - desired administrative settings for the target object. If it is not possible to - set the given properties the exception <c>UnsupportedAdmin</c> will be raised.</p> - </desc> - </func> - </funcs> - -</erlref> - diff --git a/lib/cosNotification/doc/src/CosNotification_QoSAdmin.xml b/lib/cosNotification/doc/src/CosNotification_QoSAdmin.xml deleted file mode 100644 index 7774652e60..0000000000 --- a/lib/cosNotification/doc/src/CosNotification_QoSAdmin.xml +++ /dev/null @@ -1,107 +0,0 @@ -<?xml version="1.0" encoding="utf-8" ?> -<!DOCTYPE erlref SYSTEM "erlref.dtd"> - -<erlref> - <header> - <copyright> - <year>2000</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>CosNotification_QoSAdmin</title> - <prepared></prepared> - <docno></docno> - <checked></checked> - <date>2000-02-01</date> - <rev>1.0</rev> - </header> - <module>CosNotification_QoSAdmin</module> - <modulesummary>This module implements the OMG CosNotification::QoSAdmin interface.</modulesummary> - <description> - <p>To get access to the record definitions for the structures use: <br></br> -<c>-include_lib("cosNotification/include/*.hrl").</c></p> - <p>All objects, which inherit this interface, export functions described in this module.</p> - </description> - <funcs> - <func> - <name>get_qos(Object) -> Reply</name> - <fsummary>Return a list of name-value pairs which encapsulates the current QoS settings for the target object</fsummary> - <type> - <v>Object = #objref</v> - <v>Reply = [QoSProperty]</v> - <v>QoSProperty = #'CosNotification_Property'{name, value}</v> - <v>name = string()</v> - <v>value = #any</v> - </type> - <desc> - <p>This operation returns a list of name-value pairs which encapsulates the current QoS settings - for the target object.</p> - </desc> - </func> - <func> - <name>set_qos(Object, QoS) -> Reply</name> - <fsummary>Change the QoS settings for the target object</fsummary> - <type> - <v>Object = #objref</v> - <v>QoS = [QoSProperty]</v> - <v>QoSProperty = #'CosNotification_Property'{name, value}</v> - <v>name = string()</v> - <v>value = #any</v> - <v>Reply = ok | {'EXCEPTION', #'CosNotification_UnsupportedQoS'{qos_err}}</v> - <v>qos_err = PropertyErrorSeq</v> - <v>PropertyErrorSeq = [PropertyError]</v> - <v>PropertyError = #'CosNotification_PropertyError'{code, name, available_range}</v> - <v>code = 'UNSUPPORTED_PROPERTY' | 'UNAVAILABLE_PROPERTY' | 'UNSUPPORTED_VALUE' | 'UNAVAILABLE_VALUE' | 'BAD_PROPERTY' | 'BAD_TYPE' | 'BAD_VALUE'</v> - <v>name = string()</v> - <v>available_range = PropertyRange</v> - <v>PropertyRange = #CosNotification_PropertyRange{low_val, high_val}</v> - <v>low_val = high_val = #any</v> - </type> - <desc> - <p>To alter the current QoS settings for the target object this function must be used. - If it is not possible to set the requested QoS the <c>UnsupportedQoS</c> - exception is raised, which includes a sequence of <c>PropertyError</c>'s - describing which QoS, possible range and why is not allowed.</p> - </desc> - </func> - <func> - <name>validate_qos(Object, QoS) -> Reply</name> - <fsummary>Validate if the supplied QoS properties is valid for the target object </fsummary> - <type> - <v>Object = #objref</v> - <v>QoS = [QoSProperty]</v> - <v>QoSProperty = #'Property'{name, value}</v> - <v>name = string()</v> - <v>value = #any</v> - <v>Reply = {ok, NamedPropertyRangeSeq} | {'EXCEPTION', CosNotification_UnsupportedQoS{}}</v> - <v>NamedPropertyRangeSeq = [NamedPropertyRange]</v> - <v>NamedPropertyRange = #CosNotification_NamedPropertyRange{name, range}</v> - <v>name = string()</v> - <v>range = #CosNotification_PropertyRange{low_val, high_val}</v> - <v>low_val = #any</v> - <v>high_val = #any</v> - </type> - <desc> - <p>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> - </desc> - </func> - </funcs> - -</erlref> - diff --git a/lib/cosNotification/doc/src/CosNotifyChannelAdmin_ConsumerAdmin.xml b/lib/cosNotification/doc/src/CosNotifyChannelAdmin_ConsumerAdmin.xml deleted file mode 100644 index cbe22ce7cd..0000000000 --- a/lib/cosNotification/doc/src/CosNotifyChannelAdmin_ConsumerAdmin.xml +++ /dev/null @@ -1,242 +0,0 @@ -<?xml version="1.0" encoding="utf-8" ?> -<!DOCTYPE erlref SYSTEM "erlref.dtd"> - -<erlref> - <header> - <copyright> - <year>2000</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>CosNotifyChannelAdmin_ConsumerAdmin</title> - <prepared></prepared> - <responsible></responsible> - <docno></docno> - <approved></approved> - <checked></checked> - <date>2000-02-01</date> - <rev>1.0</rev> - </header> - <module>CosNotifyChannelAdmin_ConsumerAdmin</module> - <modulesummary>This module implements the OMG CosNotifyChannelAdmin::ConsumerAdmin interface.</modulesummary> - <description> - <p>To get access to the record definitions for the structures use: <br></br> -<c>-include_lib("cosNotification/include/*.hrl").</c></p> - <p>This module also exports the functions described in:</p> - <list type="bulleted"> - <item> - <p><seealso marker="CosNotification_QoSAdmin">CosNotification_QoSAdmin</seealso></p> - </item> - <item> - <p><seealso marker="CosNotifyComm_NotifySubscribe">CosNotifyComm_NotifySubscribe</seealso></p> - </item> - <item> - <p><seealso marker="CosNotifyFilter_FilterAdmin">CosNotifyFilter_FilterAdmin</seealso></p> - </item> - </list> - </description> - <funcs> - <func> - <name>_get_MyID(ConsumerAdmin) -> AdminID</name> - <fsummary>Return the target object's Id</fsummary> - <type> - <v>ConsumerAdmin = #objref</v> - <v>AdminID = long()</v> - </type> - <desc> - <p>The ID returned by the creating channel is equal to the value encapsulated by - this readonly attribute.</p> - </desc> - </func> - <func> - <name>_get_MyChannel(ConsumerAdmin) -> Channel</name> - <fsummary>Return the ancestor channel</fsummary> - <type> - <v>ConsumerAdmin = #objref</v> - <v>Channel = #objref</v> - </type> - <desc> - <p>The creating channel's reference is maintained by this readonly attribute.</p> - </desc> - </func> - <func> - <name>_get_MyOperator(ConsumerAdmin) -> OpType</name> - <fsummary>Return the filtering schema used by the target object</fsummary> - <type> - <v>ConsumerAdmin = #objref</v> - <v>OpType = 'AND_OP' | 'OR_OP'</v> - </type> - <desc> - <p>When <c>ConsumerAdmin's</c> are created an operation type, - i.e., <c>'AND_OP'</c> or <c>'OR_OP'</c>, is supplied, which determines - the semantics used by the target object concerning evaluation against - any associated <c>Filter</c> objects.</p> - </desc> - </func> - <func> - <name>_get_priority_filter(ConsumerAdmin) -> MappingFilter</name> - <fsummary>Return the associated priority <c>MappingFilter</c></fsummary> - <type> - <v>ConsumerAdmin = MappingFilter = #objref</v> - </type> - <desc> - <p>If set, this operation returns the associated priority <c>MappingFilter</c>, otherwise - a <c>NIL</c> object reference is returned.</p> - </desc> - </func> - <func> - <name>_set_priority_filter(ConsumerAdmin, MappingFilter) -> ok</name> - <fsummary>Set the priority <c>MappingFilter</c></fsummary> - <type> - <v>ConsumerAdmin = MappingFilter = #objref</v> - </type> - <desc> - <p>To associate a priority <c>MappingFilter</c> with the target object this operation - must be used.</p> - </desc> - </func> - <func> - <name>_get_lifetime_filter(ConsumerAdmin) -> MappingFilter</name> - <fsummary>Return the associated lifetime <c>MappingFilter</c></fsummary> - <type> - <v>ConsumerAdmin = MappingFilter = #objref</v> - </type> - <desc> - <p>Unless a lifetime <c>MappingFilter</c> have been associated with the target object - a <c>NIL</c> object reference is returned by this operation.</p> - </desc> - </func> - <func> - <name>_set_lifetime_filter(ConsumerAdmin, MappingFilter) -> ok</name> - <fsummary>Set the lifetime <c>MappingFilter</c></fsummary> - <type> - <v>ConsumerAdmin = MappingFilter = #objref</v> - </type> - <desc> - <p>This operation associate a lifetime <c>MappingFilter</c> with the target object.</p> - </desc> - </func> - <func> - <name>_get_pull_suppliers(ConsumerAdmin) -> ProxyIDSeq</name> - <fsummary>Return a list of all associated pull supplier Id:s</fsummary> - <type> - <v>ConsumerAdmin = #objref</v> - <v>ProxyIDSeq = [ProxyID]</v> - <v>ProxyID = long()</v> - </type> - <desc> - <p>This readonly attribute maintains the Id's for all <c>PullProxies</c> created - by the target object and still alive.</p> - </desc> - </func> - <func> - <name>_get_push_suppliers(ConsumerAdmin) -> ProxyIDSeq</name> - <fsummary>Return a list of all associated push supplier Id:s</fsummary> - <type> - <v>ConsumerAdmin = #objref</v> - <v>ProxyIDSeq = [ProxyID]</v> - <v>ProxyID = long()</v> - </type> - <desc> - <p>This attribute is similar to the <c>_get_pull_suppliers</c> attribute but maintains - the Id's for all <c>PushProxies</c> created by the target object and still alive.</p> - </desc> - </func> - <func> - <name>get_proxy_supplier(ConsumerAdmin, ProxyID) -> Reply</name> - <fsummary>Return the proxy supplier with matching Id</fsummary> - <type> - <v>ConsumerAdmin = #objref</v> - <v>ProxyID = long()</v> - <v>Reply = Proxy | {'EXCEPTION', #'CosNotifyChannelAdmin_ProxyNotFound'{}}</v> - <v>Proxy = #objref</v> - </type> - <desc> - <p>If a proxy with the given Id exists the reference to the object is returned, but if - the object have terminated, or an incorrect Id is supplied, an exception is raised.</p> - </desc> - </func> - <func> - <name>obtain_notification_pull_supplier(ConsumerAdmin, ConsumerType) -> Reply</name> - <fsummary>Create a supplier proxy</fsummary> - <type> - <v>ConsumerAdmin = #objref</v> - <v>ConsumerType = 'ANY_EVENT' | 'STRUCTURED_EVENT' | 'SEQUENCE_EVENT'</v> - <v>Reply = {Proxy, ProxyID}</v> - <v>Proxy = #objref</v> - <v>ProxyID = long()</v> - </type> - <desc> - <p>Determined by the parameter <c>ConsumerType</c>, a proxy which will - accept events of the defined type is created. Along with the object reference an - Id is returned. </p> - </desc> - </func> - <func> - <name>obtain_pull_supplier(ConsumerAdmin) -> Proxy</name> - <fsummary>Create a supplier proxy</fsummary> - <type> - <v>ConsumerAdmin = #objref</v> - <v>Proxy = #objref</v> - </type> - <desc> - <p>This operation creates a new proxy which accepts <c>#any{}</c> events.</p> - </desc> - </func> - <func> - <name>obtain_notification_push_supplier(ConsumerAdmin, ConsumerType) -> Reply</name> - <fsummary>Create a supplier proxy</fsummary> - <type> - <v>ConsumerAdmin = #objref</v> - <v>ConsumerType = 'ANY_EVENT' | 'STRUCTURED_EVENT' | 'SEQUENCE_EVENT'</v> - <v>Reply = {Proxy, ProxyID}</v> - <v>Proxy = #objref</v> - <v>ProxyID = long()</v> - </type> - <desc> - <p>A proxy which accepts events of the type described by the parameter <c>ConsumerType</c> - is created by this operation. A unique Id is returned as an out parameter.</p> - </desc> - </func> - <func> - <name>obtain_push_supplier(ConsumerAdmin) -> Proxy</name> - <fsummary>Create a supplier proxy</fsummary> - <type> - <v>ConsumerAdmin = #objref</v> - <v>Proxy = #objref</v> - </type> - <desc> - <p>The object created by this function is a proxy which accepts <c>#any{}</c> events.</p> - </desc> - </func> - <func> - <name>destroy(ConsumerAdmin) -> ok</name> - <fsummary>Terminate the target object and all its children</fsummary> - <type> - <v>ConsumerAdmin = #objref</v> - </type> - <desc> - <p>To terminate the target object this operation should be used. The associated - <c>Channel</c> will be notified.</p> - </desc> - </func> - </funcs> - -</erlref> - diff --git a/lib/cosNotification/doc/src/CosNotifyChannelAdmin_EventChannel.xml b/lib/cosNotification/doc/src/CosNotifyChannelAdmin_EventChannel.xml deleted file mode 100644 index 7696e6a26c..0000000000 --- a/lib/cosNotification/doc/src/CosNotifyChannelAdmin_EventChannel.xml +++ /dev/null @@ -1,226 +0,0 @@ -<?xml version="1.0" encoding="utf-8" ?> -<!DOCTYPE erlref SYSTEM "erlref.dtd"> - -<erlref> - <header> - <copyright> - <year>2000</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>CosNotifyChannelAdmin_EventChannel</title> - <prepared></prepared> - <docno></docno> - <checked></checked> - <date>2000-02-01</date> - <rev>1.0</rev> - </header> - <module>CosNotifyChannelAdmin_EventChannel</module> - <modulesummary>This module implements the OMG CosNotifyChannelAdmin::EventChannel interface.</modulesummary> - <description> - <p>To get access to the record definitions for the structures use: <br></br> -<c>-include_lib("cosNotification/include/*.hrl").</c></p> - <p>This module also exports the functions described in:</p> - <list type="bulleted"> - <item> - <p><seealso marker="CosNotification_QoSAdmin">CosNotification_QoSAdmin</seealso></p> - </item> - <item> - <p><seealso marker="CosNotification_AdminPropertiesAdmin">CosNotification_AdminPropertiesAdmin</seealso></p> - </item> - </list> - </description> - <funcs> - <func> - <name>_get_MyFactory(Channel) -> ChannelFactory</name> - <fsummary>Return the factory object which created the target object</fsummary> - <type> - <v>Channel = #objref</v> - <v>ChannelFactory = #objref</v> - </type> - <desc> - <p>This readonly attribute maintains the reference of the event channel - factory that created the target channel.</p> - </desc> - </func> - <func> - <name>_get_default_consumer_admin(Channel) -> ConsumerAdmin</name> - <fsummary>Return the default consumer admin associated with the target object</fsummary> - <type> - <v>Channel = #objref</v> - <v>ConsumerAdmin = #objref</v> - </type> - <desc> - <p>This is a readonly attribute which maintains a reference to a default - <c>ConsumerAdmin</c> object associated with the target object.</p> - </desc> - </func> - <func> - <name>_get_default_supplier_admin(Channel) -> SupplierAdmin</name> - <fsummary>Return the default supplier admin associated with the target object</fsummary> - <type> - <v>Channel = #objref</v> - <v>SupplierAdmin = #objref</v> - </type> - <desc> - <p>This is a readonly attribute which maintains a reference to a default - <c>SupplierAdmin</c> object associated with the target object.</p> - </desc> - </func> - <func> - <name>_get_default_filter_factory(Channel) -> FilterFactory</name> - <fsummary>Return the default filter factory associated with the target object</fsummary> - <type> - <v>Channel = #objref</v> - <v>FilterFactory = #objref</v> - </type> - <desc> - <p>The default <c>FilterFactory</c> associated with the target channel - is maintained by this readonly attribute.</p> - </desc> - </func> - <func> - <name>new_for_consumers(Channel, OpType) -> Return</name> - <fsummary>Create a new <c>ConsumerAdmin</c>object</fsummary> - <type> - <v>Channel = #objref</v> - <v>OpType = 'AND_OP' | 'OR_OP'</v> - <v>Return = {ConsumerAdmin, AdminID}</v> - <v>ConsumerAdmin = #objref</v> - <v>AdminID = long()</v> - </type> - <desc> - <p>This operation creates a new instance of a <c>ConsumerAdmin</c> and supplies - an Id which may be used when invoking other operations exported by this module. - The returned object will inherit the Quality of Service properties of the - target channel.</p> - </desc> - </func> - <func> - <name>for_consumers(Channel) -> ConsumerAdmin</name> - <fsummary>Create a new <c>ConsumerAdmin</c>object</fsummary> - <type> - <v>Channel = #objref</v> - <v>ConsumerAdmin = #objref</v> - </type> - <desc> - <p>A new new instance of a <c>ConsumerAdmin</c> object is created but no - Id is returned. The returned object's operation type, i.e., <c>'AND_OP'</c> or <c>'OR_OP'</c>, - will be set to the value of the configuration parameter <c>filterOp</c>. - The target object's Quality of Service properties will be inherited by the - returned <c>ConsumerAdmin</c>.</p> - </desc> - </func> - <func> - <name>new_for_suppliers(Channel, OpType) -> Return</name> - <fsummary>Create a new <c>SupplierAdmin</c>object</fsummary> - <type> - <v>Channel = #objref</v> - <v>OpType = 'AND_OP' | 'OR_OP'</v> - <v>Return = {SupplierAdmin, AdminID}</v> - <v>SupplierAdmin = #objref</v> - <v>AdminID = long()</v> - </type> - <desc> - <p>Enables us to create a new instance of a <c>SupplierAdmin</c>. An Id, which - may be used when invoking other operations exported by this module, is also - returned. The current Quality of Service settings associated with the target - object will be inherited by the <c>SupplierAdmin</c>.</p> - </desc> - </func> - <func> - <name>for_suppliers(Channel) -> SupplierAdmin</name> - <fsummary>Create a new <c>SupplierAdmin</c>object</fsummary> - <type> - <v>Channel = #objref</v> - <v>SupplierAdmin = #objref</v> - </type> - <desc> - <p>To create a new <c>SupplierAdmin</c> with the target object's current - Quality of Service settings we can use this function. The returned object's - operation type (<c>'AND_OP'</c> or <c>'OR_OP'</c>) will be determined by the - configuration variable <c>filterOp</c>.</p> - </desc> - </func> - <func> - <name>get_consumeradmin(Channel, AdminID) -> ConsumerAdmin</name> - <fsummary>Return the <c>ConsumerAdmin</c>matching AdminID</fsummary> - <type> - <v>Channel = #objref</v> - <v>AdminID = long()</v> - <v>ConsumerAdmin = #objref | {'EXCEPTION', #'CosNotifyChannelAdmin_AdminNotFound'{}}</v> - </type> - <desc> - <p>If the given Id is associated with a <c>ConsumerAdmin</c> the object reference - is returned. If such association never existed or the <c>ConsumerAdmin</c> - have terminated an exception is raised.</p> - </desc> - </func> - <func> - <name>get_supplieradmin(Channel, AdminID) -> SupplierAdmin</name> - <fsummary>Return the <c>SupplierAdmin</c>matching AdminID</fsummary> - <type> - <v>Channel = #objref</v> - <v>AdminID = long()</v> - <v>SupplierAdmin = #objref | {'EXCEPTION', #'CosNotifyChannelAdmin_AdminNotFound'{}}</v> - </type> - <desc> - <p>Equal to the operation <c>get_consumeradmin/2</c> but a reference to - a <c>SupplierAdmin</c> is returned.</p> - </desc> - </func> - <func> - <name>get_all_consumeradmins(Channel) -> Reply</name> - <fsummary>Return a list of all <c>ConsumerAdmins</c>, currently active, Id:s</fsummary> - <type> - <v>Channel = #objref</v> - <v>Reply = [AdminID]</v> - <v>AdminID = long()</v> - </type> - <desc> - <p>To get access to all <c>ConsumerAdmin</c> Id's created by the target object, and still - alive, this operation could be invoked.</p> - </desc> - </func> - <func> - <name>get_all_supplieradmins(Channel) -> Reply</name> - <fsummary>Return a list of all <c>SupplierAdmins</c>, currently active, Id:s</fsummary> - <type> - <v>Channel = #objref</v> - <v>Reply = [AdminID]</v> - <v>AdminID = long()</v> - </type> - <desc> - <p>Equal to the operation <c>get_all_consumeradmins/1</c> but returns - a list of all <c>SupplierAdmin</c> object ID's.</p> - </desc> - </func> - <func> - <name>destroy(Channel) -> ok</name> - <fsummary>Terminate the channel and all its children</fsummary> - <type> - <v>Channel = #objref</v> - </type> - <desc> - <p>The <c>destroy</c> operation will terminate the target channel and - all associated Admin objects.</p> - </desc> - </func> - </funcs> - -</erlref> - diff --git a/lib/cosNotification/doc/src/CosNotifyChannelAdmin_EventChannelFactory.xml b/lib/cosNotification/doc/src/CosNotifyChannelAdmin_EventChannelFactory.xml deleted file mode 100644 index 552ea182c0..0000000000 --- a/lib/cosNotification/doc/src/CosNotifyChannelAdmin_EventChannelFactory.xml +++ /dev/null @@ -1,89 +0,0 @@ -<?xml version="1.0" encoding="utf-8" ?> -<!DOCTYPE erlref SYSTEM "erlref.dtd"> - -<erlref> - <header> - <copyright> - <year>2000</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>CosNotifyChannelAdmin_EventChannelFactory</title> - <prepared></prepared> - <docno></docno> - <checked></checked> - <date>2000-02-01</date> - <rev>1.0</rev> - </header> - <module>CosNotifyChannelAdmin_EventChannelFactory</module> - <modulesummary>This module implements the OMG CosNotifyChannelAdmin::EventChannelFactory interface.</modulesummary> - <description> - <p>To get access to the record definitions for the structures use: <br></br> -<c>-include_lib("cosNotification/include/*.hrl").</c></p> - </description> - <funcs> - <func> - <name>create_channel(ChannelFactory, InitialQoS, InitialAdmin) -> Return</name> - <fsummary>Create a new channel</fsummary> - <type> - <v>ChannelFactory = #objref</v> - <v>InitialQoS = CosNotification::QoSProperties</v> - <v>InitialAdmin = CosNotification::AdminProperties</v> - <v>Return = {EventChannel, ChannelID}</v> - <v>EventChannel = #objref</v> - <v>ChannelID = long()</v> - </type> - <desc> - <p>This operation creates a new event channel. Along with the channel - reference an id is returned which can be used when invoking other - operations exported by this module. The Quality of Service argument - supplied will be inherited by objects created by the channel. For more - information about QoS settings see the <c>User's Guide</c>.</p> - <p>If no QoS- and/or Admin-properties are supplied (i.e. empty list), - the <em>default</em> settings will be used. For more information, see the - User's Guide.</p> - </desc> - </func> - <func> - <name>get_all_channels(ChannelFactory) -> ChannelIDSeq</name> - <fsummary>Return all Id:s for channels, currently alive, created by the target object</fsummary> - <type> - <v>ChannelFactory = #objref</v> - <v>ChannelIDSeq = [long()]</v> - </type> - <desc> - <p>This operation returns a id sequence of all channel's created by this ChannelFactory.</p> - </desc> - </func> - <func> - <name>get_event_channel(ChannelFactory, ChannelID) -> Return</name> - <fsummary>Return the channel object associated with the given Id</fsummary> - <type> - <v>ChannelFactory = #objref</v> - <v>ChannelID = long()</v> - <v>Retrurn = EventChannel | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}</v> - <v>EventChannel = #objref</v> - </type> - <desc> - <p>This operation returns the EventChannel associated with the given id. If no channel is - associated with the id, i.e., never existed or have been terminated, an exception is raised.</p> - </desc> - </func> - </funcs> - -</erlref> - diff --git a/lib/cosNotification/doc/src/CosNotifyChannelAdmin_ProxyConsumer.xml b/lib/cosNotification/doc/src/CosNotifyChannelAdmin_ProxyConsumer.xml deleted file mode 100644 index 3d61893162..0000000000 --- a/lib/cosNotification/doc/src/CosNotifyChannelAdmin_ProxyConsumer.xml +++ /dev/null @@ -1,128 +0,0 @@ -<?xml version="1.0" encoding="utf-8" ?> -<!DOCTYPE erlref SYSTEM "erlref.dtd"> - -<erlref> - <header> - <copyright> - <year>2000</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>CosNotifyChannelAdmin_ProxyConsumer</title> - <prepared></prepared> - <responsible></responsible> - <docno></docno> - <approved></approved> - <checked></checked> - <date>2000-02-01</date> - <rev>1.0</rev> - </header> - <module>CosNotifyChannelAdmin_ProxyConsumer</module> - <modulesummary>This module implements the OMG CosNotifyChannelAdmin::ProxyConsumer interface.</modulesummary> - <description> - <p>To get access to the record definitions for the structures use: <br></br> -<c>-include_lib("cosNotification/include/*.hrl").</c></p> - <p>This module also exports the functions described in:</p> - <list type="bulleted"> - <item> - <p><seealso marker="CosNotification_QoSAdmin">CosNotification_QoSAdmin</seealso></p> - </item> - <item> - <p><seealso marker="CosNotifyFilter_FilterAdmin">CosNotifyFilter_FilterAdmin</seealso></p> - </item> - </list> - </description> - <funcs> - <func> - <name>_get_MyType(ProxyConsumer) -> ProxyType</name> - <fsummary>Return the proxy type</fsummary> - <type> - <v>ProxyConsumer = #objref</v> - <v>ProxyType = 'PUSH_ANY' | 'PULL_ANY' | 'PUSH_STRUCTURED' | 'PULL_STRUCTURED' | 'PUSH_SEQUENCE' | 'PULL_SEQUENCE'</v> - </type> - <desc> - <p>This readonly attribute maintains the enumerant describing the which type the target object - is. </p> - </desc> - </func> - <func> - <name>_get_MyAdmin(ProxyConsumer) -> AdminObject</name> - <fsummary>return the associated <c>Admin</c>object</fsummary> - <type> - <v>ProxyConsumer = AdminObject = #objref</v> - </type> - <desc> - <p>This readonly attribute maintains the admin's reference which created the target object.</p> - </desc> - </func> - <func> - <name>obtain_subscription_types(ProxyConsumer, ObtainInfoMode) -> EventTypeSeq</name> - <fsummary>Administer subscription types</fsummary> - <type> - <v>ProxyConsumer = #objref</v> - <v>ObtainInfoMode = 'ALL_NOW_UPDATES_OFF' | 'ALL_NOW_UPDATES_ON' | 'NONE_NOW_UPDATES_OFF' | 'NONE_NOW_UPDATES_ON'</v> - <v>EventTypeSeq = [EventType]</v> - <v>EventType = #'CosNotification_EventType'{domain_name, type_name}</v> - <v>domain_name = type_name = string()</v> - </type> - <desc> - <p>Depending on the input parameter <c>ObtainInfoMode</c>, this operation may return a - sequence of the <c>EventTypes</c> the target object is interested in receiving. - If <c>'ALL_NOW_UPDATES_OFF'</c> or <c>'ALL_NOW_UPDATES_ON'</c> is given a sequence will - be returned, otherwise not. If <c>'ALL_NOW_UPDATES_OFF'</c> or <c>'NONE_NOW_UPDATES_OFF'</c> - are issued the target object will not inform the associated <c>NotifySubscribe</c> object - when an update occurs. <c>'ALL_NOW_UPDATES_ON'</c> or <c>'NONE_NOW_UPDATES_ON'</c> will - result in that update information will be sent.</p> - </desc> - </func> - <func> - <name>validate_event_qos(ProxyConsumer, QoSProperties) -> Reply</name> - <fsummary>Check if certain Quality of Service properties can be added to events in the current context of the target object</fsummary> - <type> - <v>ProxyConsumer = #objref</v> - <v>QoSProperties = [QoSProperty]</v> - <v>QoSProperty = #'CosNotification_Property'{name, value}</v> - <v>name = string()</v> - <v>value = #any</v> - <v>Reply = {ok, NamedPropertyRangeSeq} | {'EXCEPTION', CosNotification_UnsupportedQoS{qos_err}}</v> - <v>NamedPropertyRangeSeq = [NamedPropertyRange]</v> - <v>NamedPropertyRange = #CosNotification_NamedPropertyRange{name, range}</v> - <v>name = string()</v> - <v>range = #CosNotification_PropertyRange{low_val, high_val}</v> - <v>low_val = #any</v> - <v>high_val = #any</v> - <v>qos_err = PropertyErrorSeq</v> - <v>PropertyErrorSeq = [PropertyError]</v> - <v>PropertyError = #'CosNotification_PropertyError'{code, name, available_range}</v> - <v>code = 'UNSUPPORTED_PROPERTY' | 'UNAVAILABLE_PROPERTY' | 'UNSUPPORTED_VALUE' | 'UNAVAILABLE_VALUE' | 'BAD_PROPERTY' | 'BAD_TYPE' | 'BAD_VALUE'</v> - <v>name = string()</v> - <v>available_range = PropertyRange</v> - <v>PropertyRange = #CosNotification_PropertyRange{low_val, high_val}</v> - <v>low_val = high_val = #any</v> - </type> - <desc> - <p>To check if certain Quality of Service properties can be added to events in - the current context of the target object this operation should be used. If we - cannot support the required settings an exception describing why will be raised.</p> - </desc> - </func> - </funcs> - -</erlref> - diff --git a/lib/cosNotification/doc/src/CosNotifyChannelAdmin_ProxyPullConsumer.xml b/lib/cosNotification/doc/src/CosNotifyChannelAdmin_ProxyPullConsumer.xml deleted file mode 100644 index caf572dee8..0000000000 --- a/lib/cosNotification/doc/src/CosNotifyChannelAdmin_ProxyPullConsumer.xml +++ /dev/null @@ -1,113 +0,0 @@ -<?xml version="1.0" encoding="utf-8" ?> -<!DOCTYPE erlref SYSTEM "erlref.dtd"> - -<erlref> - <header> - <copyright> - <year>2000</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>CosNotifyChannelAdmin_ProxyPullConsumer</title> - <prepared></prepared> - <responsible></responsible> - <docno></docno> - <approved></approved> - <checked></checked> - <date>2000-02-01</date> - <rev>1.0</rev> - </header> - <module>CosNotifyChannelAdmin_ProxyPullConsumer</module> - <modulesummary>This module implements the OMG CosNotifyChannelAdmin::ProxyPullConsumer interface.</modulesummary> - <description> - <p>To get access to the record definitions for the structures use: <br></br> -<c>-include_lib("cosNotification/include/*.hrl").</c></p> - <p>This module also exports the functions described in:</p> - <list type="bulleted"> - <item> - <p><seealso marker="CosNotifyComm_NotifyPublish">CosNotifyComm_NotifyPublish</seealso></p> - </item> - <item> - <p><seealso marker="CosNotification_QoSAdmin">CosNotification_QoSAdmin</seealso></p> - </item> - <item> - <p><seealso marker="CosNotifyFilter_FilterAdmin">CosNotifyFilter_FilterAdmin</seealso></p> - </item> - <item> - <p><seealso marker="CosNotifyChannelAdmin_ProxyConsumer">CosNotifyChannelAdmin_ProxyConsumer</seealso></p> - </item> - </list> - </description> - <funcs> - <func> - <name>connect_any_pull_supplier(ProxyPullConsumer, PullSupplier) -> Reply</name> - <fsummary>Connect a supplier to the proxy</fsummary> - <type> - <v>ProxyPullConsumer = #objref</v> - <v>PullSupplier = #objref</v> - <v>Reply = ok | {'EXCEPTION', #'CosEventChannelAdmin_AlreadyConnected'{}} | {'EXCEPTION', #'CosEventChannelAdmin_TypeError'{}}</v> - </type> - <desc> - <p>This operation connects the given <c>PullSupplier</c> to the target object. - If a client is already connected the <c>AlreadyConnected</c> exception - will be raised. The client must support the operations <c>pull</c> and - <c>try_pull</c>, otherwise the <c>TypeError</c> exception is raised.</p> - </desc> - </func> - <func> - <name>suspend_connection(ProxyPullConsumer) -> Reply</name> - <fsummary>Suspend the connection between the client and the proxy</fsummary> - <type> - <v>ProxyPullConsumer = #objref</v> - <v>Reply = ok | {'EXCEPTION', #'CosNotifyChannelAdmin_ConnectionAlreadyInactive'{}} | {'EXCEPTION', #'CosNotifyChannelAdmin_NotConnected'{}}</v> - </type> - <desc> - <p>If we want to temporarily suspend the connection with the target object this - operation must be sued. If the connection already have been suspended or - no client have been connected an exception is raised.</p> - </desc> - </func> - <func> - <name>resume_connection(ProxyPullConsumer) -> Reply</name> - <fsummary>Resume a previously suspended connection with the proxy</fsummary> - <type> - <v>ProxyPullConsumer = #objref</v> - <v>Reply = ok | {'EXCEPTION', #'CosNotifyChannelAdmin_ConnectionAlreadyActive'{}} | {'EXCEPTION', #'CosNotifyChannelAdmin_NotConnected'{}}</v> - </type> - <desc> - <p>If The connection have been suspended earlier we can invoke this operation to - reinstate the connection. If the connection already is active or no client - have been connected to the target object an exception is raised.</p> - </desc> - </func> - <func> - <name>disconnect_pull_consumer(ProxyPullConsumer) -> ok</name> - <fsummary>Close the connection and terminate the proxy</fsummary> - <type> - <v>ProxyPullConsumer = #objref</v> - </type> - <desc> - <p>Invoking this operation disconnects the client from the target object which - then terminates and inform its administrative parent.</p> - </desc> - </func> - </funcs> - -</erlref> - diff --git a/lib/cosNotification/doc/src/CosNotifyChannelAdmin_ProxyPullSupplier.xml b/lib/cosNotification/doc/src/CosNotifyChannelAdmin_ProxyPullSupplier.xml deleted file mode 100644 index 42aaaec319..0000000000 --- a/lib/cosNotification/doc/src/CosNotifyChannelAdmin_ProxyPullSupplier.xml +++ /dev/null @@ -1,112 +0,0 @@ -<?xml version="1.0" encoding="utf-8" ?> -<!DOCTYPE erlref SYSTEM "erlref.dtd"> - -<erlref> - <header> - <copyright> - <year>2000</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>CosNotifyChannelAdmin_ProxyPullSupplier</title> - <prepared></prepared> - <responsible></responsible> - <docno></docno> - <approved></approved> - <checked></checked> - <date>2000-02-01</date> - <rev>1.0</rev> - </header> - <module>CosNotifyChannelAdmin_ProxyPullSupplier</module> - <modulesummary>This module implements the OMG CosNotifyChannelAdmin::ProxyPullSupplier interface.</modulesummary> - <description> - <p>To get access to the record definitions for the structures use: <br></br> -<c>-include_lib("cosNotification/include/*.hrl").</c></p> - <p>This module also exports the functions described in:</p> - <list type="bulleted"> - <item> - <p><seealso marker="CosNotifyComm_NotifySubscribe">CosNotifyComm_NotifySubscribe</seealso></p> - </item> - <item> - <p><seealso marker="CosNotification_QoSAdmin">CosNotification_QoSAdmin</seealso></p> - </item> - <item> - <p><seealso marker="CosNotifyFilter_FilterAdmin">CosNotifyFilter_FilterAdmin</seealso></p> - </item> - <item> - <p><seealso marker="CosNotifyChannelAdmin_ProxySupplier">CosNotifyChannelAdmin_ProxySupplier</seealso></p> - </item> - </list> - </description> - <funcs> - <func> - <name>connect_any_pull_consumer(ProxyPullSupplier, PullConsumer) -> Reply</name> - <fsummary>Connect a consumer to the proxy</fsummary> - <type> - <v>ProxyPullSupplier = #objref</v> - <v>PullConsumer = #objref</v> - <v>Reply = ok | {'EXCEPTION', #'CosEventChannelAdmin_AlreadyConnected'{}}</v> - </type> - <desc> - <p>This operation connects the given <c>PullConsumer</c> to the target object. - If a connection already exists the <c>AlreadyConnected</c> exception is - raised.</p> - </desc> - </func> - <func> - <name>pull(ProxyPullSupplier) -> Reply</name> - <fsummary>Pull an Any event from the proxy</fsummary> - <type> - <v>ProxyPullSupplier = #objref</v> - <v>Reply = #any | {'EXCEPTION', #'CosEventChannelAdmin_Disconnected'{}}</v> - </type> - <desc> - <p>This operation pulls next <c>#any{}</c> event, and blocks, if the target object - have no events to forward, until an event can be delivered. If no client have - been connected the <c>Disconnected</c> exception is raised.</p> - </desc> - </func> - <func> - <name>try_pull(ProxyPullSupplier) -> Reply</name> - <fsummary>Try and pull an Any event from the proxy</fsummary> - <type> - <v>ProxyPullSupplier = #objref</v> - <v>Reply = {#any, HasEvent} | {'EXCEPTION', #'CosEventChannelAdmin_Disconnected'{}}</v> - <v>HasEvent = boolean()</v> - </type> - <desc> - <p>This operation pulls next event, but do not block if the target object - have no event to forward. If no client have - been connected the <c>Disconnected</c> exception is raised.</p> - </desc> - </func> - <func> - <name>disconnect_pull_supplier(ProxyPullSupplier) -> ok</name> - <fsummary>Close the connection and terminate the proxy</fsummary> - <type> - <v>ProxyPullSupplier = #objref</v> - </type> - <desc> - <p>Invoking this operation will cause the target object to close the connection and terminate.</p> - </desc> - </func> - </funcs> - -</erlref> - diff --git a/lib/cosNotification/doc/src/CosNotifyChannelAdmin_ProxyPushConsumer.xml b/lib/cosNotification/doc/src/CosNotifyChannelAdmin_ProxyPushConsumer.xml deleted file mode 100644 index 9808b460c7..0000000000 --- a/lib/cosNotification/doc/src/CosNotifyChannelAdmin_ProxyPushConsumer.xml +++ /dev/null @@ -1,98 +0,0 @@ -<?xml version="1.0" encoding="utf-8" ?> -<!DOCTYPE erlref SYSTEM "erlref.dtd"> - -<erlref> - <header> - <copyright> - <year>2000</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>CosNotifyChannelAdmin_ProxyPushConsumer</title> - <prepared></prepared> - <responsible></responsible> - <docno></docno> - <approved>Niclas Eklund</approved> - <checked></checked> - <date>2000-02-01</date> - <rev>1.0</rev> - </header> - <module>CosNotifyChannelAdmin_ProxyPushConsumer</module> - <modulesummary>This module implements the OMG CosNotifyChannelAdmin::ProxyPushConsumer interface.</modulesummary> - <description> - <p>To get access to the record definitions for the structures use: <br></br> -<c>-include_lib("cosNotification/include/*.hrl").</c></p> - <p>This module also exports the functions described in:</p> - <list type="bulleted"> - <item> - <p><seealso marker="CosNotifyComm_NotifyPublish">CosNotifyComm_NotifyPublish</seealso></p> - </item> - <item> - <p><seealso marker="CosNotification_QoSAdmin">CosNotification_QoSAdmin</seealso></p> - </item> - <item> - <p><seealso marker="CosNotifyFilter_FilterAdmin">CosNotifyFilter_FilterAdmin</seealso></p> - </item> - <item> - <p><seealso marker="CosNotifyChannelAdmin_ProxyConsumer">CosNotifyChannelAdmin_ProxyConsumer</seealso></p> - </item> - </list> - </description> - <funcs> - <func> - <name>connect_any_push_supplier(ProxyPushConsumer, PushSupplier) -> Reply</name> - <fsummary>Connect a supplier to the proxy</fsummary> - <type> - <v>ProxyPushConsumer = #objref</v> - <v>PushSupplier = #objref</v> - <v>Reply = ok | {'EXCEPTION', #'CosEventChannelAdmin_AlreadyConnected'{}}</v> - </type> - <desc> - <p>This operation connects a <c>PushSupplier</c> to the target object. If - a connection already exists the <c>AlreadyConnected</c> exception is raised.</p> - </desc> - </func> - <func> - <name>push(ProxyPushConsumer, Event) -> Reply</name> - <fsummary>Push an Any event to the proxy</fsummary> - <type> - <v>ProxyPushConsumer = #objref</v> - <v>Event = #any</v> - <v>Reply = ok | {'EXCEPTION', #'CosEventChannelAdmin_Disconnected'{}}</v> - </type> - <desc> - <p>This operation pushes an <c>#any{}</c> event to the target object. If no client - have been connected the <c>Disconnected</c> exception is raised.</p> - </desc> - </func> - <func> - <name>disconnect_push_consumer(ProxyPushConsumer) -> ok</name> - <fsummary>Close the connection and terminate the proxy</fsummary> - <type> - <v>ProxyPushConsumer = #objref</v> - </type> - <desc> - <p>Invoking this operation will cause the target object to close the connection and - terminate.</p> - </desc> - </func> - </funcs> - -</erlref> - diff --git a/lib/cosNotification/doc/src/CosNotifyChannelAdmin_ProxyPushSupplier.xml b/lib/cosNotification/doc/src/CosNotifyChannelAdmin_ProxyPushSupplier.xml deleted file mode 100644 index 6f85de114a..0000000000 --- a/lib/cosNotification/doc/src/CosNotifyChannelAdmin_ProxyPushSupplier.xml +++ /dev/null @@ -1,110 +0,0 @@ -<?xml version="1.0" encoding="utf-8" ?> -<!DOCTYPE erlref SYSTEM "erlref.dtd"> - -<erlref> - <header> - <copyright> - <year>2000</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>CosNotifyChannelAdmin_ProxyPushSupplier</title> - <prepared></prepared> - <responsible></responsible> - <docno></docno> - <approved></approved> - <checked></checked> - <date>2000-02-01</date> - <rev>1.0</rev> - </header> - <module>CosNotifyChannelAdmin_ProxyPushSupplier</module> - <modulesummary>This module implements the OMG CosNotifyChannelAdmin::ProxyPushSupplier interface.</modulesummary> - <description> - <p>To get access to the record definitions for the structures use: <br></br> -<c>-include_lib("cosNotification/include/*.hrl").</c></p> - <p>This module also exports the functions described in:</p> - <list type="bulleted"> - <item> - <p><seealso marker="CosNotifyComm_NotifySubscribe">CosNotifyComm_NotifySubscribe</seealso></p> - </item> - <item> - <p><seealso marker="CosNotification_QoSAdmin">CosNotification_QoSAdmin</seealso></p> - </item> - <item> - <p><seealso marker="CosNotifyFilter_FilterAdmin">CosNotifyFilter_FilterAdmi</seealso></p> - </item> - <item> - <p><seealso marker="CosNotifyChannelAdmin_ProxySupplier">CosNotifyChannelAdmin_ProxySupplier</seealso></p> - </item> - </list> - </description> - <funcs> - <func> - <name>connect_any_push_consumer(ProxyPushSupplier, PushConsumer) -> Reply</name> - <fsummary>Connect a consumer to the proxy</fsummary> - <type> - <v>ProxyPushSupplier = #objref</v> - <v>PushConsumer = #objref</v> - <v>Reply = ok | {'EXCEPTION', #'CosEventChannelAdmin_AlreadyConnected'{}} | {'EXCEPTION', #'CosEventChannelAdmin_TypeError'{}}</v> - </type> - <desc> - <p>This operation connects a <c>PushConsumer</c> to the target object. If - a connection already exists or the given client does not support - the operation <c>push</c> an exception, <c>AlreadyConnected</c> and - <c>TypeError</c> respectively, is raised.</p> - </desc> - </func> - <func> - <name>suspend_connection(ProxyPushSupplier) -> Reply</name> - <fsummary>Suspend the connection between the proxy and the client</fsummary> - <type> - <v>ProxyPushSupplier = #objref</v> - <v>Reply = ok | {'EXCEPTION', #'CosNotifyChannelAdmin_ConnectionAlreadyInactive'{}} | {'EXCEPTION', #'CosNotifyChannelAdmin_NotConnected'{}}</v> - </type> - <desc> - <p>This operation suspends the connection with the client object. If the connection - already is suspended or no client have been associated an exception is raised.</p> - </desc> - </func> - <func> - <name>resume_connection(ProxyPushSupplier) -> Reply</name> - <fsummary>Resume a previously suspended connection with the proxy</fsummary> - <type> - <v>ProxyPullConsumer = #objref</v> - <v>Reply = ok | {'EXCEPTION', #'CosNotifyChannelAdmin_ConnectionAlreadyInactive'{}} | {'EXCEPTION', #'CosNotifyChannelAdmin_NotConnected'{}}</v> - </type> - <desc> - <p>If a connection have been suspended earlier, calling this operation will resume the connection. - If the connection already is active or no client have been connected an exception is raised.</p> - </desc> - </func> - <func> - <name>disconnect_push_supplier(ProxyPushSupplier) -> ok</name> - <fsummary>Close the connection and terminate the proxy</fsummary> - <type> - <v>ProxyPushSupplier = #objref</v> - </type> - <desc> - <p>This operation cause the target object to close the connection and terminate.</p> - </desc> - </func> - </funcs> - -</erlref> - diff --git a/lib/cosNotification/doc/src/CosNotifyChannelAdmin_ProxySupplier.xml b/lib/cosNotification/doc/src/CosNotifyChannelAdmin_ProxySupplier.xml deleted file mode 100644 index 69013fdb1e..0000000000 --- a/lib/cosNotification/doc/src/CosNotifyChannelAdmin_ProxySupplier.xml +++ /dev/null @@ -1,175 +0,0 @@ -<?xml version="1.0" encoding="utf-8" ?> -<!DOCTYPE erlref SYSTEM "erlref.dtd"> - -<erlref> - <header> - <copyright> - <year>2000</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>CosNotifyChannelAdmin_ProxySupplier</title> - <prepared></prepared> - <responsible></responsible> - <docno></docno> - <approved></approved> - <checked></checked> - <date>2000-02-01</date> - <rev>1.0</rev> - </header> - <module>CosNotifyChannelAdmin_ProxySupplier</module> - <modulesummary>This module implements the OMG CosNotifyChannelAdmin::ProxySupplier interface.</modulesummary> - <description> - <p>To get access to the record definitions for the structures use: <br></br> -<c>-include_lib("cosNotification/include/*.hrl").</c></p> - <p>This module also exports the functions described in:</p> - <list type="bulleted"> - <item> - <p><seealso marker="CosNotification_QoSAdmin">CosNotification_QoSAdmin</seealso></p> - </item> - <item> - <p><seealso marker="CosNotifyFilter_FilterAdmin">CosNotifyFilter_FilterAdmin</seealso></p> - </item> - </list> - </description> - <funcs> - <func> - <name>_get_MyType(ProxySupplier) -> ProxyType</name> - <fsummary>Return the proxy type</fsummary> - <type> - <v>ProxySupplier = #objref</v> - <v>ProxyType = 'PUSH_ANY' | 'PULL_ANY' | 'PUSH_STRUCTURED' | 'PULL_STRUCTURED' | 'PUSH_SEQUENCE' | 'PULL_SEQUENCE'</v> - </type> - <desc> - <p>This readonly attribute maintains the enumerant describing the which type the target object - is.</p> - </desc> - </func> - <func> - <name>_get_MyAdmin(ProxySupplier) -> AdminObject</name> - <fsummary>Return the target object's associated <c>Admin</c>object</fsummary> - <type> - <v>ProxySupplier = #objref</v> - <v>AdminObject = #objref</v> - </type> - <desc> - <p>This readonly attribute maintains the admin's reference which created the target object.</p> - </desc> - </func> - <func> - <name>_get_priority_filter(ProxySupplier) -> MappingFilter</name> - <fsummary>Return the target object's associated priority <c>MappingFilter</c></fsummary> - <type> - <v>ProxySupplier = #objref</v> - <v>MappingFilter = #objref</v> - </type> - <desc> - <p>This operation returns the associated priority MappingFilter. - If no such object exist a <c>NIL</c> reference is returned.</p> - </desc> - </func> - <func> - <name>_set_priority_filter(ProxySupplier, MappingFilter) -> ok</name> - <fsummary>Set the target object's associated priority <c>MappingFilter</c></fsummary> - <type> - <v>ProxySupplier = #objref</v> - <v>MappingFilter = #objref</v> - </type> - <desc> - <p>This operation associate a new priority MappingFilter with the target object.</p> - </desc> - </func> - <func> - <name>_get_lifetime_filter(ProxySupplier) -> MappingFilter</name> - <fsummary>Return the target object's associated lifetime <c>MappingFilter</c></fsummary> - <type> - <v>ProxySupplier = #objref</v> - <v>MappingFilter = #objref</v> - </type> - <desc> - <p>This operation returns the associated lifetime MappingFilter. - If no such object exist a <c>NIL</c> reference is returned.</p> - </desc> - </func> - <func> - <name>_set_lifetime_filter(ProxySupplier, MappingFilter) -> ok</name> - <fsummary>Set the target object's associated lifetime <c>MappingFilter</c></fsummary> - <type> - <v>ProxySupplier = #objref</v> - <v>MappingFilter = #objref</v> - </type> - <desc> - <p>This operation associate a new lifetime MappingFilter with the target object.</p> - </desc> - </func> - <func> - <name>obtain_offered_types(ProxySupplier, ObtainInfoMode) -> EventTypeSeq</name> - <fsummary>Administer the type of events the proxy supplies</fsummary> - <type> - <v>ProxySupplier = #objref</v> - <v>ObtainInfoMode = 'ALL_NOW_UPDATES_OFF' | 'ALL_NOW_UPDATES_ON' | 'NONE_NOW_UPDATES_OFF' | 'NONE_NOW_UPDATES_ON'</v> - <v>EventTypeSeq = [EventType]</v> - <v>EventType = #'CosNotification_EventType'{domain_name, type_name}</v> - <v>domain_name = type_name = string()</v> - </type> - <desc> - <p>Depending on the input parameter <c>ObtainInfoMode</c>, this operation may return a - sequence of the <c>EventTypes</c> the target object is interested in receiving. - If <c>'ALL_NOW_UPDATES_OFF'</c> or <c>'ALL_NOW_UPDATES_ON'</c> is given a sequence will - be returned, otherwise not. If <c>'ALL_NOW_UPDATES_OFF'</c> or <c>'NONE_NOW_UPDATES_OFF'</c> - are issued the target object will not inform the associated <c>NotifySubscribe</c> object - when an update occurs. <c>'ALL_NOW_UPDATES_ON'</c> or <c>'NONE_NOW_UPDATES_ON'</c> will - result in that update information will be sent.</p> - </desc> - </func> - <func> - <name>validate_event_qos(ProxySupplier, QoSProperties) -> Reply</name> - <fsummary>Check if the QoS properties can be set</fsummary> - <type> - <v>ProxySupplier = #objref</v> - <v>QoSProperties = [QoSProperty]</v> - <v>QoSProperty = #'CosNotification_Property'{name, value}</v> - <v>name = string()</v> - <v>value = #any</v> - <v>Reply = {ok, NamedPropertyRangeSeq} | {'EXCEPTION', CosNotification_UnsupportedQoS{qos_err}}</v> - <v>NamedPropertyRangeSeq = [NamedPropertyRange]</v> - <v>NamedPropertyRange = #CosNotification_NamedPropertyRange{name, range}</v> - <v>name = string()</v> - <v>range = #CosNotification_PropertyRange{low_val, high_val}</v> - <v>low_val = #any</v> - <v>high_val = #any</v> - <v>qos_err = PropertyErrorSeq</v> - <v>PropertyErrorSeq = [PropertyError]</v> - <v>PropertyError = #'CosNotification_PropertyError'{code, name, available_range}</v> - <v>code = 'UNSUPPORTED_PROPERTY' | 'UNAVAILABLE_PROPERTY' | 'UNSUPPORTED_VALUE' | 'UNAVAILABLE_VALUE' | 'BAD_PROPERTY' | 'BAD_TYPE' | 'BAD_VALUE'</v> - <v>name = string()</v> - <v>available_range = PropertyRange</v> - <v>PropertyRange = #CosNotification_PropertyRange{low_val, high_val}</v> - <v>low_val = high_val = #any</v> - </type> - <desc> - <p>To check if certain Quality of Service properties can be added to events in - the current context of the target object this operation should be used. If we - cannot support the required settings an exception describing why will be raised.</p> - </desc> - </func> - </funcs> - -</erlref> - diff --git a/lib/cosNotification/doc/src/CosNotifyChannelAdmin_SequenceProxyPullConsumer.xml b/lib/cosNotification/doc/src/CosNotifyChannelAdmin_SequenceProxyPullConsumer.xml deleted file mode 100644 index 043472df55..0000000000 --- a/lib/cosNotification/doc/src/CosNotifyChannelAdmin_SequenceProxyPullConsumer.xml +++ /dev/null @@ -1,112 +0,0 @@ -<?xml version="1.0" encoding="utf-8" ?> -<!DOCTYPE erlref SYSTEM "erlref.dtd"> - -<erlref> - <header> - <copyright> - <year>2000</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>CosNotifyChannelAdmin_SequenceProxyPullConsumer</title> - <prepared></prepared> - <responsible></responsible> - <docno></docno> - <approved></approved> - <checked></checked> - <date>2000-02-01</date> - <rev>1.0</rev> - </header> - <module>CosNotifyChannelAdmin_SequenceProxyPullConsumer</module> - <modulesummary>This module implements the OMG CosNotifyChannelAdmin::SequenceProxyPullConsumer interface.</modulesummary> - <description> - <p>To get access to the record definitions for the structures use: <br></br> -<c>-include_lib("cosNotification/include/*.hrl").</c></p> - <p>This module also exports the functions described in:</p> - <list type="bulleted"> - <item> - <p><seealso marker="CosNotifyComm_NotifyPublish">CosNotifyComm_NotifyPublish</seealso></p> - </item> - <item> - <p><seealso marker="CosNotification_QoSAdmin">CosNotification_QoSAdmin</seealso></p> - </item> - <item> - <p><seealso marker="CosNotifyFilter_FilterAdmin">CosNotifyFilter_FilterAdmin</seealso></p> - </item> - <item> - <p><seealso marker="CosNotifyChannelAdmin_ProxyConsumer">CosNotifyChannelAdmin_ProxyConsumer</seealso></p> - </item> - </list> - </description> - <funcs> - <func> - <name>connect_sequence_pull_supplier(SequenceProxyPullConsumer, PullSupplier) -> Reply</name> - <fsummary>Connect a supplier to the proxy</fsummary> - <type> - <v>SequenceProxyPullConsumer = #objref</v> - <v>PullSupplier = #objref</v> - <v>Reply = ok | {'EXCEPTION', #'CosEventChannelAdmin_AlreadyConnected'{}} | {'EXCEPTION', #'CosEventChannelAdmin_TypeError'{}}</v> - </type> - <desc> - <p>This operation connects a <c>PullSupplier</c> to the target object. If a - connection already exists or the supplied client does not support the functions - <c>pull_structured_events</c> and <c>try_pull_structured_events</c> an exception - is raised.</p> - </desc> - </func> - <func> - <name>suspend_connection(SequenceProxyPullConsumer) -> Reply</name> - <fsummary>Suspend the connection with the proxy</fsummary> - <type> - <v>SequenceProxyPullConsumer = #objref</v> - <v>Reply = ok | {'EXCEPTION', #'CosNotifyChannelAdmin_ConnectionAlreadyInactive'{}} | {'EXCEPTION', #'CosNotifyChannelAdmin_NotConnected'{}}</v> - </type> - <desc> - <p>If a connection exist, invoking this operation will suspend the connection - until instructed otherwise. Otherwise, no client have been connected or this operation - already have been invoked an exception is raised.</p> - </desc> - </func> - <func> - <name>resume_connection(SequenceProxyPullConsumer) -> Reply</name> - <fsummary>Resume a previously suspended connection with the proxy</fsummary> - <type> - <v>SequenceProxyPullConsumer = #objref</v> - <v>Reply = ok | {'EXCEPTION', #'CosNotifyChannelAdmin_ConnectionAlreadyInactive'{}} | {'EXCEPTION', #'CosNotifyChannelAdmin_NotConnected'{}}</v> - </type> - <desc> - <p>If an connection have been suspended this operation must be used to resume the - connection. If the connection already is active or no client have been connected an - exception is raised.</p> - </desc> - </func> - <func> - <name>disconnect_sequence_pull_consumer(SequenceProxyPullConsumer) -> ok</name> - <fsummary>Close connection and terminate the proxy</fsummary> - <type> - <v>SequenceProxyPullConsumer = #objref</v> - </type> - <desc> - <p>This operation close the connection to the client and terminates the target object.</p> - </desc> - </func> - </funcs> - -</erlref> - diff --git a/lib/cosNotification/doc/src/CosNotifyChannelAdmin_SequenceProxyPullSupplier.xml b/lib/cosNotification/doc/src/CosNotifyChannelAdmin_SequenceProxyPullSupplier.xml deleted file mode 100644 index a0040a50d7..0000000000 --- a/lib/cosNotification/doc/src/CosNotifyChannelAdmin_SequenceProxyPullSupplier.xml +++ /dev/null @@ -1,146 +0,0 @@ -<?xml version="1.0" encoding="utf-8" ?> -<!DOCTYPE erlref SYSTEM "erlref.dtd"> - -<erlref> - <header> - <copyright> - <year>2000</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>CosNotifyChannelAdmin_SequenceProxyPullSupplier</title> - <prepared></prepared> - <responsible></responsible> - <docno></docno> - <approved></approved> - <checked></checked> - <date>2000-02-01</date> - <rev>1.0</rev> - </header> - <module>CosNotifyChannelAdmin_SequenceProxyPullSupplier</module> - <modulesummary>This module implements the OMG CosNotifyChannelAdmin::SequenceProxyPullSupplier interface.</modulesummary> - <description> - <p>To get access to the record definitions for the structures use: <br></br> -<c>-include_lib("cosNotification/include/*.hrl").</c></p> - <p>This module also exports the functions described in:</p> - <list type="bulleted"> - <item> - <p><seealso marker="CosNotifyComm_NotifySubscribe">CosNotifyComm_NotifySubscribe</seealso></p> - </item> - <item> - <p><seealso marker="CosNotification_QoSAdmin">CosNotification_QoSAdmin</seealso></p> - </item> - <item> - <p><seealso marker="CosNotifyFilter_FilterAdmin">CosNotifyFilter_FilterAdmin</seealso></p> - </item> - <item> - <p><seealso marker="CosNotifyChannelAdmin_ProxySupplier">CosNotifyChannelAdmin_ProxySupplier</seealso></p> - </item> - </list> - </description> - <funcs> - <func> - <name>connect_sequence_pull_consumer(SequenceProxyPullSupplier, PullConsumer) -> Reply</name> - <fsummary>Connect a consumer to the proxy</fsummary> - <type> - <v>SequenceProxyPullSupplier = #objref</v> - <v>PullConsumer = #objref</v> - <v>Reply = ok | {'EXCEPTION', #'CosEventChannelAdmin_AlreadyConnected'{}}</v> - </type> - <desc> - <p>This operation connects a <c>PullConsumer</c> to the target object. If a connection - already exists an exception is raised.</p> - </desc> - </func> - <func> - <name>pull_structured_events(SequenceProxyPullSupplier, MaxEvents) -> Reply</name> - <fsummary>Pull structured events from the proxy</fsummary> - <type> - <v>SequenceProxyPullSupplier = #objref</v> - <v>MaxEvents = long()</v> - <v>Reply = EventBatch | {'EXCEPTION', #'CosEventChannelAdmin_Disconnected'{}}</v> - <v>EventBatch = [StructuredEvent]</v> - <v>StructuredEvent = #'CosNotification_StructuredEvent'{header, filterable_data, remainder_of_body}</v> - <v>header = EventHeader</v> - <v>filterable_data = [#'CosNotification_Property'{name, value}]</v> - <v>name = string()</v> - <v>value = #any</v> - <v>remainder_of_body = #any</v> - <v>EventHeader = #'CosNotification_EventHeader'{fixed_header, variable_header}</v> - <v>fixed_header = FixedEventHeader</v> - <v>variable_header = OptionalHeaderFields</v> - <v>FixedEventHeader = #'CosNotification_FixedEventHeader'{event_type, event_name}</v> - <v>event_type = EventType</v> - <v>event_name = string()</v> - <v>EventType = #'CosNotification_EventType'{domain_name, type_name}</v> - <v>domain_name = type_name = string()</v> - <v>OptionalHeaderFields = [#'CosNotification_Property'{name, value}]</v> - </type> - <desc> - <p>A client use this operation to pull next event sequence of maximum length - <c>MaxEvents</c>. This operation is blocking and will not reply until the - requested amount of events can be delivered or the QoS property <c>PacingInterval</c> - is reached. For more information see the <c>User's Guide</c>.</p> - </desc> - </func> - <func> - <name>try_pull_structured_events(SequenceProxyPullSupplier, MaxEvents) -> Reply</name> - <fsummary>Try to pull structured events from the proxy</fsummary> - <type> - <v>SequenceProxyPullSupplier = #objref</v> - <v>MaxEvents = long()</v> - <v>Reply = {EventBatch, HasEvent} | {'EXCEPTION', #'CosEventChannelAdmin_Disconnected'{}}</v> - <v>HasEvent = boolean()</v> - <v>EventBatch = [StructuredEvent]</v> - <v>StructuredEvent = #'CosNotification_StructuredEvent'{header, filterable_data, remainder_of_body}</v> - <v>header = EventHeader</v> - <v>filterable_data = [#'CosNotification_Property'{name, value}]</v> - <v>name = string()</v> - <v>value = #any</v> - <v>remainder_of_body = #any</v> - <v>EventHeader = #'CosNotification_EventHeader'{fixed_header, variable_header}</v> - <v>fixed_header = FixedEventHeader</v> - <v>variable_header = OptionalHeaderFields</v> - <v>FixedEventHeader = #'CosNotification_FixedEventHeader'{event_type, event_name}</v> - <v>event_type = EventType</v> - <v>event_name = string()</v> - <v>EventType = #'CosNotification_EventType'{domain_name, type_name}</v> - <v>domain_name = type_name = string()</v> - <v>OptionalHeaderFields = [#'CosNotification_Property'{name, value}]</v> - </type> - <desc> - <p>This operation pulls an event sequence of the maximum length <c>MaxEvents</c>, - but do not block if the target object have no events to forward. The outparameter, - <c>HasEvent</c> is true if the sequence contain any events.</p> - </desc> - </func> - <func> - <name>disconnect_sequence_pull_supplier(SequenceProxyPullSupplier) -> ok</name> - <fsummary>Close the connection and terminate the proxy</fsummary> - <type> - <v>SequenceProxyPullSupplier = #objref</v> - </type> - <desc> - <p>This operation cause the target object to close the connection and terminate.</p> - </desc> - </func> - </funcs> - -</erlref> - diff --git a/lib/cosNotification/doc/src/CosNotifyChannelAdmin_SequenceProxyPushConsumer.xml b/lib/cosNotification/doc/src/CosNotifyChannelAdmin_SequenceProxyPushConsumer.xml deleted file mode 100644 index efec1f99cc..0000000000 --- a/lib/cosNotification/doc/src/CosNotifyChannelAdmin_SequenceProxyPushConsumer.xml +++ /dev/null @@ -1,109 +0,0 @@ -<?xml version="1.0" encoding="utf-8" ?> -<!DOCTYPE erlref SYSTEM "erlref.dtd"> - -<erlref> - <header> - <copyright> - <year>2000</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>CosNotifyChannelAdmin_SequenceProxyPushConsumer</title> - <prepared></prepared> - <docno></docno> - <checked></checked> - <date>2000-02-01</date> - <rev>1.0</rev> - </header> - <module>CosNotifyChannelAdmin_SequenceProxyPushConsumer</module> - <modulesummary>This module implements the OMG CosNotifyChannelAdmin::SequenceProxyPushConsumer interface.</modulesummary> - <description> - <p>To get access to the record definitions for the structures use: <br></br> -<c>-include_lib("cosNotification/include/*.hrl").</c></p> - <p>This module also exports the functions described in:</p> - <list type="bulleted"> - <item> - <p><seealso marker="CosNotifyComm_NotifyPublish">CosNotifyComm_NotifyPublish</seealso></p> - </item> - <item> - <p><seealso marker="CosNotification_QoSAdmin">CosNotification_QoSAdmin</seealso></p> - </item> - <item> - <p><seealso marker="CosNotifyFilter_FilterAdmin">CosNotifyFilter_FilterAdmin</seealso></p> - </item> - <item> - <p><seealso marker="CosNotifyChannelAdmin_ProxyConsumer">CosNotifyChannelAdmin_ProxyConsumer</seealso></p> - </item> - </list> - </description> - <funcs> - <func> - <name>connect_sequence_push_supplier(SequenceProxyPushConsumer, PushSupplier) -> Reply</name> - <fsummary>Connect a supplier to the proxy</fsummary> - <type> - <v>SequenceProxyPushConsumer = #objref</v> - <v>PushSupplier = #objref</v> - <v>Reply = ok | {'EXCEPTION', #'CosEventChannelAdmin_AlreadyConnected'{}}</v> - </type> - <desc> - <p>This operation connects a <c>PushSupplier</c> to the target object. If a - connection already exists the <c>AlreadyConnected</c> exception is raised.</p> - </desc> - </func> - <func> - <name>push_structured_events(SequenceProxyPushConsumer, EventBatch) -> Reply</name> - <fsummary>Push a structured event to the proxy</fsummary> - <type> - <v>SequenceProxyPushConsumer = #objref</v> - <v>EventBatch = [StructuredEvent]</v> - <v>StructuredEvent = #'CosNotification_StructuredEvent'{header, filterable_data, remainder_of_body}</v> - <v>header = EventHeader</v> - <v>filterable_data = [#'CosNotification_Property'{name, value}]</v> - <v>name = string()</v> - <v>value = #any</v> - <v>remainder_of_body = #any</v> - <v>EventHeader = #'CosNotification_EventHeader'{fixed_header, variable_header}</v> - <v>fixed_header = FixedEventHeader</v> - <v>variable_header = OptionalHeaderFields</v> - <v>FixedEventHeader = #'CosNotification_FixedEventHeader'{event_type, event_name}</v> - <v>event_type = EventType</v> - <v>event_name = string()</v> - <v>EventType = #'CosNotification_EventType'{domain_name, type_name}</v> - <v>domain_name = type_name = string()</v> - <v>OptionalHeaderFields = [#'CosNotification_Property'{name, value}]</v> - <v>Reply = ok | {'EXCEPTION', #'CosEventChannelAdmin_Disconnected'{}}</v> - </type> - <desc> - <p>A client must use this operation when it wishes to push a new sequence of events - to the target object. If no connection exists the <c>Disconnected</c> exception - is raised.</p> - </desc> - </func> - <func> - <name>disconnect_sequence_push_consumer(SequenceProxyPushConsumer) -> ok</name> - <fsummary>Close connection and terminate the proxy</fsummary> - <type> - <v>SequenceProxyPushConsumer = #objref</v> - </type> - <desc> - <p>This operation cause the target object to close the connection and terminate.</p> - </desc> - </func> - </funcs> - -</erlref> - diff --git a/lib/cosNotification/doc/src/CosNotifyChannelAdmin_SequenceProxyPushSupplier.xml b/lib/cosNotification/doc/src/CosNotifyChannelAdmin_SequenceProxyPushSupplier.xml deleted file mode 100644 index 229d3667c5..0000000000 --- a/lib/cosNotification/doc/src/CosNotifyChannelAdmin_SequenceProxyPushSupplier.xml +++ /dev/null @@ -1,111 +0,0 @@ -<?xml version="1.0" encoding="utf-8" ?> -<!DOCTYPE erlref SYSTEM "erlref.dtd"> - -<erlref> - <header> - <copyright> - <year>2000</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>CosNotifyChannelAdmin_SequenceProxyPushSupplier</title> - <prepared></prepared> - <responsible></responsible> - <docno></docno> - <approved></approved> - <checked></checked> - <date>2000-02-01</date> - <rev>1.0</rev> - </header> - <module>CosNotifyChannelAdmin_SequenceProxyPushSupplier</module> - <modulesummary>This module implements the OMG CosNotifyChannelAdmin::SequenceProxyPushSupplier interface.</modulesummary> - <description> - <p>To get access to the record definitions for the structures use: <br></br> -<c>-include_lib("cosNotification/include/*.hrl").</c></p> - <p>This module also exports the functions described in:</p> - <list type="bulleted"> - <item> - <p><seealso marker="CosNotifyComm_NotifySubscribe">CosNotifyComm_NotifySubscribe</seealso></p> - </item> - <item> - <p><seealso marker="CosNotification_QoSAdmin">CosNotification_QoSAdmin</seealso></p> - </item> - <item> - <p><seealso marker="CosNotifyFilter_FilterAdmin">CosNotifyFilter_FilterAdmin</seealso></p> - </item> - <item> - <p><seealso marker="CosNotifyChannelAdmin_ProxySupplier">CosNotifyChannelAdmin_ProxySupplier</seealso></p> - </item> - </list> - </description> - <funcs> - <func> - <name>connect_sequence_push_consumer(SequenceProxyPushSupplier, PushConsumer) -> Reply</name> - <fsummary>Connect a consumer to the proxy</fsummary> - <type> - <v>SequenceProxyPushSupplier = #objref</v> - <v>PushConsumer = #objref</v> - <v>Reply = ok | {'EXCEPTION', #'CosEventChannelAdmin_AlreadyConnected'{}} | {'EXCEPTION', #'CosEventChannelAdmin_TypeError'{}}</v> - </type> - <desc> - <p>This operation connects a <c>PushConsumer</c> to the target object. If a - connection already exists or the function <c>psuh_structured_events</c> - is not supported the exceptions <c>AlreadyConnected</c> or - <c>TypeError</c> will be raised respectively.</p> - </desc> - </func> - <func> - <name>suspend_connection(SequenceProxyPushSupplier) -> Reply</name> - <fsummary>Suspend the connection between the client and the target object</fsummary> - <type> - <v>SequenceProxyPushSupplier = #objref</v> - <v>Reply = ok | {'EXCEPTION', #'CosNotifyChannelAdmin_ConnectionAlreadyInactive'{}} | {'EXCEPTION', #'CosNotifyChannelAdmin_NotConnected'{}}</v> - </type> - <desc> - <p>This operation suspends the connection between the client and the target object. - If no connection exists or the connection is already suspended an exception is raised.</p> - </desc> - </func> - <func> - <name>resume_connection(SequenceProxyPushSupplier) -> Reply</name> - <fsummary>Resume a previously suspended connection with the proxy</fsummary> - <type> - <v>SequenceProxyPullConsumer = #objref</v> - <v>Reply = ok | {'EXCEPTION', #'CosNotifyChannelAdmin_ConnectionAlreadyInactive'{}} | {'EXCEPTION', #'CosNotifyChannelAdmin_NotConnected'{}}</v> - </type> - <desc> - <p>If the connection have previously been suspended this operation must used - if we want to resume the connection. If no object have been connected or the connection - already is active an exception is raised.</p> - </desc> - </func> - <func> - <name>disconnect_sequence_push_supplier(SequenceProxyPushSupplier) -> ok</name> - <fsummary>Close the connection and terminate the proxy</fsummary> - <type> - <v>SequenceProxyPushSupplier = #objref</v> - </type> - <desc> - <p>This operation cause the target object to close the connection and terminate.</p> - </desc> - </func> - </funcs> - -</erlref> - diff --git a/lib/cosNotification/doc/src/CosNotifyChannelAdmin_StructuredProxyPullConsumer.xml b/lib/cosNotification/doc/src/CosNotifyChannelAdmin_StructuredProxyPullConsumer.xml deleted file mode 100644 index 5a86cb84da..0000000000 --- a/lib/cosNotification/doc/src/CosNotifyChannelAdmin_StructuredProxyPullConsumer.xml +++ /dev/null @@ -1,110 +0,0 @@ -<?xml version="1.0" encoding="utf-8" ?> -<!DOCTYPE erlref SYSTEM "erlref.dtd"> - -<erlref> - <header> - <copyright> - <year>2000</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>CosNotifyChannelAdmin_StructuredProxyPullConsumer</title> - <prepared></prepared> - <responsible></responsible> - <docno></docno> - <approved></approved> - <checked></checked> - <date>2000-02-01</date> - <rev>1.0</rev> - </header> - <module>CosNotifyChannelAdmin_StructuredProxyPullConsumer</module> - <modulesummary>This module implements the OMG CosNotifyChannelAdmin::StructuredProxyPullConsumer interface.</modulesummary> - <description> - <p>To get access to the record definitions for the structures use: <br></br> -<c>-include_lib("cosNotification/include/*.hrl").</c></p> - <p>This module also exports the functions described in:</p> - <list type="bulleted"> - <item> - <p><seealso marker="CosNotifyComm_NotifyPublish">CosNotifyComm_NotifyPublish</seealso></p> - </item> - <item> - <p><seealso marker="CosNotification_QoSAdmin">CosNotification_QoSAdmin</seealso></p> - </item> - <item> - <p><seealso marker="CosNotifyFilter_FilterAdmin">CosNotifyFilter_FilterAdmin</seealso></p> - </item> - <item> - <p><seealso marker="CosNotifyChannelAdmin_ProxyConsumer">CosNotifyChannelAdmin_ProxyConsumer</seealso></p> - </item> - </list> - </description> - <funcs> - <func> - <name>connect_structured_pull_supplier(StructuredProxyPullConsumer, PullSupplier) -> Reply</name> - <fsummary>Connect a supplier to the proxy</fsummary> - <type> - <v>StructuredProxyPullConsumer = #objref</v> - <v>PullSupplier = #objref</v> - <v>Reply = ok | {'EXCEPTION', #'CosEventChannelAdmin_AlreadyConnected'{}} | {'EXCEPTION', #'CosEventChannelAdmin_TypeError'{}}</v> - </type> - <desc> - <p>This operation connects a <c>PullSupplier</c> to the target object. If a connection - already exists or the given client object does not support the functions - <c>pull_structured_event</c> and <c>try_pull_structured_event</c> an exception is raised.</p> - </desc> - </func> - <func> - <name>suspend_connection(StructuredProxyPullConsumer) -> Reply</name> - <fsummary>Suspend the connection between the target object and its client</fsummary> - <type> - <v>StructuredProxyPullConsumer = #objref</v> - <v>Reply = ok | {'EXCEPTION', #'CosNotifyChannelAdmin_ConnectionAlreadyInactive'{}} | {'EXCEPTION', #'CosNotifyChannelAdmin_NotConnected'{}}</v> - </type> - <desc> - <p>This operation suspends the connection between the target object and its client. - If no connection exists or already suspended an exception is raised.</p> - </desc> - </func> - <func> - <name>resume_connection(StructuredProxyPullConsumer) -> Reply</name> - <fsummary>Resume a previously suspended connection with the proxy</fsummary> - <type> - <v>StructuredProxyPullConsumer = #objref</v> - <v>Reply = ok | {'EXCEPTION', #'CosNotifyChannelAdmin_ConnectionAlreadyInactive'{}} | {'EXCEPTION', #'CosNotifyChannelAdmin_NotConnected'{}}</v> - </type> - <desc> - <p>If the connection have been suspended this operation must be used if we want - to resume the connection. If the connection already are active or no connection - have been created an exception is raised.</p> - </desc> - </func> - <func> - <name>disconnect_structured_pull_consumer(StructuredProxyPullConsumer) -> ok</name> - <fsummary>Close the connection and terminate the proxy</fsummary> - <type> - <v>StructuredProxyPullConsumer = #objref</v> - </type> - <desc> - <p>This operation cause the target object to close the connection and terminate.</p> - </desc> - </func> - </funcs> - -</erlref> - diff --git a/lib/cosNotification/doc/src/CosNotifyChannelAdmin_StructuredProxyPullSupplier.xml b/lib/cosNotification/doc/src/CosNotifyChannelAdmin_StructuredProxyPullSupplier.xml deleted file mode 100644 index 1ca7c2d7df..0000000000 --- a/lib/cosNotification/doc/src/CosNotifyChannelAdmin_StructuredProxyPullSupplier.xml +++ /dev/null @@ -1,140 +0,0 @@ -<?xml version="1.0" encoding="utf-8" ?> -<!DOCTYPE erlref SYSTEM "erlref.dtd"> - -<erlref> - <header> - <copyright> - <year>2000</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>CosNotifyChannelAdmin_StructuredProxyPullSupplier</title> - <prepared></prepared> - <responsible></responsible> - <docno></docno> - <approved></approved> - <checked></checked> - <date>2000-02-01</date> - <rev>1.0</rev> - </header> - <module>CosNotifyChannelAdmin_StructuredProxyPullSupplier</module> - <modulesummary>This module implements the OMG CosNotifyChannelAdmin::StructuredProxyPullSupplier interface.</modulesummary> - <description> - <p>To get access to the record definitions for the structures use: <br></br> -<c>-include_lib("cosNotification/include/*.hrl").</c></p> - <p>This module also exports the functions described in:</p> - <list type="bulleted"> - <item> - <p><seealso marker="CosNotifyComm_NotifySubscribe">CosNotifyComm_NotifySubscribe</seealso></p> - </item> - <item> - <p><seealso marker="CosNotification_QoSAdmin">CosNotification_QoSAdmin</seealso></p> - </item> - <item> - <p><seealso marker="CosNotifyFilter_FilterAdmin">CosNotifyFilter_FilterAdmin</seealso></p> - </item> - <item> - <p><seealso marker="CosNotifyChannelAdmin_ProxySupplier">CosNotifyChannelAdmin_ProxySupplier</seealso></p> - </item> - </list> - </description> - <funcs> - <func> - <name>connect_structured_pull_consumer(StructuredProxyPullSupplier, PullConsumer) -> Reply</name> - <fsummary>Connect a consumer to the proxy</fsummary> - <type> - <v>StructuredProxyPullSupplier = #objref</v> - <v>PullConsumer = #objref</v> - <v>Reply = ok | {'EXCEPTION', #'CosEventChannelAdmin_AlreadyConnected'{}}</v> - </type> - <desc> - <p>This operation connects a <c>PullConsumer</c> to the target object. If a connection - already exists the <c>AlreadyConnected</c> exception is raised.</p> - </desc> - </func> - <func> - <name>pull_structured_event(StructuredProxyPullSupplier) -> Reply</name> - <fsummary>Pull a structured event from the proxy</fsummary> - <type> - <v>StructuredProxyPullSupplier = #objref</v> - <v>Reply = StructuredEvent | {'EXCEPTION', #'CosEventChannelAdmin_Disconnected'{}}</v> - <v>StructuredEvent = #'CosNotification_StructuredEvent'{header, filterable_data, remainder_of_body}</v> - <v>header = EventHeader</v> - <v>filterable_data = [#'CosNotification_Property'{name, value}]</v> - <v>name = string()</v> - <v>value = #any</v> - <v>remainder_of_body = #any</v> - <v>EventHeader = #'CosNotification_EventHeader'{fixed_header, variable_header}</v> - <v>fixed_header = FixedEventHeader</v> - <v>variable_header = OptionalHeaderFields</v> - <v>FixedEventHeader = #'CosNotification_FixedEventHeader'{event_type, event_name}</v> - <v>event_type = EventType</v> - <v>event_name = string()</v> - <v>EventType = #'CosNotification_EventType'{domain_name, type_name}</v> - <v>domain_name = type_name = string()</v> - <v>OptionalHeaderFields = [#'CosNotification_Property'{name, value}]</v> - </type> - <desc> - <p>This operation pulls next event from the target object; if an event cannot - be delivered this function blocks until an event arrives.</p> - </desc> - </func> - <func> - <name>try_pull_structured_event(StructuredProxyPullSupplier) -> Reply</name> - <fsummary>Try to pull a structured event from the proxy</fsummary> - <type> - <v>StructuredProxyPullSupplier = #objref</v> - <v>Reply = {StructuredEvent, HasEvent} | {'EXCEPTION', #'CosEventChannelAdmin_Disconnected'{}}</v> - <v>HasEvent = boolean()</v> - <v>StructuredEvent = #'CosNotification_StructuredEvent'{header, filterable_data, remainder_of_body}</v> - <v>header = EventHeader</v> - <v>filterable_data = [#'CosNotification_Property'{name, value}]</v> - <v>name = string()</v> - <v>value = #any</v> - <v>remainder_of_body = #any</v> - <v>EventHeader = #'CosNotification_EventHeader'{fixed_header, variable_header}</v> - <v>fixed_header = FixedEventHeader</v> - <v>variable_header = OptionalHeaderFields</v> - <v>FixedEventHeader = #'CosNotification_FixedEventHeader'{event_type, event_name}</v> - <v>event_type = EventType</v> - <v>event_name = string()</v> - <v>EventType = #'CosNotification_EventType'{domain_name, type_name}</v> - <v>domain_name = type_name = string()</v> - <v>OptionalHeaderFields = [#'CosNotification_Property'{name, value}]</v> - </type> - <desc> - <p>This operation try to pull next event from the target object. If no event have arrived - an empty event is returned and the out parameter <c>HasEvent</c> is set to false. Otherwise, - the boolean flag is set to true and an valid event is returned.</p> - </desc> - </func> - <func> - <name>disconnect_structured_pull_supplier(StructuredProxyPullSupplier) -> ok</name> - <fsummary>Close connection and terminate the proxy</fsummary> - <type> - <v>StructuredProxyPullSupplier = #objref</v> - </type> - <desc> - <p>This operation cause the target object to close the connection and terminate.</p> - </desc> - </func> - </funcs> - -</erlref> - diff --git a/lib/cosNotification/doc/src/CosNotifyChannelAdmin_StructuredProxyPushConsumer.xml b/lib/cosNotification/doc/src/CosNotifyChannelAdmin_StructuredProxyPushConsumer.xml deleted file mode 100644 index 63bcdf120c..0000000000 --- a/lib/cosNotification/doc/src/CosNotifyChannelAdmin_StructuredProxyPushConsumer.xml +++ /dev/null @@ -1,110 +0,0 @@ -<?xml version="1.0" encoding="utf-8" ?> -<!DOCTYPE erlref SYSTEM "erlref.dtd"> - -<erlref> - <header> - <copyright> - <year>2000</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>CosNotifyChannelAdmin_StructuredProxyPushConsumer</title> - <prepared></prepared> - <responsible></responsible> - <docno></docno> - <approved></approved> - <checked></checked> - <date>2000-02-01</date> - <rev>1.0</rev> - </header> - <module>CosNotifyChannelAdmin_StructuredProxyPushConsumer</module> - <modulesummary>This module implements the OMG CosNotifyChannelAdmin::StructuredProxyPushConsumer interface.</modulesummary> - <description> - <p>To get access to the record definitions for the structures use: <br></br> -<c>-include_lib("cosNotification/include/*.hrl").</c></p> - <p>This module also exports the functions described in:</p> - <list type="bulleted"> - <item> - <p><seealso marker="CosNotifyComm_NotifyPublish">CosNotifyComm_NotifyPublish</seealso></p> - </item> - <item> - <p><seealso marker="CosNotification_QoSAdmin">CosNotification_QoSAdmin</seealso></p> - </item> - <item> - <p><seealso marker="CosNotifyFilter_FilterAdmin">CosNotifyFilter_FilterAdmin</seealso></p> - </item> - <item> - <p><seealso marker="CosNotifyChannelAdmin_ProxyConsumer">CosNotifyChannelAdmin_ProxyConsumer</seealso></p> - </item> - </list> - </description> - <funcs> - <func> - <name>connect_structured_push_supplier(StructuredProxyPushConsumer, PushSupplier) -> Reply</name> - <fsummary>Connect a supplier to the proxy</fsummary> - <type> - <v>StructuredProxyPushConsumer = #objref</v> - <v>PushSupplier = #objref</v> - <v>Reply = ok | {'EXCEPTION', #'CosEventChannelAdmin_AlreadyConnected'{}}</v> - </type> - <desc> - <p>This operation connects a <c>PushSupplier</c> to the target object. If a connection - already exists an exception is raised.</p> - </desc> - </func> - <func> - <name>push_structured_event(StructuredProxyPushConsumer, StructuredEvent) -> Reply</name> - <fsummary>Push a structured event to the proxy</fsummary> - <type> - <v>StructuredProxyPushConsumer = #objref</v> - <v>StructuredEvent = #'CosNotification_StructuredEvent'{header, filterable_data, remainder_of_body}</v> - <v>header = EventHeader</v> - <v>filterable_data = [#'CosNotification_Property'{name, value}]</v> - <v>name = string()</v> - <v>value = #any</v> - <v>remainder_of_body = #any</v> - <v>EventHeader = #'CosNotification_EventHeader'{fixed_header, variable_header}</v> - <v>fixed_header = FixedEventHeader</v> - <v>variable_header = OptionalHeaderFields</v> - <v>FixedEventHeader = #'CosNotification_FixedEventHeader'{event_type, event_name}</v> - <v>event_type = EventType</v> - <v>event_name = string()</v> - <v>EventType = #'CosNotification_EventType'{domain_name, type_name}</v> - <v>domain_name = type_name = string()</v> - <v>OptionalHeaderFields = [#'CosNotification_Property'{name, value}]</v> - <v>Reply = ok | {'EXCEPTION', #'CosEventChannelAdmin_Disconnected'{}}</v> - </type> - <desc> - <p>When a client want to push a new event to the target object this operation must be used.</p> - </desc> - </func> - <func> - <name>disconnect_structured_push_consumer(StructuredProxyPushConsumer) -> ok</name> - <fsummary>Close the connection and terminate the proxy</fsummary> - <type> - <v>StructuredProxyPushConsumer = #objref</v> - </type> - <desc> - <p>This operation cause the target object to close the connection and terminate.</p> - </desc> - </func> - </funcs> - -</erlref> - diff --git a/lib/cosNotification/doc/src/CosNotifyChannelAdmin_StructuredProxyPushSupplier.xml b/lib/cosNotification/doc/src/CosNotifyChannelAdmin_StructuredProxyPushSupplier.xml deleted file mode 100644 index 9ba5497fd8..0000000000 --- a/lib/cosNotification/doc/src/CosNotifyChannelAdmin_StructuredProxyPushSupplier.xml +++ /dev/null @@ -1,110 +0,0 @@ -<?xml version="1.0" encoding="utf-8" ?> -<!DOCTYPE erlref SYSTEM "erlref.dtd"> - -<erlref> - <header> - <copyright> - <year>2000</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>CosNotifyChannelAdmin_StructuredProxyPushSupplier</title> - <prepared></prepared> - <responsible></responsible> - <docno></docno> - <approved></approved> - <checked></checked> - <date>2000-02-01</date> - <rev>1.0</rev> - </header> - <module>CosNotifyChannelAdmin_StructuredProxyPushSupplier</module> - <modulesummary>This module implements the OMG CosNotifyChannelAdmin::StructuredProxyPushSupplier interface.</modulesummary> - <description> - <p>To get access to the record definitions for the structures use: <br></br> -<c>-include_lib("cosNotification/include/*.hrl").</c></p> - <p>This module also exports the functions described in:</p> - <list type="bulleted"> - <item> - <p><seealso marker="CosNotifyComm_NotifySubscribe">CosNotifyComm_NotifySubscribe</seealso></p> - </item> - <item> - <p><seealso marker="CosNotification_QoSAdmin">CosNotification_QoSAdmin</seealso></p> - </item> - <item> - <p><seealso marker="CosNotifyFilter_FilterAdmin">CosNotifyFilter_FilterAdmin</seealso></p> - </item> - <item> - <p><seealso marker="CosNotifyChannelAdmin_ProxySupplier">CosNotifyChannelAdmin_ProxySupplier</seealso></p> - </item> - </list> - </description> - <funcs> - <func> - <name>connect_structured_push_consumer(StructuredProxyPushSupplier, PushConsumer) -> Reply</name> - <fsummary>Connect a consumer to the proxy</fsummary> - <type> - <v>StructuredProxyPushSupplier = #objref</v> - <v>PushConsumer = #objref</v> - <v>Reply = ok | {'EXCEPTION', #'CosEventChannelAdmin_AlreadyConnected'{}} | {'EXCEPTION', #'CosEventChannelAdmin_TypeError'{}}</v> - </type> - <desc> - <p>This operation connects a <c>PushConsumer</c> to the target object. If - a connection already exists or the function <c>push_structured_event</c> - is not supported by the client object an exception is raised.</p> - </desc> - </func> - <func> - <name>suspend_connection(StructuredProxyPushSupplier) -> Reply</name> - <fsummary>Suspend the connection with the target object</fsummary> - <type> - <v>StructuredProxyPushSupplier = #objref</v> - <v>Reply = ok | {'EXCEPTION', #'CosNotifyChannelAdmin_ConnectionAlreadyInactive'{}} | {'EXCEPTION', #'CosNotifyChannelAdmin_NotConnected'{}}</v> - </type> - <desc> - <p>This operation suspends the connection with the target object. If no connection - exists or the connection already is suspended an exception is raised.</p> - </desc> - </func> - <func> - <name>resume_connection(StructuredProxyPushSupplier) -> Reply</name> - <fsummary>Resume a previously suspended connection</fsummary> - <type> - <v>StructuredProxyPullConsumer = #objref</v> - <v>Reply = ok | {'EXCEPTION', #'CosNotifyChannelAdmin_ConnectionAlreadyInactive'{}} | {'EXCEPTION', #'CosNotifyChannelAdmin_NotConnected'{}}</v> - </type> - <desc> - <p>If the connection with the target object have been suspended this function - must be used to resume the connection. If no client have been connected or - the connection is active an exception is raised.</p> - </desc> - </func> - <func> - <name>disconnect_structured_push_supplier(StructuredProxyPushSupplier) -> ok</name> - <fsummary>Close the connection and terminate the target object</fsummary> - <type> - <v>StructuredProxyPushSupplier = #objref</v> - </type> - <desc> - <p>This operation cause the target object to close the connection and terminate.</p> - </desc> - </func> - </funcs> - -</erlref> - diff --git a/lib/cosNotification/doc/src/CosNotifyChannelAdmin_SupplierAdmin.xml b/lib/cosNotification/doc/src/CosNotifyChannelAdmin_SupplierAdmin.xml deleted file mode 100644 index 540edaff3f..0000000000 --- a/lib/cosNotification/doc/src/CosNotifyChannelAdmin_SupplierAdmin.xml +++ /dev/null @@ -1,195 +0,0 @@ -<?xml version="1.0" encoding="utf-8" ?> -<!DOCTYPE erlref SYSTEM "erlref.dtd"> - -<erlref> - <header> - <copyright> - <year>2000</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>CosNotifyChannelAdmin_SupplierAdmin</title> - <prepared></prepared> - <responsible></responsible> - <docno></docno> - <approved>Niclas Eklund</approved> - <checked></checked> - <date>2000-02-01</date> - <rev>1.0</rev> - </header> - <module>CosNotifyChannelAdmin_SupplierAdmin</module> - <modulesummary>This module implements the OMG CosNotifyChannelAdmin::SupplierAdmin interface.</modulesummary> - <description> - <p>To get access to the record definitions for the structures use: <br></br> -<c>-include_lib("cosNotification/include/*.hrl").</c></p> - <p>This module also exports the functions described in:</p> - <list type="bulleted"> - <item> - <p><seealso marker="CosNotification_QoSAdmin">CosNotification_QoSAdmin</seealso></p> - </item> - <item> - <p><seealso marker="CosNotifyComm_NotifySubscribe">CosNotifyComm_NotifyPublish</seealso></p> - </item> - <item> - <p><seealso marker="CosNotifyFilter_FilterAdmin">CosNotifyFilter_FilterAdmin</seealso></p> - </item> - </list> - </description> - <funcs> - <func> - <name>_get_MyID(SupplierAdmin) -> AdminID</name> - <fsummary>Return the objects Id</fsummary> - <type> - <v>SupplierAdmin = #objref</v> - <v>AdminID = long()</v> - </type> - <desc> - <p>When a <c>SupplierAdmin</c> object is created it is given a unique Id - by the creating channel. This readonly attribute maintains this Id.</p> - </desc> - </func> - <func> - <name>_get_MyChannel(SupplierAdmin) -> Channel</name> - <fsummary>Return the objects associated channel</fsummary> - <type> - <v>SupplierAdmin = #objref</v> - <v>Channel = #objref</v> - </type> - <desc> - <p>The creating channel's reference is maintained by this readonly attribute.</p> - </desc> - </func> - <func> - <name>_get_MyOperator(SupplierAdmin) -> OpType</name> - <fsummary>Return the filter scheme</fsummary> - <type> - <v>SupplierAdmin = #objref</v> - <v>OpType = 'AND_OP' | 'OR_OP'</v> - </type> - <desc> - <p>The Operation Type, which determines the semantics the target object will - use for any associated <c>Filters</c>, is maintained by this readonly attribute.</p> - </desc> - </func> - <func> - <name>_get_pull_consumers(SupplierAdmin) -> ProxyIDSeq</name> - <fsummary>Return all associated pull consumers Id:s</fsummary> - <type> - <v>SupplierAdmin = #objref</v> - <v>ProxyIDSeq = [ProxyID]</v> - <v>ProxyID = long()</v> - </type> - <desc> - <p>A sequence of all associated <c>PullProxy</c> Id's is maintained by this - readonly attribute.</p> - </desc> - </func> - <func> - <name>_get_push_consumers(SupplierAdmin) -> ProxyIDSeq</name> - <fsummary>Return all associated push consumers Id:s</fsummary> - <type> - <v>SupplierAdmin = #objref</v> - <v>ProxyIDSeq = [ProxyID]</v> - <v>ProxyID = long()</v> - </type> - <desc> - <p>This operation returns all <c>PushProxy</c> Id's created by the target - object.</p> - </desc> - </func> - <func> - <name>get_proxy_consumer(SupplierAdmin, ProxyID) -> Reply</name> - <fsummary>Return the Proxy which corresponds to the given Id</fsummary> - <type> - <v>SupplierAdmin = #objref</v> - <v>ProxyID = long()</v> - <v>Reply = Proxy | {'EXCEPTION', #'CosNotifyChannelAdmin_ProxyNotFound'{}}</v> - <v>Proxy = #objref</v> - </type> - <desc> - <p>The Proxy which corresponds to the given Id is returned by this operation.</p> - </desc> - </func> - <func> - <name>obtain_notification_pull_consumer(SupplierAdmin, SupplierType) -> Reply</name> - <fsummary>Create a new proxy</fsummary> - <type> - <v>SupplierAdmin = #objref</v> - <v>SupplierType = 'ANY_EVENT' | 'STRUCTURED_EVENT' | 'SEQUENCE_EVENT'</v> - <v>Reply = {Proxy, ProxyID}</v> - <v>Proxy = #objref</v> - <v>ProxyID = long()</v> - </type> - <desc> - <p>This operation creates a new proxy and returns its object reference along with its ID. - The <c>SupplierType</c> parameter determines the event type accepted by the proxy.</p> - </desc> - </func> - <func> - <name>obtain_pull_consumer(SupplierAdmin) -> Proxy</name> - <fsummary>Create a new proxy</fsummary> - <type> - <v>SupplierAdmin = #objref</v> - <v>Proxy = #objref</v> - </type> - <desc> - <p>A proxy which accepts <c>#any{}</c> events is created by this operation.</p> - </desc> - </func> - <func> - <name>obtain_notification_push_consumer(SupplierAdmin, SupplierType) -> Reply</name> - <fsummary>Create a new proxy</fsummary> - <type> - <v>SupplierAdmin = #objref</v> - <v>SupplierType = 'ANY_EVENT' | 'STRUCTURED_EVENT' | 'SEQUENCE_EVENT'</v> - <v>Reply = {Proxy, ProxyID}</v> - <v>Proxy = #objref</v> - <v>ProxyID = long()</v> - </type> - <desc> - <p>Determined by the <c>SupplierType</c> parameter a compliant proxy is created and - its object reference along with its Id is returned by this operation.</p> - </desc> - </func> - <func> - <name>obtain_push_consumer(SupplierAdmin) -> Proxy</name> - <fsummary>Create a new proxy</fsummary> - <type> - <v>SupplierAdmin = #objref</v> - <v>Proxy = #objref</v> - </type> - <desc> - <p>A proxy which accepts <c>#any{}</c> events is created by this operation.</p> - </desc> - </func> - <func> - <name>destroy(SupplierAdmin) -> ok</name> - <fsummary>Terminate the target object</fsummary> - <type> - <v>SupplierAdmin = #objref</v> - </type> - <desc> - <p>This operation terminates the SupplierAdmin object and notifies the creating channel - that the target object no longer is active.</p> - </desc> - </func> - </funcs> - -</erlref> - diff --git a/lib/cosNotification/doc/src/CosNotifyComm_NotifyPublish.xml b/lib/cosNotification/doc/src/CosNotifyComm_NotifyPublish.xml deleted file mode 100644 index a41319cb5c..0000000000 --- a/lib/cosNotification/doc/src/CosNotifyComm_NotifyPublish.xml +++ /dev/null @@ -1,66 +0,0 @@ -<?xml version="1.0" encoding="utf-8" ?> -<!DOCTYPE erlref SYSTEM "erlref.dtd"> - -<erlref> - <header> - <copyright> - <year>2000</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>CosNotifyComm_NotifyPublish</title> - <prepared>Niclas Eklund</prepared> - <responsible>Niclas Eklund</responsible> - <docno></docno> - <approved>Niclas Eklund</approved> - <checked></checked> - <date>2000-02-01</date> - <rev>1.0</rev> - </header> - <module>CosNotifyComm_NotifyPublish</module> - <modulesummary>This module implements the OMG CosNotifyComm::NotifyPublish interface.</modulesummary> - <description> - <p>To get access to the record definitions for the structures use: <br></br> -<c>-include_lib("cosNotification/include/*.hrl").</c></p> - <p>All objects, which inherit this interface, export functions described in this module.</p> - </description> - <funcs> - <func> - <name>offer_change(Object, Added, Removed) -> Reply</name> - <fsummary>Inform the target object which type of events the supplier will deliver</fsummary> - <type> - <v>Object = #objref</v> - <v>Added = Removed = EventTypeSeq</v> - <v>EventTypeSeq = [type]</v> - <v>Reply = ok | {'EXCEPTION', CosNotifyComm_InvalidEventType{type}}</v> - <v>type = #'CosNotification_EventType'{domain_name, type_name}</v> - <v>domain_name = type_name = string()</v> - </type> - <desc> - <p>Objects supporting this interface can be informed by supplier objects about - which type of events that will be delivered in the future. This operation - accepts two parameters describing new and old event types respectively. - If any of the supplied event type names is syntactically incorrect an exception - is raised.</p> - </desc> - </func> - </funcs> - -</erlref> - diff --git a/lib/cosNotification/doc/src/CosNotifyComm_NotifySubscribe.xml b/lib/cosNotification/doc/src/CosNotifyComm_NotifySubscribe.xml deleted file mode 100644 index 277c666459..0000000000 --- a/lib/cosNotification/doc/src/CosNotifyComm_NotifySubscribe.xml +++ /dev/null @@ -1,64 +0,0 @@ -<?xml version="1.0" encoding="utf-8" ?> -<!DOCTYPE erlref SYSTEM "erlref.dtd"> - -<erlref> - <header> - <copyright> - <year>2000</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>CosNotifyComm_NotifySubscribe</title> - <prepared></prepared> - <responsible></responsible> - <docno></docno> - <approved></approved> - <checked></checked> - <date>2000-02-01</date> - <rev>1.0</rev> - </header> - <module>CosNotifyComm_NotifySubscribe</module> - <modulesummary>This module implements the OMG CosNotifyComm::NotifySubscribe interface.</modulesummary> - <description> - <p>To get access to the record definitions for the structures use: <br></br> -<c>-include_lib("cosNotification/include/*.hrl").</c></p> - <p>All objects, which inherit this interface, export functions described in this module.</p> - </description> - <funcs> - <func> - <name>subscription_change(Object, Added, Removed) -> Reply</name> - <fsummary>Inform the target object which event types the client will and will not accept in the future</fsummary> - <type> - <v>Object = #objref</v> - <v>Added = Removed = EventTypeSeq</v> - <v>EventTypeSeq = [type]</v> - <v>Reply = ok | {'EXCEPTION', CosNotifyComm_InvalidEventType{type}}</v> - <v>type = #'CosNotification_EventType'{domain_name, type_name}</v> - <v>domain_name = type_name = string()</v> - </type> - <desc> - <p>This operation takes as input two sequences of event type names - specifying events the client will and will not accept in the future - respectively.</p> - </desc> - </func> - </funcs> - -</erlref> - diff --git a/lib/cosNotification/doc/src/CosNotifyFilter_Filter.xml b/lib/cosNotification/doc/src/CosNotifyFilter_Filter.xml deleted file mode 100644 index a953540849..0000000000 --- a/lib/cosNotification/doc/src/CosNotifyFilter_Filter.xml +++ /dev/null @@ -1,223 +0,0 @@ -<?xml version="1.0" encoding="utf-8" ?> -<!DOCTYPE erlref SYSTEM "erlref.dtd"> - -<erlref> - <header> - <copyright> - <year>2000</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>CosNotifyFilter_Filter</title> - <prepared></prepared> - <docno></docno> - <checked></checked> - <date>2000-02-01</date> - <rev>1.0</rev> - </header> - <module>CosNotifyFilter_Filter</module> - <modulesummary>This module implements the OMG CosNotifyFilter::Filter interface.</modulesummary> - <description> - <p>To get access to the record definitions for the structures use: <br></br> -<c>-include_lib("cosNotification/include/*.hrl").</c></p> - </description> - <funcs> - <func> - <name>_get_constraint_grammar(Filter) -> Grammar</name> - <fsummary>Return which type of Grammar the Filter uses</fsummary> - <type> - <v>Filter = #objref</v> - <v>Grammar = string()</v> - </type> - <desc> - <p>This operation returns which type of Grammar the Filter uses. Currently, only <c>"EXTENDED_TCL"</c> is supported.</p> - </desc> - </func> - <func> - <name>add_constraints(Filter, ConstraintExpSeq) -> Reply</name> - <fsummary>Add new constraints to the filter</fsummary> - <type> - <v>Filter = #objref</v> - <v>ConstraintExpSeq = [Constraint]</v> - <v>ConstraintExp = #'CosNotifyFilter_ConstraintExp'{event_types, constraint_expr}</v> - <v>event_types = #'CosNotification_EventTypeSeq'{}</v> - <v>constraint_expr = string()</v> - <v>Reply = ConstraintInfoSeq | {'EXCEPTION', #'CosNotifyFilter_InvalidConstraint'{constr}}</v> - <v>constr = ConstraintExp</v> - <v>ConstraintInfoSeq = [ConstraintInfo]</v> - <v>ConstraintInfo = #'CosNotifyFilter_ConstraintInfo'{constraint_expression, constraint_id}</v> - <v>constraint_expression = ConstraintExp</v> - <v>constraint_id = long()</v> - </type> - <desc> - <p>Initially, Filters do not contain any constraints, hence, all events will be forwarded. - The <c>add_constraints/2</c> operation allow us to add constraints to the target object.</p> - </desc> - </func> - <func> - <name>modify_constraints(Filter, ConstraintIDSeq, ConstraintInfoSeq) -> Reply</name> - <fsummary>Modify existing constraints</fsummary> - <type> - <v>Filter = #objref</v> - <v>ConstraintIDSeq = [ConstraintID]</v> - <v>ConstraintID = long()</v> - <v>ConstraintInfoSeq = [ConstraintInfo]</v> - <v>ConstraintInfo = #'CosNotifyFilter_ConstraintInfo'{constraint_expression, constraint_id}</v> - <v>constraint_expression = ConstraintExp</v> - <v>constraint_id = long()</v> - <v>Reply = ok | {'EXCEPTION', #'CosNotifyFilter_InvalidConstraint'{constr}} | {'EXCEPTION', #'CosNotifyFilter_ConstraintNotFound'{id}}</v> - <v>constr = ConstraintExp</v> - <v>id = long()</v> - <v>ConstraintExp = #'CosNotifyFilter_ConstraintExp'{event_types, constraint_expr}</v> - <v>event_types = #'CosNotification_EventTypeSeq'{}</v> - <v>constraint_expr = string()</v> - </type> - <desc> - <p>This operation is invoked by a client in order to modify the constraints associated - with the target object. The constraints related to the Id's in the parameter sequence - <c>ConstraintIDSeq</c> will, if all values are valid, be deleted. The <c>ConstraintInfoSeq</c> - parameter contains of Id-Expression pairs and a constraint matching one of the unique - Id's will, if all input values are correct, be updated. If the parameters contain incorrect - data en exception will be raised.</p> - </desc> - </func> - <func> - <name>get_constraints(Filter, ConstraintIDSeq) -> Reply</name> - <fsummary>Return all constraints which match the supplied Ids</fsummary> - <type> - <v>Filter = #objref</v> - <v>ConstraintIDSeq = [ConstraintID]</v> - <v>ConstraintID = long()</v> - <v>Reply = ConstraintInfoSeq | {'EXCEPTION', #'CosNotifyFilter_ConstraintNotFound'{id}}</v> - <v>ConstraintInfoSeq = [ConstraintInfo]</v> - <v>ConstraintInfo = #'CosNotifyFilter_ConstraintInfo'{constraint_expression, constraint_id}</v> - <v>constraint_expression = ConstraintExp</v> - <v>constraint_id = id = long()</v> - </type> - <desc> - <p>This operation return a sequence of ConstraintInfo's, related to the given ConstraintID's, - associated with the target object.</p> - </desc> - </func> - <func> - <name>get_all_constraints(Filter) -> ConstraintInfoSeq</name> - <fsummary>Return all constraints associated with the target object</fsummary> - <type> - <v>Filter = #objref</v> - <v>ConstraintInfoSeq = [ConstraintInfo]</v> - <v>ConstraintInfo = #'CosNotifyFilter_ConstraintInfo'{constraint_expression, constraint_id}</v> - <v>constraint_expression = ConstraintExp</v> - <v>constraint_id = long()</v> - </type> - <desc> - <p>All constraints, and their unique Id, associated with the target object will be returned by this operation.</p> - </desc> - </func> - <func> - <name>remove_all_constraints(Filter) -> ok</name> - <fsummary>Remove all constraints associated with the target object</fsummary> - <type> - <v>Filter = #objref</v> - </type> - <desc> - <p>All constraints associated with the target object are removed by this operation and, since - the the target object no longer contain any constraints, true will always be the result of - any match operation.</p> - </desc> - </func> - <func> - <name>destroy(Filter) -> ok</name> - <fsummary>Terminate the target object</fsummary> - <type> - <v>Filter = #objref</v> - </type> - <desc> - <p>This operation terminates the target object.</p> - </desc> - </func> - <func> - <name>match(Filter, Event) -> Reply</name> - <fsummary>Match the Any event if it satisfies at least one constraint</fsummary> - <type> - <v>Filter = #objref</v> - <v>Event = #any</v> - <v>Reply = boolean() | {'EXCEPTION', #'CosNotifyFilter_UnsupportedFilterableData'{}}</v> - </type> - <desc> - <p>This operation accepts an <c>#any{}</c> event and returns <c>true</c> if it satisfies - at least one constraint. If the event contains data of the wrong type, e.g., should be - a string() but in fact i a short(), an exception is raised.</p> - </desc> - </func> - <func> - <name>match_structured(Filter, Event) -> Reply</name> - <fsummary>Match the structured event if it satisfies at least one constraint</fsummary> - <type> - <v>Filter = #objref</v> - <v>Event = #'CosNotification_StructuredEvent'{}</v> - <v>Reply = boolean() | {'EXCEPTION', #'CosNotifyFilter_UnsupportedFilterableData'{}}</v> - </type> - <desc> - <p>This operation is similar to the <c>match</c> operation but accepts structured - events instead.</p> - </desc> - </func> - <func> - <name>attach_callback(Filter, NotifySubscribe) -> CallbackID</name> - <fsummary>Connect NotifySubscribe object, which should be informed when the target object's constraints are updated</fsummary> - <type> - <v>Filter = #objref</v> - <v>NotifySubscribe = #objref</v> - <v>CallbackID = long()</v> - </type> - <desc> - <p>This operation connects a NotifySubscribe object, which should be informed - when the target object's constraints are updated. A unique Id is returned - which must be stored if we ever want to detach the callback object in the future.</p> - </desc> - </func> - <func> - <name>detach_callback(Filter, CallbackID) -> Reply</name> - <fsummary>Disconnect the NotifySubscribe object with the given Id</fsummary> - <type> - <v>Filter = #objref</v> - <v>CallbackID = long()</v> - <v>Reply = ok | {'EXCEPTION', #'CosNotifyFilter_CallbackNotFound'{}}</v> - </type> - <desc> - <p>If the target object has an associated callback that matches the supplied - Id it will be removed and longer informed of any updates. If no object - with a matching Id is found an exception is raised.</p> - </desc> - </func> - <func> - <name>get_callbacks(Filter) -> CallbackIDSeq</name> - <fsummary>Return all NotifySubscribe Id's associated with the target object</fsummary> - <type> - <v>Filter = #objref</v> - <v>CallbackIDSeq = [CallbackID]</v> - <v>CallbackID = long()</v> - </type> - <desc> - <p>This operation returns a sequence of all connected NotifySubscribe object Id's. - If no callbacks are associated with the target object the list will be empty.</p> - </desc> - </func> - </funcs> - -</erlref> - diff --git a/lib/cosNotification/doc/src/CosNotifyFilter_FilterAdmin.xml b/lib/cosNotification/doc/src/CosNotifyFilter_FilterAdmin.xml deleted file mode 100644 index 5cb56963f1..0000000000 --- a/lib/cosNotification/doc/src/CosNotifyFilter_FilterAdmin.xml +++ /dev/null @@ -1,112 +0,0 @@ -<?xml version="1.0" encoding="utf-8" ?> -<!DOCTYPE erlref SYSTEM "erlref.dtd"> - -<erlref> - <header> - <copyright> - <year>2000</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>CosNotifyFilter_FilterAdmin</title> - <prepared>Niclas Eklund</prepared> - <responsible>Niclas Eklund</responsible> - <docno></docno> - <approved>Niclas Eklund</approved> - <checked></checked> - <date>2000-02-01</date> - <rev>1.0</rev> - </header> - <module>CosNotifyFilter_FilterAdmin</module> - <modulesummary>This module implements the OMG CosNotifyFilter::FilterAdmin interface.</modulesummary> - <description> - <p>To get access to the record definitions for the structures use: <br></br> -<c>-include_lib("cosNotification/include/*.hrl").</c></p> - <p>All objects, which inherit this interface, export functions described in this module.</p> - </description> - <funcs> - <func> - <name>add_filter(Object, Filter) -> FilterID</name> - <fsummary>Add a new filter to the target object</fsummary> - <type> - <v>Object = #objref</v> - <v>Filter = #objref</v> - <v>FilterID = long()</v> - </type> - <desc> - <p>This operation connects a new <c>Filter</c> to the target object. This <c>Filter</c> will, together - with other associated <c>Filters</c>, be used to select events to forward. A unique Id is - returned and should be used if we no longer want to consult the given <c>Filter</c>.</p> - </desc> - </func> - <func> - <name>remove_filter(Object, FilterID) -> ok</name> - <fsummary>Remove a filter associated with the target object</fsummary> - <type> - <v>Object = #objref</v> - <v>FilterID = long()</v> - </type> - <desc> - <p>If a certain <c>Filter</c> no longer should be associated with the target object - this operation must be used. Events will no longer be tested against the <c>Filter</c> - associated with the given Id.</p> - </desc> - </func> - <func> - <name>get_filter(Object, FilterID) -> Reply</name> - <fsummary>Return the filter with the given Id</fsummary> - <type> - <v>Object = #objref</v> - <v>FilterID = long()</v> - <v>Reply = Filter | {'EXCEPTION', #'CosNotifyFilter_FilterNotFound'{}}</v> - <v>Filter = #objref</v> - </type> - <desc> - <p>If the target object is associated with a <c>Filter</c> matching the given Id the - reference will be returned. If no such <c>Filter</c> is known by the target object - an exception is raised.</p> - </desc> - </func> - <func> - <name>get_all_filters(Object) -> FilterIDSeq</name> - <fsummary>Return a list of all filter Id:s associated with the target object</fsummary> - <type> - <v>Object = #objref</v> - <v>FilterIDSeq = [FilterID]</v> - <v>FilterID = long()</v> - </type> - <desc> - <p>Id's for all <c>Filter</c> objects associated with the target object is - returned by this operation.</p> - </desc> - </func> - <func> - <name>remove_all_filters(Object) -> ok</name> - <fsummary>Remove all filters from the target object</fsummary> - <type> - <v>Object = #objref</v> - </type> - <desc> - <p>If we want to remove all <c>Filters</c> associated with the target object we can use this function.</p> - </desc> - </func> - </funcs> - -</erlref> - diff --git a/lib/cosNotification/doc/src/CosNotifyFilter_FilterFactory.xml b/lib/cosNotification/doc/src/CosNotifyFilter_FilterFactory.xml deleted file mode 100644 index adacbc3281..0000000000 --- a/lib/cosNotification/doc/src/CosNotifyFilter_FilterFactory.xml +++ /dev/null @@ -1,74 +0,0 @@ -<?xml version="1.0" encoding="utf-8" ?> -<!DOCTYPE erlref SYSTEM "erlref.dtd"> - -<erlref> - <header> - <copyright> - <year>2000</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>CosNotifyFilter_FilterFactory</title> - <prepared>Niclas Eklund</prepared> - <responsible>Niclas Eklund</responsible> - <docno></docno> - <approved>Niclas Eklund</approved> - <checked></checked> - <date>2000-02-01</date> - <rev>1.0</rev> - </header> - <module>CosNotifyFilter_FilterFactory</module> - <modulesummary>This module implements the OMG CosNotifyFilter::FilterFactory interface.</modulesummary> - <description> - <p>To get access to the record definitions for the structures use: <br></br> -<c>-include_lib("cosNotification/include/*.hrl").</c></p> - </description> - <funcs> - <func> - <name>create_filter(FilterFactory, Grammar) -> Reply</name> - <fsummary>Create a <c>Filter</c>object</fsummary> - <type> - <v>FilterFactory = #objref</v> - <v>Grammar = string()</v> - <v>Reply = Filter | {'EXCEPTION', #'CosNotifyFilter_InvalidGrammar'{}}</v> - <v>Filter = #objref</v> - </type> - <desc> - <p>This operation creates a new Filter object, under the condition - that Grammar given is supported. Currently, only <c>"EXTENDED_TCL"</c> is supported.</p> - </desc> - </func> - <func> - <name>create_mapping_filter(FilterFactory, Grammar) -> Reply</name> - <fsummary>Create a <c>MappingFilter</c>object</fsummary> - <type> - <v>FilterFactory = #objref</v> - <v>Grammar = string()</v> - <v>Reply = MappingFilter | {'EXCEPTION', #'CosNotifyFilter_InvalidGrammar'{}}</v> - <v>Filter = #objref</v> - </type> - <desc> - <p>This operation creates a new MappingFilter object, under the condition - that Grammar given is supported. Currently, only <c>"EXTENDED_TCL"</c> is supported.</p> - </desc> - </func> - </funcs> - -</erlref> - diff --git a/lib/cosNotification/doc/src/CosNotifyFilter_MappingFilter.xml b/lib/cosNotification/doc/src/CosNotifyFilter_MappingFilter.xml deleted file mode 100644 index c0db8c1ae0..0000000000 --- a/lib/cosNotification/doc/src/CosNotifyFilter_MappingFilter.xml +++ /dev/null @@ -1,228 +0,0 @@ -<?xml version="1.0" encoding="utf-8" ?> -<!DOCTYPE erlref SYSTEM "erlref.dtd"> - -<erlref> - <header> - <copyright> - <year>2000</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>CosNotifyFilter_MappingFilter</title> - <prepared></prepared> - <docno></docno> - <checked></checked> - <date>2000-02-01</date> - <rev>1.0</rev> - </header> - <module>CosNotifyFilter_MappingFilter</module> - <modulesummary>This module implements the OMG CosNotifyFilter::MappingFilter interface.</modulesummary> - <description> - <p>The main purpose of this module is to match events against associated - constraints and return the value for the first constraint that returns - true for the given event. If all constraints return false the default value - will be returned.</p> - <p>To get access to the record definitions for the structures use: <br></br> -<c>-include_lib("cosNotification/include/*.hrl").</c></p> - </description> - <funcs> - <func> - <name>_get_constraint_grammar(MappingFilter) -> Grammar</name> - <fsummary>Return which type of Grammar the MappingFilter uses</fsummary> - <type> - <v>MappingFilter = #objref</v> - <v>Grammar = string()</v> - </type> - <desc> - <p>This operation returns which type of Grammar the MappingFilter uses. - Currently, only <c>"EXTENDED_TCL"</c> is supported.</p> - </desc> - </func> - <func> - <name>_get_value_type(MappingFilter) -> CORBA::TypeCode</name> - <fsummary>Return the <c>CORBA::TypeCode</c>of the default value associated with the target object</fsummary> - <type> - <v>MappingFilter = #objref</v> - </type> - <desc> - <p>This readonly attribute maintains the <c>CORBA::TypeCode</c> of the default value - associated with the target object.</p> - </desc> - </func> - <func> - <name>_get_default_value(MappingFilter) -> #any</name> - <fsummary>Return the <c>#any{}</c> default value associated with the target object</fsummary> - <type> - <v>MappingFilter = #objref</v> - </type> - <desc> - <p>This readonly attribute maintains the <c>#any{}</c> default value associated with - the target object.</p> - </desc> - </func> - <func> - <name>add_mapping_constraints(MappingFilter, MappingConstraintPairSeq) -> Reply</name> - <fsummary>Add new mapping constraints</fsummary> - <type> - <v>MappingFilter = #objref</v> - <v>MappingConstraintPairSeq = [MappingConstraintPair]</v> - <v>MappingConstraintPair = #'CosNotifyFilter_MappingConstraintPair'{constraint_expression, result_to_set}</v> - <v>constraint_expression = #'CosNotifyFilter_ConstraintExp'{event_types, constraint_expr}</v> - <v>event_types = #'CosNotification_EventTypeSeq'{}</v> - <v>constraint_expr = string()</v> - <v>result_to_set = #any</v> - <v>Reply = MappingConstraintInfoSeq | {'EXCEPTION', #'CosNotifyFilter_InvalidConstraint'{constr}} | {'EXCEPTION', #'CosNotifyFilter_InvalidValue'{constr, value}}</v> - <v>constr = ConstraintExp</v> - <v>ConstraintExp = #'CosNotifyFilter_ConstraintExp'{event_types, constraint_expr}</v> - <v>event_types = #'CosNotification_EventTypeSeq'{}</v> - <v>constraint_expr = string()</v> - <v>MappingConstraintInfoSeq = [MappingConstraintInfo]</v> - <v>MappingConstraintInfo = #'CosNotifyFilter_MappingConstraintInfo'{constraint_expression, constraint_id, value}</v> - <v>constraint_expression = ConstraintExp</v> - <v>constraint_id = long()</v> - <v>value = #any</v> - </type> - <desc> - <p>This operation add new mapping constraints, which will be used when trying to override - Quality of Service settings defined in the given event. If a constraint return true the - associated value will be returned, otherwise the default value.</p> - </desc> - </func> - <func> - <name>modify_constraints(MappingFilter, ConstraintIDSeq, MappingConstraintInfoSeq) -> Reply</name> - <fsummary>Modify the constraints associated with the target object</fsummary> - <type> - <v>MappingFilter = #objref</v> - <v>ConstraintIDSeq = [ConstraintID]</v> - <v>ConstraintID = long()</v> - <v>MappingConstraintInfoSeq = [MappingConstraintInfo]</v> - <v>MappingConstraintInfo = #'CosNotifyFilter_MappingConstraintInfo'{constraint_expression, constraint_id, value}</v> - <v>constraint_expression = ConstraintExp</v> - <v>constraint_id = long()</v> - <v>value = #any</v> - <v>ConstraintInfoSeq = [ConstraintInfo]</v> - <v>ConstraintInfo = #'CosNotifyFilter_ConstraintInfo'{constraint_expression, constraint_id}</v> - <v>constraint_expression = ConstraintExp</v> - <v>constraint_id = long()</v> - <v>Reply = ok | {'EXCEPTION', #'CosNotifyFilter_InvalidConstraint'{constr}} | {'EXCEPTION', #'CosNotifyFilter_ConstraintNotFound'{id}} | {'EXCEPTION', #'CosNotifyFilter_InvalidValue'{constr, value}}</v> - <v>constr = ConstraintExp</v> - <v>id = long()</v> - <v>value = #any</v> - <v>ConstraintExp = #'CosNotifyFilter_ConstraintExp'{event_types, constraint_expr}</v> - <v>event_types = #'CosNotification_EventTypeSeq'{}</v> - <v>constraint_expr = string()</v> - </type> - <desc> - <p>The <c>ConstraintIDSeq</c> supplied should relate to constraints the caller wishes to - remove. If any of the supplied Id's are not found an exception will be raised. This - operation also accepts a sequence of <c>MappingConstraintInfo</c> which will be added. - If the target object cannot modify the constraints as requested an exception is raised - describing which constraint, and why, could not be updated.</p> - </desc> - </func> - <func> - <name>get_mapping_constraints(MappingFilter, ConstraintIDSeq) -> Reply</name> - <fsummary>Return the target object's associated constraints with given ID:s</fsummary> - <type> - <v>MappingFilter = #objref</v> - <v>ConstraintIDSeq = [ConstraintID]</v> - <v>ConstraintID = long()</v> - <v>Reply = MappingConstraintInfoSeq | {'EXCEPTION', #'CosNotifyFilter_ConstraintNotFound'{id}}</v> - <v>MappingConstraintInfoSeq = [MappingConstraintInfo]</v> - <v>MappingConstraintInfo = #'CosNotifyFilter_MappingConstraintInfo'{constraint_expression, constraint_id, value}</v> - <v>constraint_expression = ConstraintExp</v> - <v>ConstraintExp = #'CosNotifyFilter_ConstraintExp'{event_types, constraint_expr}</v> - <v>event_types = #'CosNotification_EventTypeSeq'{}</v> - <v>constraint_expr = string()</v> - <v>constraint_id = id = long()</v> - <v>value = #any</v> - </type> - <desc> - <p>When adding a new constraint a unique Id is returned, which is accepted as input for this - operation. The associated constraint is returned, but if no such Id exists an exception is raised. </p> - </desc> - </func> - <func> - <name>get_all_mapping_constraints(MappingFilter) -> MappingConstraintInfoSeq</name> - <fsummary>Return the target object's all associated constraints</fsummary> - <type> - <v>MappingFilter = #objref</v> - <v>MappingConstraintInfoSeq = [MappingConstraintInfo]</v> - <v>MappingConstraintInfo = #'CosNotifyFilter_MappingConstraintInfo'{constraint_expression, constraint_id, value}</v> - <v>constraint_expression = ConstraintExp</v> - <v>ConstraintExp = #'CosNotifyFilter_ConstraintExp'{event_types, constraint_expr}</v> - <v>event_types = #'CosNotification_EventTypeSeq'{}</v> - <v>constraint_expr = string()</v> - <v>constraint_id = long()</v> - <v>value = #any</v> - </type> - <desc> - <p>This operation returns a sequence of all unique Id's associated with the target object. - If no constraint have been added the sequence will be empty.</p> - </desc> - </func> - <func> - <name>remove_all_mapping_constraints(MappingFilter) -> ok</name> - <fsummary>Remove all constraints associated with the target object</fsummary> - <type> - <v>MappingFilter = #objref</v> - </type> - <desc> - <p>This operation removes all constraints associated with the target object.</p> - </desc> - </func> - <func> - <name>destroy(MappingFilter) -> ok</name> - <fsummary>Terminate the target object</fsummary> - <type> - <v>MappingFilter = #objref</v> - </type> - <desc> - <p>This operation terminates the target object. Remember to remove - this Filter from the objects it have been associated with.</p> - </desc> - </func> - <func> - <name>match(MappingFilter, Event) -> Reply</name> - <fsummary>Evaluate the given Any event with the Filter's constraints</fsummary> - <type> - <v>MappingFilter = #objref</v> - <v>Event = #any</v> - <v>Reply = {boolean(), #any} | {'EXCEPTION', #'CosNotifyFilter_UnsupportedFilterableData'{}}</v> - </type> - <desc> - <p>This operation evaluates <c>Any</c> events with the Filter's constraints, - and returns the value to use. The value is the default value if all constraints - returns false and the value associated with the first constraint returning true.</p> - </desc> - </func> - <func> - <name>match_structured(MappingFilter, Event) -> Reply</name> - <fsummary>Evaluate the given structured event with the Filter's constraints</fsummary> - <type> - <v>MappingFilter = #objref</v> - <v>Event = #'CosNotification_StructuredEvent'{}</v> - <v>Reply = {boolean(), #any} | {'EXCEPTION', #'CosNotifyFilter_UnsupportedFilterableData'{}}</v> - </type> - <desc> - <p>Similar to <c>match/2</c> but accepts a structured event as input.</p> - </desc> - </func> - </funcs> - -</erlref> - diff --git a/lib/cosNotification/doc/src/Makefile b/lib/cosNotification/doc/src/Makefile deleted file mode 100644 index 43ed8294c4..0000000000 --- a/lib/cosNotification/doc/src/Makefile +++ /dev/null @@ -1,167 +0,0 @@ -# -# %CopyrightBegin% -# -# Copyright Ericsson AB 2000-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=$(COSNOTIFICATION_VSN) -APPLICATION=cosNotification - -# ---------------------------------------------------- -# Release directory specification -# ---------------------------------------------------- -RELSYSDIR = $(RELEASE_PATH)/lib/$(APPLICATION)-$(VSN) - -# ---------------------------------------------------- -# Target Specs -# ---------------------------------------------------- -XML_APPLICATION_FILES = ref_man.xml -XML_REF3_FILES = \ - cosNotificationApp.xml \ - CosNotifyChannelAdmin_EventChannelFactory.xml \ - CosNotifyChannelAdmin_EventChannel.xml \ - CosNotification.xml \ - CosNotification_QoSAdmin.xml \ - CosNotification_AdminPropertiesAdmin.xml \ - CosNotifyChannelAdmin_ConsumerAdmin.xml \ - CosNotifyChannelAdmin_SupplierAdmin.xml \ - CosNotifyComm_NotifyPublish.xml \ - CosNotifyComm_NotifySubscribe.xml \ - CosNotifyFilter_FilterAdmin.xml \ - CosNotifyFilter_FilterFactory.xml \ - CosNotifyFilter_Filter.xml \ - CosNotifyFilter_MappingFilter.xml \ - CosNotifyChannelAdmin_ProxyConsumer.xml \ - CosNotifyChannelAdmin_ProxySupplier.xml \ - CosNotifyChannelAdmin_ProxyPullConsumer.xml \ - CosNotifyChannelAdmin_ProxyPullSupplier.xml \ - CosNotifyChannelAdmin_ProxyPushConsumer.xml \ - CosNotifyChannelAdmin_ProxyPushSupplier.xml \ - CosNotifyChannelAdmin_SequenceProxyPullConsumer.xml \ - CosNotifyChannelAdmin_SequenceProxyPullSupplier.xml \ - CosNotifyChannelAdmin_SequenceProxyPushConsumer.xml \ - CosNotifyChannelAdmin_SequenceProxyPushSupplier.xml \ - CosNotifyChannelAdmin_StructuredProxyPullConsumer.xml \ - CosNotifyChannelAdmin_StructuredProxyPullSupplier.xml \ - CosNotifyChannelAdmin_StructuredProxyPushConsumer.xml \ - CosNotifyChannelAdmin_StructuredProxyPushSupplier.xml \ - - - -XML_PART_FILES = \ - part.xml -XML_CHAPTER_FILES = \ - ch_contents.xml \ - ch_introduction.xml \ - ch_install.xml \ - ch_system.xml \ - ch_BNF.xml \ - ch_QoS.xml \ - ch_example.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 = \ - eventstructure.gif \ - notificationFlow.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 *~ - -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/cosNotification/doc/src/book.xml b/lib/cosNotification/doc/src/book.xml deleted file mode 100644 index 3151abceaa..0000000000 --- a/lib/cosNotification/doc/src/book.xml +++ /dev/null @@ -1,49 +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>2000</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>cosNotification</title> - <prepared>Niclas Eklund</prepared> - <docno></docno> - <date>2000-01-31</date> - <rev>1.0</rev> - </header> - <insidecover> - </insidecover> - <pagetext>cosNotification</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/cosNotification/doc/src/ch_BNF.xml b/lib/cosNotification/doc/src/ch_BNF.xml deleted file mode 100644 index 9763c0c4ca..0000000000 --- a/lib/cosNotification/doc/src/ch_BNF.xml +++ /dev/null @@ -1,457 +0,0 @@ -<?xml version="1.0" encoding="utf-8" ?> -<!DOCTYPE chapter SYSTEM "chapter.dtd"> - -<chapter> - <header> - <copyright> - <year>2000</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>Filters and the Constraint Language BNF</title> - <prepared></prepared> - <docno></docno> - <date>2000-04-13</date> - <rev></rev> - <file>ch_BNF.xml</file> - </header> - - <section> - <title>Filters and the Constraint Language BNF</title> - <p>This chapter describes, the grammar supported by - <seealso marker="CosNotifyFilter_Filter">CosNotifyFilter_Filter</seealso> and - <seealso marker="CosNotifyFilter_MappingFilter">CosNotifyFilter_MappingFilter</seealso>, - and how to create and use filter objects. - </p> - - <section> - <title>How to create filter objects</title> - <p>To be able to filter events we must create a filter and associate - it with one, or more, of the administrative or proxy objects. In the example - below, we choose to associate the filter with a ConsumerAdmin object.</p> - <code type="none"> -FilterFactory = cosNotificationApp:start_filter_factory(), -Filter = 'CosNotifyFilter_FilterFactory': - create_filter(FilterFactory,"EXTENDED_TCL"), -ConstraintInfoSeq = 'CosNotifyFilter_Filter': - add_constraints(Filter, ConstraintExpSeq), -FilterID = 'CosNotifyChannelAdmin_ConsumerAdmin': - add_filter(AdminConsumer, Filter), - </code> - <p><c>"EXTENDED_TCL"</c> is the only grammar supported by Orber Notification - Service.</p> - <p>Depending on which operation type the Admin object uses, i.e., - <c>'AND_OP'</c> or <c>'OR_OP'</c>, events will be tested using the - associated filter. The operation properties are:</p> - <p></p> - <list type="bulleted"> - <item> - <p>'AND_OP' - must be approved by the proxy's <em>and</em> its parent admin's - filters. If all filters associated with an object (Admin or Proxy) - return false the event will be discarded. In this situation it is pointless - to try and verify with the other object's associated filters since the outcome - still would be the same.</p> - </item> - <item> - <p>'OR_OP' - if one of the object's (Admin or Proxy) filters return true, the event - will not be checked against any other filter associated with a proxy or its - parent admin. If a object's associated filters all return false, - the event will be forwarded to related proxies/admins, and - tested against any associated filters.</p> - </item> - </list> - <p>Initially, filters are empty and will always return true. Hence, we must - add constraints by using <c>'CosNotifyFilter_Filter':add_constraints/2</c>. - As input, the second argument must be a sequence of:</p> - <code type="none"> -#'CosNotifyFilter_ConstraintExp'{ - event_types = [#'CosNotification_EventType'{ - domain_name = string(), - type_name = string()}], - constraint_expr = string()} - </code> - <p>The <c>event_types</c> describes which types of events that should be matched using - the associated <c>constraint_expr</c>.</p> - <p>If a constraint expression is supposed to apply for all events, then the <c>type_name</c> can - be set to the special event type <c>%ALL</c> in a constraint's event type sequence. The - <c>domain_name</c> should be <c>""</c> or <c>"*"</c>.</p> - <p>In the following sections we will take a closer look on how to write - constraint expressions.</p> - </section> - - <section> - <title>The CosNotification Constraint Language</title> - <p>The constraint language supported by the Notification Service is:</p> - <code type="none"><![CDATA[ -<constraint> := /* empty */ - | <bool> - -<bool> := <bool_or> - -<bool_or> := <bool_or> or <bool_and> - | <bool_and> - -<bool_and> := <bool_and> and <bool_compare> - | <bool_compare> - -<bool_compare> := <expr_in> == <expr_in> - | <expr_in> != <expr_in> - | <expr_in> < <expr_in> - | <expr_in> <= <expr_in> - | <expr_in> > <expr_in> - | <expr_in> >= <expr_in> - | <expr_in> - -<expr_in> := <expr_twiddle> in <Ident> /* sequence only */ - | <expr_twiddle> - | <expr_twiddle> in $ <Component> /* sequence only */ - -<expr_twiddle> := <expr> ~ <expr> /* string data types only */ - | <expr> - -<expr> := <expr> + <term> - | <expr> - <term> - | <term> - -<term> := <term> * <factor_not> - | <term> / <factor_not> - | <factor_not> - -<factor_not> := not <factor> - | <factor> - -<factor> := ( <bool_or> ) - | exist <Ident> - | <Ident> - | <Number> - | - <Number> - | <String> - | TRUE - | FALSE - | + <Number> - | exist $ <Component> - | $ <Component> - | default $ <Component> /* discriminated unions only */ - -<Component> := /* empty */ - | . <CompDot> - | <CompArray> - | <CompAssoc> - | <Ident> <CompExt> /* run-time variable */ - -<CompExt> := /* empty */ - | . <CompDot> - | <CompArray> - | <CompAssoc> - -<CompDot> := <Ident> <CompExt> - | <CompPos> - | <UnionPos> - | _length /* only valid for arrays or sequences */ - | _d /* discriminated unions only */ - | _type_id /* only valid if possible to obtain */ - | _repos_id /* only valid if possible to obtain */ - -<CompArray> := [ <Digits> ] <CompExt> - -<CompAssoc> := ( <Ident> ) <CompExt> - -<CompPos> := <Digits> <CompExt> - -<UnionPos> := ( <UnionVal> ) <CompExt> - -<UnionVal> := /* empty */ - | <Digits> - | - <Digits> - | + <Digits> - | <String> - -/* Character set issues */ -<Ident> :=<Leader> <FollowSeq> - | \ < Leader> <FollowSeq> - -<FollowSeq> := /* <empty> */ - | <FollowSeq> <Follow> - -<Number> := <Mantissa> - | <Mantissa> <Exponent> - -<Mantissa> := <Digits> - | <Digits> . - | . <Digits> - | <Digits> . <Digits> - -<Exponent> := <Exp> <Sign> <Digits> - -<Sign> := + - | - - -<Exp> := E - | e - -<Digits> := <Digits> <Digit> - | <Digit> - -<String> := ' <TextChars> ' - -<TextChars> := /* <empty> */ - | <TextChars> <TextChar> - -<TextChar> := <Alpha> - | <Digit> - | <Other> - | <Special> - -<Special> := \\ - | \' - -<Leader> := <Alpha> - -<Follow> := <Alpha> - | <Digit> - | _ - -<Alpha> is the set of alphabetic characters [A-Za-z] -<Digit> is the set of digits [0-9] -<Other> is the set of ASCII characters that are not <Alpha>, <Digit>, or <Special> - ]]></code> - <p>In the absence of parentheses, the following precedence relations hold :</p> - <list type="ordered"> - <item><c>()</c>, <c>exist</c>, <c>default</c>, <c>unary-sign</c></item> - <item><c>not</c></item> - <item><c>*</c>, <c>/</c></item> - <item><c>+</c>, <c>-</c></item> - <item><c>~</c></item> - <item><c>in</c></item> - <item><c>==</c>, <c>!=</c>, <c><![CDATA[<]]></c>, <c><![CDATA[<=]]></c>, <c>></c>, <c>>=</c></item> - <item><c>and</c></item> - <item><c>or</c></item> - </list> - </section> - - <section> - <title>The Constraint Language Data Types</title> - <p>The Notification Service Constraint Language, defines how to write - constraint expressions, which can be used to filter events. The - representation does, however, differ slightly from ordinary Erlang terms.</p> - <p>When creating a <c>ConstraintExp</c>, the field <c>constraint_expr</c> must be - set to contain a string, e.g., <c><![CDATA["1 < 2"]]></c>. The Notification Service Constraint - Language, is designed to be able to filter structured and unstructured events - using the same constraint expression. The Constraint Language Types and Operations - can be divided into two sub-groups:</p> - <list type="bulleted"> - <item> - <p>Basic - arithmetics, strings, constants, numbers etc.</p> - </item> - <item> - <p>Complex - accessing members of complex data types, such as unions.</p> - </item> - </list> - <p>Some of the basic types, e.g., integer, are self explanatory. Hence, they are not described further.</p> - <table> - <row> - <cell align="center" valign="middle"><em>Type/Operation</em></cell> - <cell align="center" valign="middle"><em>Examples</em></cell> - <cell align="center" valign="middle"><em>Description</em></cell> - </row> - <row> - <cell align="left" valign="middle"><c>string</c></cell> - <cell align="left" valign="middle"><c>"'MyString'"</c></cell> - <cell align="left" valign="middle">Strings are represented as a sequence of zero or more <c><![CDATA[<TextChar>]]></c>s enclosed in single quotes, e.g., <c>'string'</c>.</cell> - </row> - <row> - <cell align="left" valign="middle"><c>~</c></cell> - <cell align="left" valign="middle"><c>"'Sring1' ~ 'String2'"</c></cell> - <cell align="left" valign="middle">The operator <c>~</c>is called the substring operator and mean "String1 is contained within String2".</cell> - </row> - <row> - <cell align="left" valign="middle"><c>boolean</c></cell> - <cell align="left" valign="middle"><c>"TRUE == (('lang' ~ 'Erlang' + 'fun' ~ 'functional') >= 2)"</c></cell> - <cell align="left" valign="middle">Booleans may only be TRUE or FALSE, i.e., only capital letters. Expressions which evaluate to TRUE or FALSE can be summed up and matched, where TRUE equals 1 and FALSE 0.</cell> - </row> - <row> - <cell align="left" valign="middle"><c>sequence</c></cell> - <cell align="left" valign="middle"><c>"myIntegerSequence[2]"</c></cell> - <cell align="left" valign="middle">The BNF use C/C++ notation, i.e., the example will return the <em>third</em>element.</cell> - </row> - <row> - <cell align="left" valign="middle"><c>_length</c></cell> - <cell align="left" valign="middle"><c>"myIntegerSequence._length"</c></cell> - <cell align="left" valign="middle">Returns the length of an sequence or array.</cell> - </row> - <row> - <cell align="left" valign="middle"><c>in</c></cell> - <cell align="left" valign="middle"><c>"'Erlang' in $.FunctionalLanguagesStringSeq"</c></cell> - <cell align="left" valign="middle">Returns <c>TRUE</c>if a given element is found in the given sequence. The element must be of a simple type and the same as the sequence is defined to contain.</cell> - </row> - <row> - <cell align="left" valign="middle"><c>$</c></cell> - <cell align="left" valign="middle"><c>"$ == 40"</c></cell> - <cell align="left" valign="middle">Denote the current event as well as any run-time variables. If the event is unstructured and its contained value 40, the example will return <c>TRUE</c>.</cell> - </row> - <row> - <cell align="left" valign="middle"><c>.</c></cell> - <cell align="left" valign="middle"><c>"$.MyStructMember == 40"</c></cell> - <cell align="left" valign="middle">The structure member operator <c>.</c>may be used to reference its members when the data refers to a named structure, discriminated union, or CORBA::Any data structure.</cell> - </row> - <row> - <cell align="left" valign="middle"><c>_type_id</c></cell> - <cell align="left" valign="middle"><c>"$._type_id == 'MyStruct'"</c></cell> - <cell align="left" valign="middle">Returns the unscoped IDL type name of the component. This operation is only valid if said information can be obtained.</cell> - </row> - <row> - <cell align="left" valign="middle"><c>_repos_id</c></cell> - <cell align="left" valign="middle"><c>"$._repos_id == 'IDL:MyModule/MyStruct:1.0'"</c></cell> - <cell align="left" valign="middle">Returns the RepositoryId of the component. This operation is only valid if said information can be obtained.</cell> - </row> - <row> - <cell align="left" valign="middle"><c>_d</c></cell> - <cell align="left" valign="middle"><c>"$.eventUnion._d"</c></cell> - <cell align="left" valign="middle">May only be used when accessing discriminated unions and refers to the discriminator.</cell> - </row> - <row> - <cell align="left" valign="middle"><c>exist</c></cell> - <cell align="left" valign="middle"><c>"exist $.eventUnion._d and $.eventUnion._d == 10"</c></cell> - <cell align="left" valign="middle">To avoid that a filtering of an event fails due to that, for example, we try to compare a union discriminator which does not exist, we can use this operator.</cell> - </row> - <row> - <cell align="left" valign="middle"><c>default</c></cell> - <cell align="left" valign="middle"><c>"default $.eventUnion._d"</c></cell> - <cell align="left" valign="middle">If the <c>_d</c>operation is in conjunction with the <c>default</c>operation, TRUE will be returned if the union has a default member that is active.</cell> - </row> - <row> - <cell align="left" valign="middle"><c>union</c></cell> - <cell align="left" valign="middle"><c>"$.(0) == 5"</c>eq. <c>"$.('zero') == 5"</c></cell> - <cell align="left" valign="middle">When the component refers to a union, with one of the cases defined as <c>case 0: short zero;</c>, we use <c>0</c>or <c>'zero'</c>. The result of the example is <c>TRUE</c>if the union has a discriminator set to <c>0</c>and the value <c>5</c>. If more than one case is defined to be<c>'zero'</c>, <c>$.('zero')</c>accepts both; <c>$.(0)</c>only returns <c>TRUE</c>if the discriminator is set to <c>0</c>. Leaving out the identifier, i.e., <c>$.()</c>, refers to the default value.</cell> - </row> - <row> - <cell align="left" valign="middle"><c>name-value pairs</c></cell> - <cell align="left" valign="middle"><c>"$.NameValueSeq('myID') == 5"</c>eq.<c>"$.NameValueSeq[1].name == 'myID' and $.NameValueSeq[1].value == 5"</c></cell> - <cell align="left" valign="middle">The Notification service makes extensive use of <c>name-value pairs</c>sequences within structured events, which allow us to via the identifier <c>name</c>access its <c>value</c>, as shown in the example.</cell> - </row> - <tcaption>Table 1: Type and Operator Examples</tcaption> - </table> - <p>In the next section we will take a closer look at how it is possible to write constraints using - different types of notation etc.</p> - </section> - - <section> - <title>Accessing Data In Events</title> - <p>To filter events, the supplied constraints must describe the contents of - the events and desired values. We can, for example, state that we are only - interested in receiving events which are of type <em>CommunicationsAlarm</em>. - To be able to achieve this, the constraint must contain information - that points out which fields to compare with. Figure one illustrates a conceptual overview of a - structured event. The exact definition is found in the <c>CosNotification.idl</c> file.</p> - <marker id="eventstructure"></marker> - <image file="eventstructure.gif"> - <icaption> -Figure 1: The structure of a structured event.</icaption> - </image> - <p>The Notification Service supports different constraint expressions - notation:</p> - <list type="bulleted"> - <item> - <p>Fully scoped, e.g., "$.header.fixed_header.event_type.type_name == 'CommunicationsAlarm'"</p> - </item> - <item> - <p>Short hand, e.g., "$type_name == 'CommunicationsAlarm'"</p> - </item> - <item> - <p>Positional Notation, e.g., "$.0.0.0.1 == 'CommunicationsAlarm'"</p> - </item> - </list> - <note> - <p>Which notation to use is up to the user, however, the fully scoped may - be easier to understand, but in some cases, if received from an ORB that do not populate ID:s of - named parts, the positional notation is the only option.</p> - </note> - <note> - <p>If a constraint, which access fields in a structured event structure, - is supposed to handle unstructured events as well, the CORBA::Any must contain - the same type of members.</p> - </note> - <p>How to filter against the fixed header fields, is described in the - table below.</p> - <table> - <row> - <cell align="center" valign="middle">Field</cell> - <cell align="center" valign="middle">Fully Scoped Constraint</cell> - <cell align="center" valign="middle">Short Hand Constraint</cell> - </row> - <row> - <cell align="left" valign="middle">type_name</cell> - <cell align="left" valign="middle">"$.header.fixed_header.event_type.type_name == 'Type'"</cell> - <cell align="left" valign="middle">"$type_name == 'Type'"</cell> - </row> - <row> - <cell align="left" valign="middle">domain_name</cell> - <cell align="left" valign="middle">"$.header.fixed_header.event_type.domain_name == 'Domain'"</cell> - <cell align="left" valign="middle">"$domain_name == 'Domain'"</cell> - </row> - <row> - <cell align="left" valign="middle">event_name</cell> - <cell align="left" valign="middle">"$.header.fixed_header.event_name == 'Event'"</cell> - <cell align="left" valign="middle">"$event_name == 'Event'"</cell> - </row> - <tcaption>Table 2: Fixed Header Constraint Examples</tcaption> - </table> - <p>If we are only interested in receiving events regarding 'Domain', 'Event' - and 'Type', the constraint can look like - <c>"$domain_name == 'Domain' and $event_name == 'Event' and $type_name == 'Type'"</c>.</p> - <p>The variable event header consists of a sequence of <em>name-value pairs</em>. One way to filter on these are to use a constraint that looks - like <c>"($.header.variable_header[1].name == 'priority' and $.header.variable_header[1].value > 0)"</c>. An easier way to - accomplish the same result is to use a constraint that treats the name-value - pair as an associative array, i.e., when given a name the corresponding - value is returned. Hence, instead we can use - <c>"$.header.variable_header(priority) > 0"</c>.</p> - <p>Accessing the event body is done in the same way as for the event header - fields. The user must, however, be aware of, that if a run-time variable - (<c>$variable</c>) is used data in the event header may take precedence. - The order of precedence is:</p> - <list type="ordered"> - <item>Reserved, e.g., <c>$curtime</c></item> - <item>A simple-typed member of <c>$.header.fixed_header</c>.</item> - <item>Properties in <c>$.header.variable_header</c>.</item> - <item>Properties in <c>$.filterable_data</c>.</item> - <item>If no match is found it is translated to <c>$.variable</c>.</item> - </list> - </section> - - <section> - <title>Mapping Filters</title> - <p>Mapping Filters may only be associated with Consumer Administrators or Proxy - Suppliers. The purpose of a Mapping Filter is to override Quality of Service - settings.</p> - <p>Initially, Mapping Filters are empty and will always return true. Hence, we must - add constraints by using <c>'CosNotifyFilter_MappingFilter':add_mapping_constraints/2</c>. - If a constraint matches, the associated value will be used instead of the - related Quality of Service system settings.</p> - <p>As input, the second argument must be a sequence of:</p> - <code type="none"> -#'CosNotifyFilter_MappingConstraintPair'{ - constraint_expression = #'CosNotifyFilter_ConstraintExp'{ - event_types = [#'CosNotification_EventType'{ - domain_name = string(), - type_name = string()}], - constraint_expr = string()}, - result_to_set = any()} - </code> - </section> - </section> -</chapter> - diff --git a/lib/cosNotification/doc/src/ch_QoS.xml b/lib/cosNotification/doc/src/ch_QoS.xml deleted file mode 100644 index 7f7a26f69a..0000000000 --- a/lib/cosNotification/doc/src/ch_QoS.xml +++ /dev/null @@ -1,252 +0,0 @@ -<?xml version="1.0" encoding="utf-8" ?> -<!DOCTYPE chapter SYSTEM "chapter.dtd"> - -<chapter> - <header> - <copyright> - <year>2000</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>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 for - <seealso marker="CosNotification_QoSAdmin">CosNotification_QoSAdmin</seealso> and - <seealso marker="CosNotification_AdminPropertiesAdmin">CosNotification_AdminPropertiesAdmin</seealso>. - </p> - - <section> - <title>Quality Of Service</title> - <p>The cosNotification 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">EventReliability</cell> - <cell align="left" valign="middle">BestEffort/Persistent</cell> - <cell align="left" valign="middle">BestEffort</cell> - </row> - <row> - <cell align="left" valign="middle">ConnectionReliability</cell> - <cell align="left" valign="middle">BestEffort/Persistent</cell> - <cell align="left" valign="middle">BestEffort</cell> - </row> - <row> - <cell align="left" valign="middle">Priority</cell> - <cell align="left" valign="middle">+/-32767</cell> - <cell align="left" valign="middle">0</cell> - </row> - <row> - <cell align="left" valign="middle">OrderPolicy</cell> - <cell align="left" valign="middle">Any-, Fifo-, Priority- and Deadline-Order</cell> - <cell align="left" valign="middle">PriorityOrder</cell> - </row> - <row> - <cell align="left" valign="middle">DiscardPolicy</cell> - <cell align="left" valign="middle">RejectNewEvents, Any-, Fifo-, Lifo-, Priority- and Deadline-Order</cell> - <cell align="left" valign="middle">RejectNewEvents</cell> - </row> - <row> - <cell align="left" valign="middle">MaximumBatchSize</cell> - <cell align="left" valign="middle">long() > 0</cell> - <cell align="left" valign="middle">1</cell> - </row> - <row> - <cell align="left" valign="middle">PacingInterval</cell> - <cell align="left" valign="middle">TimeBase::TimeT (see cosTime)</cell> - <cell align="left" valign="middle">0</cell> - </row> - <row> - <cell align="left" valign="middle">StartTimeSupported</cell> - <cell align="left" valign="middle">boolean</cell> - <cell align="left" valign="middle">false</cell> - </row> - <row> - <cell align="left" valign="middle">StopTimeSupported</cell> - <cell align="left" valign="middle">boolean</cell> - <cell align="left" valign="middle">false</cell> - </row> - <row> - <cell align="left" valign="middle">MaxEventsPerConsumer</cell> - <cell align="left" valign="middle">long() > 0</cell> - <cell align="left" valign="middle">100</cell> - </row> - <row> - <cell align="left" valign="middle">Timeout</cell> - <cell align="left" valign="middle">TimeBase::TimeT (see cosTime)</cell> - <cell align="left" valign="middle">No timeout</cell> - </row> - <tcaption>Table 1: 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>EventReliability</em></tag> - <item>To allow full Persistent EventReliability, every event must - be stored in a stable storage which would create a relatively - huge overhead. Hence, only lightweight version of the Persistent - QoS is supported. The configuration parameters <c>max_events</c>, - <c>interval_events</c> and <c>timeout_events</c> determine - the behavior of this setting.</item> - <tag><em>ConnectionReliability</em></tag> - <item>If this QoS is set to BestEffort and a client object returns anything - other than <c>ok</c> to its associated Proxy, the Proxy will discard - all events and terminate. Using Persistent and anything other than <c>ok</c> - is returned, events will be dropped but the proxy will retry later when - next delivery is due. A child may not have Persistent while its parent - has BestEffort QoS set, e.g., Proxy vs. Admin. If <c>OBJECT_NOT_EXIST</c>, - <c>NO_PERMISSION</c> or <c>CosEventComm_Disconnected</c> is thrown, - the associated object will terminate even if this parameter is - set to Persistent.</item> - <tag><em>Priority</em></tag> - <item>This QoS will treat all events as if they have the Priority equal to - current value, unless the event itself contains a Priority setting, - this event will be treated accordingly. Note: for this property to - have any effect, the DiscardPolicy and/or OrderPolicy must be set - to PriorityOrder.</item> - <tag><em>OrderPolicy</em></tag> - <item>If set to PriorityOrder, events with the highest Priority will be - delivered first. Deadline order will forward events with shortest - expiry time first. If two events have the same priority, they will be - delivered in FIFO-order.</item> - <tag><em>DiscardPolicy</em></tag> - <item>If set to PriorityOrder and MaxEventsPerConsumer limit is - reached, events - with the lowest Priority will be discarded first. Deadline order will - discard events with shortest expiry time first.</item> - <tag><em>MaximumBatchSize</em></tag> - <item>Only valid if the object is supposed to handle a sequence of structured - events and determines the largest amount of events that may be passed - each time.</item> - <tag><em>PacingInterval</em></tag> - <item>Determines how long an object will wait before forwarding a structured - event sequence of length equal to, or less than MaximumBatchSize. - If set to 0, which is the default behavior, no timeout is used and - the events are forwarded when the MaximumBatchSize is reached.</item> - <tag><em>StartTimeSupported</em></tag> - <item>If set to true events which contains the QoS Property <c>StartTime</c> - (TimeBase::UtcT - absolute time) will not be delivered until the - StartTime value have been exceeded. See also the <c>cosTime</c> application.</item> - <tag><em>StopTimeSupported</em></tag> - <item>If set to true, events which contain the QoS Properties <c>StopTime</c> - (TimeBase::UtcT - absolute time) or <c>Timeout</c> (TimeBase::TimeT - - relative time) will be discarded if the object has not been able to - deliver the event in time. See also the <c>cosTime</c> application.</item> - <tag><em>MaxEventsPerConsumer</em></tag> - <item>The maximum number of events the associated object may store before discarding - events in the way described by the DiscardPolicy.</item> - <tag><em>Timeout</em></tag> - <item>If this QoS property is not included in the event, and the Property - <c>StopTimeSupported</c> equals true, this setting will be applied - if events cannot be delivered within its time limit.</item> - </taglist> - <warning> - <p>Several of the above QoS Properties can be changed during run-time but we strongly advice - not to since, if a relatively large amount of events are waiting for delivery, some of the - QoS settings would require a total reorder of the events. The QoS property <c>ConnectioReliability</c> - may <em>never</em> be updated during run-time since it may cause deadlock. Run-time, in this case, - means activating the Channel by sending the first event.</p> - </warning> - </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"> -QoSPersistent = - [#'CosNotification_Property' - {name='CosNotification':'ConnectionReliability'(), - value=any:create(orber_tc:short(), - 'CosNotification':'Persistent'())}], -'CosNotification_QoSAdmin':set_qos(Ch, QoSPersistent), - </code> - <p>If it is not possible to set the requested QoS the <c>UnsupportedQoS</c> - exception is raised, which includes a sequence of <c>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 CosNotification_QoSAdmin interface also supports an operation - called <c>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 cosNotification application supports the following Admin Properties:</p> - <table> - <row> - <cell align="center" valign="middle"><em>Property</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">MaxQueueLength</cell> - <cell align="left" valign="middle">0</cell> - <cell align="left" valign="middle">0</cell> - </row> - <row> - <cell align="left" valign="middle">MaxConsumers</cell> - <cell align="left" valign="middle">long() >= 0</cell> - <cell align="left" valign="middle">0</cell> - </row> - <row> - <cell align="left" valign="middle">MaxSuppliers</cell> - <cell align="left" valign="middle">long() >= 0</cell> - <cell align="left" valign="middle">0</cell> - </row> - <tcaption>Table 2: Supported Admin Properties</tcaption> - </table> - <p>According to the OMG specification the default values for Admin Properties - is supposed to be <c>0</c>, which means that no limit applies to these - properties.</p> - <note> - <p>Admin Properties can only be set on a Channel Object level, i.e., - they will not have an impact on any Admin or Proxy Objects. Currently, - setting the Admin Property <c>MaxQueueLength</c> have no effect since - we cannot discard events accordingly to the Quality of Service Property - <c>DiscardPolicy</c>.</p> - </note> - </section> - </section> -</chapter> - diff --git a/lib/cosNotification/doc/src/ch_contents.xml b/lib/cosNotification/doc/src/ch_contents.xml deleted file mode 100644 index 11014f693b..0000000000 --- a/lib/cosNotification/doc/src/ch_contents.xml +++ /dev/null @@ -1,75 +0,0 @@ -<?xml version="1.0" encoding="utf-8" ?> -<!DOCTYPE chapter SYSTEM "chapter.dtd"> - -<chapter> - <header> - <copyright> - <year>2000</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>The cosNotification Application</title> - <prepared>Niclas Eklund</prepared> - <docno></docno> - <date>2000-01-31</date> - <rev>1.0</rev> - <file>ch-contents.xml</file> - </header> - - <section> - <title>Content Overview</title> - <p>The cosNotification documentation is divided into three sections: - </p> - <list type="bulleted"> - <item> - <p>PART ONE - The User's Guide - <br></br> -Description of the cosNotification 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 cosNotification.</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 cosNotification.</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>cosNotification overview</p> - </item> - <item> - <p>cosNotification installation</p> - </item> - <item> - <p>A tutorial example</p> - </item> - </list> - </section> -</chapter> - diff --git a/lib/cosNotification/doc/src/ch_example.xml b/lib/cosNotification/doc/src/ch_example.xml deleted file mode 100644 index a86aaccc82..0000000000 --- a/lib/cosNotification/doc/src/ch_example.xml +++ /dev/null @@ -1,170 +0,0 @@ -<?xml version="1.0" encoding="utf-8" ?> -<!DOCTYPE chapter SYSTEM "chapter.dtd"> - -<chapter> - <header> - <copyright> - <year>2000</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>cosNotification Examples</title> - <prepared>Niclas Eklund</prepared> - <docno></docno> - <date>2000-01-31</date> - <rev>A</rev> - <file>ch_example.xml</file> - </header> - - <section> - <title>A Tutorial on How to Create a Simple Service</title> - - <section> - <title>Interface Design</title> - <p>To use the cosNotification application <em>clients</em> must be implemented. - There are twelve types of clients: </p> - <list type="bulleted"> - <item>Structured Push Consumer</item> - <item>Sequence Push Consumer </item> - <item>Any Push Consumer</item> - <item>Structured Pull Consumer</item> - <item>Sequence Pull Consumer</item> - <item>Any Pull Consumer</item> - <item>Structured Push Supplier</item> - <item>Sequence Push Supplier</item> - <item>Any Push Supplier</item> - <item>Structured Pull Supplier</item> - <item>Sequence Pull Supplier</item> - <item>Any Pull Supplier</item> - </list> - <p>The interfaces for these participants are defined in <em>CosNotification.idl</em> - and <em>CosNotifyComm.idl</em>.</p> - </section> - - <section> - <title>Generating a Client Interface</title> - <p>We start by creating an interface which inherits from the correct interface, e.g., <em>CosNotifyComm::SequencePushConsumer</em>. Hence, - we must also implement all operations defined in the SequencePushConsumer interface. The IDL-file could look like: </p> - <code type="c"><![CDATA[ -#ifndef _MYCLIENT_IDL -#define _MYCLIENT_IDL -#include <CosNotification.idl> -#include <CosNotifyComm.idl> - -module myClientImpl { - - interface ownInterface:CosNotifyComm::SequencePushConsumer { - - void ownFunctions(in any NeededArguments) - raises(Systemexceptions,OwnExceptions); - - }; -}; - -#endif - ]]></code> - <p>Run the IDL compiler on this file by calling the <c>ic:gen/1</c> function. - This will produce the API named <c>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>myClientImpl_ownInterface_impl.erl</c>.</p> - <p>The callback module must contain the necessary functions inherited from - <em>CosNotification.idl</em> and <em>CosNotifyComm.idl</em>.</p> - </section> - - <section> - <title>How to Run Everything</title> - <p>Below is a short transcript on how to run cosNotification. </p> - <code type="none"> - -%% Start Mnesia and Orber -mnesia:delete_schema([node()]), -mnesia:create_schema([node()]), -orber:install([node()]), -mnesia:start(), -orber:start(), - -%% If cosEvent not installed before it is necessary to do it now. -cosEventApp:install(), - -%% Install cosNotification in the IFR. -cosNotificationApp:install(30), - -%% Register the application specific Client implementations -%% in the IFR. -'oe_myClientImpl':'oe_register'(), - -%% Start the cosNotification application. -cosNotificationApp:start(), - -%% Start a factory using the default configuration -ChFac = cosNotificationApp:start_factory(), -%% ... or use configuration parameters. -ChFac = cosNotificationApp:start_factory([]), - -%% Create a new event channel. Note, if no QoS- anr/or Admin-properties -%% are supplied (i.e. empty list) the default settings are used. -{Ch, ChID} = 'CosNotifyChannelAdmin_EventChannelFactory': - create_channel(ChFac, DefaultQoS, DefaultAdmin), - -%% Retrieve a SupplierAdmin and a Consumer Admin. -{AdminSupplier, ASID}= - 'CosNotifyChannelAdmin_EventChannel':new_for_suppliers(Ch, 'OR_OP'), -{AdminConsumer, ACID}= - 'CosNotifyChannelAdmin_EventChannel':new_for_consumers(Ch,'OR_OP'), - -%% Use the corresponding Admin object to get access to wanted Proxies - -%% Create a Push Consumer Proxie, i.e., the Client Push Supplier will -%% push events to this Proxy. -{StructuredProxyPushConsumer,ID11}= 'CosNotifyChannelAdmin_SupplierAdmin': - obtain_notification_push_consumer(AdminSupplier, 'STRUCTURED_EVENT')), - -%% Create Push Suppliers Proxies, i.e., the Proxy will push events to the -%% registered Push Consumers. -{ProxyPushSupplier,I4D}='CosNotifyChannelAdmin_ConsumerAdmin': - obtain_notification_push_supplier(AdminConsumer, 'ANY_EVENT'), -{StructuredProxyPushSupplier,ID5}='CosNotifyChannelAdmin_ConsumerAdmin': - obtain_notification_push_supplier(AdminConsumer, 'STRUCTURED_EVENT'), -{SequenceProxyPushSupplier,ID6}='CosNotifyChannelAdmin_ConsumerAdmin': - obtain_notification_push_supplier(AdminConsumer, 'SEQUENCE_EVENT'), - -%% Create application Clients. We can, for example, start the Clients -%% our selves or look them up in the naming service. This is application -%% specific. -SupplierClient = ... -ConsumerClient1 = ... -ConsumerClient2 = ... -ConsumerClient3 = ... - -%% Connect each Client to corresponding Proxy. -'CosNotifyChannelAdmin_StructuredProxyPushConsumer': - connect_structured_push_supplier(StructuredProxyPushConsumer, SupplierClient), -'CosNotifyChannelAdmin_ProxyPushSupplier': - connect_any_push_consumer(ProxyPushSupplier, ConsumerClient1), -'CosNotifyChannelAdmin_StructuredProxyPushSupplier': - connect_structured_push_consumer(StructuredProxyPushSupplier, ConsumerClient2), -'CosNotifyChannelAdmin_SequenceProxyPushSupplier': - connect_sequence_push_consumer(SequenceProxyPushSupplier, ConsumerClient3), - </code> - <p>The example above, exemplifies a notification system where the SupplierClient - in some way generates event and pushes them to the proxy. The push supplier - proxies will eventually push the events to each ConsumerClient.</p> - </section> - </section> -</chapter> - diff --git a/lib/cosNotification/doc/src/ch_install.xml b/lib/cosNotification/doc/src/ch_install.xml deleted file mode 100644 index c76c68cb42..0000000000 --- a/lib/cosNotification/doc/src/ch_install.xml +++ /dev/null @@ -1,147 +0,0 @@ -<?xml version="1.0" encoding="utf-8" ?> -<!DOCTYPE chapter SYSTEM "chapter.dtd"> - -<chapter> - <header> - <copyright> - <year>2000</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>Installing cosNotification</title> - <prepared>Niclas Eklund</prepared> - <docno></docno> - <date>2000-01-31</date> - <rev></rev> - <file>ch-install.xml</file> - </header> - - <section> - <title>Installation Process </title> - <p>This chapter describes how to install <seealso marker="cosNotificationApp">cosNotificationApp</seealso> - in an Erlang Environment. - </p> - - <section> - <title>Preparation</title> - <p>Before starting the installation process for cosNotification, - the application Orber must be running.</p> - </section> - - <section> - <title>Configuration</title> - <p>When using the Notification Service the <c>cosNotification</c> application - first must be installed using <c>cosNotificationApp:install()</c> or - <c>cosNotificationApp:install(Seconds)</c>, followed by <c>cosNotificationApp:start()</c>.</p> - <p>Then the <seealso marker="CosNotifyChannelAdmin_EventChannelFactory">Event Channel Factory</seealso> - must be started:</p> - <list type="bulleted"> - <item><c>cosNotificationApp:start_global_factory()</c> - starts and returns a reference to a factory using default configuration parameters. - This operation should be used for a multi-node Orber.</item> - <item><c>cosNotificationApp:start_global_factory(Options)</c> - starts and returns a reference to a factory using given configuration parameters. - This operation should be used for a multi-node Orber.</item> - <item><c>cosNotificationApp:start_factory()</c> - starts and returns a reference to a factory using default configuration parameters.</item> - <item><c>cosNotificationApp:start_factory(Options)</c> - starts and returns a reference to a factory using given configuration parameters.</item> - </list> - <p>The following options exist:</p> - <list type="bulleted"> - <item><c>{pullInterval, 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>{filterOp, OperationType}</c> - determine which type of Administrator - objects should be started, i.e., <c>'OR_OP'</c> or <c>'AND_OP'</c>. - The default value is <c>'OR_OP'</c>.</item> - <item><c>{timeService, TimeServiceObj | 'undefined'}</c> - to be able to use - Start and/or Stop QoS this option must be used. See the function <c>start_time_service/2</c> - in the <c>cosTime</c> application. The default value is <c>'undefined'</c>.</item> - <item><c>{filterOp, OperationType}</c> - determine which type of Administrator - objects should be started, i.e., <c>'OR_OP'</c> or <c>'AND_OP'</c>. - The default value is <c>'OR_OP'</c>.</item> - <item><c>{gcTime, Seconds}</c> - this option determines how often, for example, proxies - will garbage collect expired events. The default value is 60.</item> - <item><c>{gcLimit, Amount}</c> - determines how many events will be stored before, for - example, proxies will garbage collect expired events. The default value is 50. This - option is tightly coupled with the QoS property <c>MaxEventsPerConsumer</c>, i.e., - the <c>gcLimit</c> should be less than <c>MaxEventsPerConsumer</c> and greater than 0.</item> - </list> - <p>It is possible to define a set of global configuration parameters:</p> - <table> - <row> - <cell align="center" valign="middle"><em>Key</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">type_check</cell> - <cell align="left" valign="middle">true | false</cell> - <cell align="left" valign="middle">true</cell> - </row> - <row> - <cell align="left" valign="middle">notify</cell> - <cell align="left" valign="middle">atom() | false</cell> - <cell align="left" valign="middle">false</cell> - </row> - <row> - <cell align="left" valign="middle">max_events</cell> - <cell align="left" valign="middle">integer() > 0</cell> - <cell align="left" valign="middle">50</cell> - </row> - <row> - <cell align="left" valign="middle">interval_events</cell> - <cell align="left" valign="middle">integer() > 0</cell> - <cell align="left" valign="middle">10000 milliseconds</cell> - </row> - <row> - <cell align="left" valign="middle">timeout_events</cell> - <cell align="left" valign="middle">integer() > interval_events</cell> - <cell align="left" valign="middle">3000000 milliseconds</cell> - </row> - <tcaption>Global Configuration Parameters</tcaption> - </table> - <p><em>Comments on the table 'Global Configuration Parameters':</em></p> - <taglist> - <tag><em>type_check</em></tag> - <item>Determine if supplied IOR:s shall be type checked, i.e. invoking - corba_object:is_a/2, or not.</item> - <tag><em>notify</em></tag> - <item>The given value shall point to an existing module exporting - a function (arity 1) called <em>terminated</em>. This operation - is invoked when a proxy terminates and the argument is a list - containing <c>{proxy, IOR}</c>, <c>{client, IOR}</c> and - <c>{reason, term()}</c>. The return value is ignored.</item> - <tag><em>max_events</em></tag> - <item>If a supplier proxy has not been able to push events to a - consumer and the queue exceeds this limit, then the proxy will - terminate. For this option to have any effect, the - <c>EventReliability</c> and <c>ConnectionReliability</c> QoS - parameters must be set to <c>Persistent</c>. For more information, - see also the <seealso marker="ch_QoS">QoS</seealso> chapter.</item> - <tag><em>interval_events</em></tag> - <item>The same requirements as for <c>max_events</c>. When a supplier - proxy detects problems when trying to push events, this parameter - determines how often it should try to call the consumer.</item> - <tag><em>timeout_events</em></tag> - <item>The same requirements as for <c>max_events</c>. If the - proxy has not been able to contact the consumer and this - time-limit is reached, then the proxy will terminate.</item> - </taglist> - <p>The Factory is now ready to use. For a more detailed description see - <seealso marker="ch_example">Examples</seealso>.</p> - </section> - </section> -</chapter> - diff --git a/lib/cosNotification/doc/src/ch_introduction.xml b/lib/cosNotification/doc/src/ch_introduction.xml deleted file mode 100644 index 39cd12f1e6..0000000000 --- a/lib/cosNotification/doc/src/ch_introduction.xml +++ /dev/null @@ -1,58 +0,0 @@ -<?xml version="1.0" encoding="utf-8" ?> -<!DOCTYPE chapter SYSTEM "chapter.dtd"> - -<chapter> - <header> - <copyright> - <year>2000</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>Introduction to cosNotification</title> - <prepared>Niclas Eklund</prepared> - <docno></docno> - <date>2000-01-31</date> - <rev></rev> - <file>ch_introduction.xml</file> - </header> - - <section> - <title>Overview</title> - <p>The cosNotification application is a Notification Service compliant with the <url href="http://www.omg.org">OMG</url> - Notification Service CosNotification. - </p> - - <section> - <title>Purpose and Dependencies</title> - <p><em>cosNotification</em> is dependent on <em>Orber-3.1.7</em> or later, - which provides CORBA functionality in an Erlang environment, - <em>cosTime-1.0.1</em> or later and IDL-files to be compiled using <em>IC-4.0.4</em> or later.</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, CORBA and the Orber application. - </p> - <p>Recommended reading includes books recommended by the <em>OMG</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/cosNotification/doc/src/ch_system.xml b/lib/cosNotification/doc/src/ch_system.xml deleted file mode 100644 index 91375088a0..0000000000 --- a/lib/cosNotification/doc/src/ch_system.xml +++ /dev/null @@ -1,84 +0,0 @@ -<?xml version="1.0" encoding="utf-8" ?> -<!DOCTYPE chapter SYSTEM "chapter.dtd"> - -<chapter> - <header> - <copyright> - <year>2000</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>The Notification Service Components</title> - <prepared>Niclas Eklund</prepared> - <docno></docno> - <date>2000-04-13</date> - <rev></rev> - <file>ch_system.xml</file> - </header> - - <section> - <title>The Notification Service Components</title> - <p>This chapter describes the Notification Service Components and how they - interact.</p> - - <section> - <title>Components</title> - <p>There are seven components in the OMG Notification Service architecture. - These are described below: </p> - <marker id="notificationFlow"></marker> - <image file="notificationFlow.gif"> - <icaption> -Figure 1: The Notification Service Components.</icaption> - </image> - <list type="bulleted"> - <item><em>Event Channel:</em> acts as a factory for Administrator objects. - Allows clients to set Administrative Properties.</item> - <item><em>Supplier Administrators:</em> acts as a factory for Proxy Consumers. - Administrators are started as <c>'AND_OP'-</c> or <c>'OR_OP'-</c>type, - which determines if events must be validated using both the Administrators - associated Filter and/or its Proxy children Filters.</item> - <item><em>Consumer Administrators:</em> acts in the same way as Supplier Administrators - but handle Proxy Suppliers.</item> - <item><em>Consumer Proxy:</em> is connected to a client application. Can be - started as <c>Pull</c> or <c>Push</c> object. If the proxy is Push style - the client application must push events to the Proxy, otherwise the Proxy is - supposed to Pull events. The <c>CosNotification::AdminProperties</c> is - used to set the pacing interval.</item> - <item><em>Supplier Proxy:</em> Acts in a similar way as the Consumer Proxy, but - if started as a <c>Push</c> proxy it will push events to the client - application.</item> - <item><em>Filters:</em> used to filter events. May be associated with Proxies - and Administrators.</item> - <item><em>Mapping Filters:</em> used to override events Quality of Service - settings. Can only be associated with Consumer Administrators and - Proxy Suppliers.</item> - </list> - <p>When a Proxy is started it is set to accept <c>CORBA::Any</c>, - <c>CosNotification::StructuredEvent</c> or <c>CosNotification::EventBatch</c> - (a sequence of structured events).</p> - <p>If a Proxy is supposed to deliver structured events to a client application - and receives an <c>CORBA::Any</c> event, the event is converted to a - structured event with <c>type_name</c> set to <c>"%ANY"</c> and the - event is stored in <c>remainder_of_body</c>.</p> - <p>If a Proxy is supposed to deliver <c>CORBA::Any</c> events to a client application - and receives a structured event, the event is stored in an Any type. The - Any Type Code will be equal to the <c>CosNotification::StructuredEvent</c> - Type Code.</p> - </section> - </section> -</chapter> - diff --git a/lib/cosNotification/doc/src/cosNotificationApp.xml b/lib/cosNotification/doc/src/cosNotificationApp.xml deleted file mode 100644 index 4f662a5dc4..0000000000 --- a/lib/cosNotification/doc/src/cosNotificationApp.xml +++ /dev/null @@ -1,309 +0,0 @@ -<?xml version="1.0" encoding="utf-8" ?> -<!DOCTYPE erlref SYSTEM "erlref.dtd"> - -<erlref> - <header> - <copyright> - <year>2000</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>cosNotificationApp</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> - </header> - <module>cosNotificationApp</module> - <modulesummary>The main module of the cosNotification application.</modulesummary> - <description> - <p>To get access to the record definitions for the structures use: <br></br> -<c>-include_lib("cosNotification/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 cosNotification application</fsummary> - <type> - <v>Return = ok | {'EXCEPTION', E}</v> - </type> - <desc> - <p>This operation installs the cosNotification application.</p> - </desc> - </func> - <func> - <name>install(Seconds) -> Return</name> - <fsummary>Install the cosNotification application</fsummary> - <type> - <v>Return = ok | {'EXCEPTION', E}</v> - </type> - <desc> - <p>This operation installs the cosNotification application using <c>Seconds</c> - delay between each block, currently 6, of IFR-registrations. This approach - spreads the IFR database access over a period of time to allow other - applications to run smother.</p> - </desc> - </func> - <func> - <name>install_event() -> Return</name> - <fsummary>Install the necessary cosEvent interfaces</fsummary> - <type> - <v>Return = ok | {'EXCEPTION', E}</v> - </type> - <desc> - <p>This operation, which may <em>only</em> be used if it is impossible to - upgrade to <em>cosEvent-2.0</em> or later, installs the necessary - cosEvent interfaces. If cosEvent-2.0 is available, use - <c>cosEventApp:install()</c> instead.</p> - </desc> - </func> - <func> - <name>install_event(Seconds) -> Return</name> - <fsummary>Install the necessary cosEvent interfaces</fsummary> - <type> - <v>Return = ok | {'EXCEPTION', E}</v> - </type> - <desc> - <p>This operation, which may <em>only</em> be used if it is impossible to - upgrade to <em>cosEvent-2.0</em> or later, installs the necessary cosEvent - interfaces using <c>Seconds</c> delay between each block of - IFR-registrations. If cosEvent-2.0 is available, use - <c>cosEventApp:install()</c> instead.</p> - </desc> - </func> - <func> - <name>uninstall() -> Return</name> - <fsummary>Uninstall the cosNotification application</fsummary> - <type> - <v>Return = ok | {'EXCEPTION', E}</v> - </type> - <desc> - <p>This operation uninstalls the cosNotification application.</p> - </desc> - </func> - <func> - <name>uninstall(Seconds) -> Return</name> - <fsummary>Uninstall the cosNotification application</fsummary> - <type> - <v>Return = ok | {'EXCEPTION', E}</v> - </type> - <desc> - <p>This operation uninstalls the cosNotification application using <c>Seconds</c> - delay between each block, currently 6, of IFR-unregistrations. This approach - spreads the IFR database access over a period of time to allow other - applications to run smother.</p> - </desc> - </func> - <func> - <name>uninstall_event() -> Return</name> - <fsummary>Uninstall the inherited cosEvent interfaces</fsummary> - <type> - <v>Return = ok | {'EXCEPTION', E}</v> - </type> - <desc> - <p>This operation uninstalls the inherited cosEvent interfaces. If cosEvent - is in use this function may not be used. This function may only be used if - <c>cosNotificationApp:install_event/1/2</c> was used. If not, use - <c>cosEventApp:uninstall()</c> instead.</p> - </desc> - </func> - <func> - <name>uninstall_event(Seconds) -> Return</name> - <fsummary>Uninstall the inherited cosEvent interfaces</fsummary> - <type> - <v>Return = ok | {'EXCEPTION', E}</v> - </type> - <desc> - <p>This operation uninstalls the inherited cosEvent interfaces, using <c>Seconds</c> - delay between each block of IFR-unregistrations. If cosEvent - is in use this function may not be used. This function may only be used if - <c>cosNotificationApp:install_event/1/2</c> was used. If not, use - <c>cosEventApp:uninstall()</c> instead.</p> - </desc> - </func> - <func> - <name>start() -> Return</name> - <fsummary>Start the cosNotification application</fsummary> - <type> - <v>Return = ok | {error, Reason}</v> - </type> - <desc> - <p>This operation starts the cosNotification application.</p> - </desc> - </func> - <func> - <name>stop() -> Return</name> - <fsummary>Stop the cosNotification application</fsummary> - <type> - <v>Return = ok | {error, Reason}</v> - </type> - <desc> - <p>This operation stops the cosNotification application.</p> - </desc> - </func> - <func> - <name>start_global_factory() -> ChannelFactory</name> - <fsummary>Start a global channel factory as default</fsummary> - <type> - <v>ChannelFactory = #objref</v> - </type> - <desc> - <p>This operation creates a - <seealso marker="CosNotifyChannelAdmin_EventChannelFactory">Event Channel Factory</seealso> - should be used for a multi-node Orber. - The Factory is used to create a new - <seealso marker="CosNotifyChannelAdmin_EventChannel">channel</seealso>. </p> - </desc> - </func> - <func> - <name>start_global_factory(Options) -> ChannelFactory</name> - <fsummary>Start a global channel factory with options</fsummary> - <type> - <v>Options = [Option]</v> - <v>Option = {pullInterval, Seconds} | {filterOp, Op} | {gcTime, Seconds} | {gcLimit, Anount} | {timeService, #objref}</v> - <v>ChannelFactory = #objref</v> - </type> - <desc> - <p>This operation creates a - <seealso marker="CosNotifyChannelAdmin_EventChannelFactory">Event Channel Factory</seealso> and - should be used for a multi-node Orber. - The Factory is used to create a new - <seealso marker="CosNotifyChannelAdmin_EventChannel">channel</seealso>. </p> - <p></p> - <list type="bulleted"> - <item><c>{pullInterval, 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>{filterOp, OperationType}</c> - determine which type of Administrator - objects should be started, i.e., <c>'OR_OP'</c> or <c>'AND_OP'</c>. - The default value is <c>'OR_OP'</c>.</item> - <item><c>{timeService, TimeServiceObj | 'undefined'}</c> - to be able to use - Start and/or Stop QoS this option must be used. See the function <c>start_time_service/2</c> - in the <c>cosTime</c> application. The default value is <c>'undefined'</c>.</item> - <item><c>{filterOp, OperationType}</c> - determine which type of Administrator - objects should be started, i.e., <c>'OR_OP'</c> or <c>'AND_OP'</c>. - The default value is <c>'OR_OP'</c>.</item> - <item><c>{gcTime, Seconds}</c> - this option determines how often, for example, proxies - will garbage collect expired events. The default value is 60.</item> - <item><c>{gcLimit, Amount}</c> - determines how many events will be stored before, for - example, proxies will garbage collect expired events. The default value is 50. This - option is tightly coupled with the QoS property <c>MaxEventsPerConsumer</c>, i.e., - the <c>gcLimit</c> should be less than <c>MaxEventsPerConsumer</c> and greater than 0.</item> - </list> - </desc> - </func> - <func> - <name>start_factory() -> ChannelFactory</name> - <fsummary>Start a channel factory as default</fsummary> - <type> - <v>ChannelFactory = #objref</v> - </type> - <desc> - <p>This operation creates a - <seealso marker="CosNotifyChannelAdmin_EventChannelFactory">Event Channel Factory</seealso>. - The Factory is used to create a new - <seealso marker="CosNotifyChannelAdmin_EventChannel">channel</seealso>. </p> - </desc> - </func> - <func> - <name>start_factory(Options) -> ChannelFactory</name> - <fsummary>Start a channel factory with options</fsummary> - <type> - <v>Options = [Option]</v> - <v>Option = {pullInterval, Seconds} | {filterOp, Op} | {gcTime, Seconds} | {gcLimit, Amount} | {timeService, #objref}</v> - <v>ChannelFactory = #objref</v> - </type> - <desc> - <p>This operation creates a - <seealso marker="CosNotifyChannelAdmin_EventChannelFactory">Event Channel Factory</seealso>. - The Factory is used to create a new - <seealso marker="CosNotifyChannelAdmin_EventChannel">channel</seealso>. </p> - </desc> - </func> - <func> - <name>stop_factory(ChannelFactory) -> Reply</name> - <fsummary>Terminate the target object</fsummary> - <type> - <v>ChannelFactory = #objref</v> - <v>Reply = ok | {'EXCEPTION', E}</v> - </type> - <desc> - <p>This operation stop the target channel factory.</p> - </desc> - </func> - <func> - <name>start_filter_factory() -> FilterFactory</name> - <fsummary>Start a filter factory</fsummary> - <type> - <v>FilterFactory = #objref</v> - </type> - <desc> - <p>This operation creates a - <seealso marker="CosNotifyFilter_FilterFactory">Filter Factory</seealso>. - The Factory is used to create a new - <seealso marker="CosNotifyFilter_Filter">Filter's</seealso> and - <seealso marker="CosNotifyFilter_MappingFilter">MappingFilter's</seealso>. </p> - </desc> - </func> - <func> - <name>stop_filter_factory(FilterFactory) -> Reply</name> - <fsummary>Terminate the target object</fsummary> - <type> - <v>FilterFactory = #objref</v> - <v>Reply = ok | {'EXCEPTION', E}</v> - </type> - <desc> - <p>This operation stop the target filter factory.</p> - </desc> - </func> - <func> - <name>create_structured_event(Domain, Type, Event, VariableHeader, FilterableBody, BodyRemainder) -> Reply</name> - <fsummary>Create a structured event</fsummary> - <type> - <v>Domain = string()</v> - <v>Type = string()</v> - <v>Event = string()</v> - <v>VariableHeader = [CosNotification::Property]</v> - <v>FilterableBody = [CosNotification::Property]</v> - <v>BodyRemainder = #any data-type</v> - <v>Reply = CosNotification::StructuredEvent | {'EXCEPTION', E}</v> - </type> - <desc> - <p>An easy way to create a structured event is to use this function. - Simple typechecks are performed and if one of the arguments is not - correct a 'BAD_PARAM' exception is thrown.</p> - </desc> - </func> - <func> - <name>type_check() -> Reply</name> - <fsummary>Return the value of the configuration parameter type_check</fsummary> - <type> - <v>Reply = true | false</v> - </type> - <desc> - <p>This operation returns the value of the configuration parameter - <c>type_check</c>.</p> - </desc> - </func> - </funcs> - -</erlref> - diff --git a/lib/cosNotification/doc/src/eventstructure.gif b/lib/cosNotification/doc/src/eventstructure.gif Binary files differdeleted file mode 100644 index 879c96f980..0000000000 --- a/lib/cosNotification/doc/src/eventstructure.gif +++ /dev/null diff --git a/lib/cosNotification/doc/src/notes.xml b/lib/cosNotification/doc/src/notes.xml deleted file mode 100644 index bf0fc73548..0000000000 --- a/lib/cosNotification/doc/src/notes.xml +++ /dev/null @@ -1,632 +0,0 @@ -<?xml version="1.0" encoding="utf-8" ?> -<!DOCTYPE chapter SYSTEM "chapter.dtd"> - -<chapter> - <header> - <copyright> - <year>2000</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>cosNotification Release Notes</title> - <prepared></prepared> - <docno></docno> - <approved></approved> - <checked></checked> - <date>2000-01-31</date> - <rev>A</rev> - <file>notes.xml</file> - </header> - - <section><title>cosNotification 1.2.3</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>cosNotification 1.2.2</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>cosNotification 1.2.1</title> - - <section><title>Improvements and New Features</title> - <list> - <item> - <p> Suppress Dialyzer warnings. </p> - <p> - Own Id: OTP-12862</p> - </item> - </list> - </section> - -</section> - -<section><title>cosNotification 1.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>cosNotification 1.1.21</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>cosNotification 1.1.20</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>cosNotification 1.1.19</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>cosNotification 1.1.18</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>cosNotification 1.1.17</title> - - <section><title>Improvements and New Features</title> - <list> - <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>cosNotification 1.1.16</title> - - <section><title>Improvements and New Features</title> - <list> - <item> - <p> - Eliminated Dialyzer warnings when using exit or throw.</p> - <p> - Own Id: OTP-9050</p> - </item> - </list> - </section> -</section> - - <section><title>cosNotification 1.1.15</title> - - <section><title>Improvements and New Features</title> - <list> - <item> - <p> - Switched from using the deprecated regexp to re instead.</p> - <p> - Own Id: OTP-8846</p> - </item> - </list> - </section> - -</section> - -<section> - <title>cosNotification 1.1.14</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> - <title>Fixed Bugs and Malfunctions</title> - <list type="bulleted"> - <item> - <p>Added missing trailing bracket to define in hrl-file.</p> - <p>Own Id: OTP-8489 Aux Id:</p> - </item> - </list> - </section> - </section> - - <section> - <title>cosNotification 1.1.14</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> - <title>Fixed Bugs and Malfunctions</title> - <list type="bulleted"> - <item> - <p>Added missing trailing bracket to define in hrl-file.</p> - <p>Own id: OTP-8489 Aux Id:</p> - </item> - </list> - </section> - </section> - - <section> - <title>cosNotification 1.1.13</title> - - <section> - <title>Fixed Bugs and Malfunctions</title> - <list type="bulleted"> - <item> - <p>Removed superfluous VT in the documentation.</p> - <p>Own Id: OTP-8353 Aux Id:</p> - </item> - <item> - <p>Removed superfluous backslash in the documentation.</p> - <p>Own Id: OTP-8354 Aux Id:</p> - </item> - <item> - <p>The documentation EIX file was not generated.</p> - <p>Own Id: OTP-8355 Aux Id:</p> - </item> - </list> - </section> - </section> - - <section> - <title>cosNotification 1.1.12</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>cosNotification 1.1.11</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>cosNotification 1.1.10</title> - - <section> - <title>Fixed Bugs and Malfunctions</title> - <list type="bulleted"> - <item> - <p>Updated file headers.</p> - <p>Own Id: OTP-7837 Aux Id:</p> - </item> - </list> - </section> - </section> - - <section> - <title>cosNotification 1.1.9</title> - - <section> - <title>Fixed Bugs and Malfunctions</title> - <list type="bulleted"> - <item> - <p>Documentation source included in open source releases.</p> - <p>Own Id: OTP-7595 Aux Id:</p> - </item> - </list> - </section> - </section> - - <section> - <title>cosNotification 1.1.8</title> - - <section> - <title>Fixed Bugs and Malfunctions</title> - <list type="bulleted"> - <item> - <p>The CosNotification proxy objects ignored the gcLimit option, instead - the gcTime value was used.</p> - <p>Own Id: OTP-7553 Aux Id:</p> - </item> - </list> - </section> - </section> - - <section> - <title>cosNotification 1.1.7</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>cosNotification 1.1.6</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>cosNotification 1.1.5</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>cosNotification 1.1.4</title> - - <section> - <title>Improvements and New Features</title> - <list type="bulleted"> - <item> - <p>Removed some unused code.</p> - <p>Own Id: OTP-6527</p> - </item> - </list> - </section> - </section> - - <section> - <title>cosNotification 1.1.3</title> - - <section> - <title>Improvements and New Features</title> - <list type="bulleted"> - <item> - <p>A user can now define the QoS EventReliability to be - Persistent. Note, this is only a lightweight version - and events will be lost if a proxy is terminated.</p> - <p>Own Id: OTP-5923</p> - </item> - </list> - </section> - </section> - - <section> - <title>cosNotification 1.1.2</title> - - <section> - <title>Improvements and New Features</title> - <list type="bulleted"> - <item> - <p>Possible to configure cosNotification not to type check, - by invoking corba_object:is_a/2, supplied IOR:s. When - a type check fails, the feedback has been improved.</p> - <p>Own Id: OTP-5823 Aux Id: seq10143</p> - </item> - </list> - </section> - </section> - - <section> - <title>cosNotification 1.1.1</title> - - <section> - <title>Fixed Bugs and Malfunctions</title> - <list type="bulleted"> - <item> - <p>The app-file contained duplicated modules.</p> - <p>Own Id: OTP-4976</p> - </item> - </list> - </section> - </section> - - <section> - <title>cosNotification 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>cosNotification 1.0.6</title> - - <section> - <title>Fixed Bugs and Malfunctions</title> - <list type="bulleted"> - <item> - <p>The exception CosNotifyFilter::InvalidValue, raised by the operation - CosNotifyFilter::MappingFilter::add_mapping_constraints, did not contain - correct data in the body. Hence, it was not possible to pass this - exception to another ORB.</p> - <p>Own Id: OTP-4412</p> - </item> - <item> - <p>It was not possible to set the QoS property PacingInterval to zero and - the default value was not compliant with the OMG specification. The - default value for MaximumBatchSize have also been changed du to the - same reason.</p> - <p>Own Id: OTP-4413, OTP-4414</p> - </item> - </list> - </section> - - <section> - <title>Incompatibilities</title> - <list type="bulleted"> - <item> - <p>The default value, for the QoS properties PacingInterval and MaximumBatchSize, - have been changed to zero (i.e. no timeout) and 1 respectively, which is - compliant with the OMG specification.</p> - <p>Own Id: OTP-4413, OTP-4414</p> - </item> - </list> - </section> - </section> - - <section> - <title>cosNotification 1.0.5</title> - - <section> - <title>Fixed Bugs and Malfunctions</title> - <list type="bulleted"> - <item> - <p>If one tries to set an unavailable/incorrect property or property value, an - exception is thrown. In some cases the exception was not correct, which - would cause problems if communicating via IIOP.</p> - <p>Own Id: OTP-4340</p> - </item> - <item> - <p>When using Filter's, with the QoS OrderPolicy set to FifoOrder, - and passing a sequence of structured events, they could be - delivered in the wrong order.</p> - <p>Own Id: OTP-4272</p> - </item> - <item> - <p>If Filter's where attached to Supplier proxies it could cause - the Proxy to terminate.</p> - <p>Own Id: OTP-4272</p> - </item> - </list> - </section> - </section> - - <section> - <title>cosNotification 1.0.4</title> - - <section> - <title>Fixed Bugs and Malfunctions</title> - <list type="bulleted"> - <item> - <p>When passing event sequences, the PushSuppliers and PullSuppliers - could crash if the objects had Filter objects associated and - only a subset of the sequences where approved. </p> - <p>Own Id: OTP-4099</p> - </item> - <item> - <p>SupplierAdmin's did not filter any events, even though Filter objects - had been attached to the SupplierAdmin.</p> - <p>Own Id: OTP-4098</p> - </item> - <item> - <p>If one used the '_get_default_supplier_admin'/1, exported by the - CosNotifyChannelAdmin_EventChannel-module, it resulted in a loop - which overloaded the channel. This is no longer the case.</p> - <p>Own Id: OTP-4086</p> - </item> - <item> - <p>If one used the '_get_default_filter_factory'/1, exported by the - CosNotifyChannelAdmin_EventChannel-module, a new instance was created - each time. Now fixed.</p> - <p>Own Id: OTP-4092</p> - </item> - </list> - </section> - - <section> - <title>Incompatibilities</title> - <list type="bulleted"> - <item> - <p>The include paths for <c>CosNotification.idl</c> have been changed. - Hence, if you include this file in your own IDL-files you must - update your paths to also point to where the cosEvent IDL-files are - stored.</p> - <p>Own Id: OTP-4093</p> - </item> - </list> - </section> - </section> - - <section> - <title>cosNotification 1.0.3</title> - - <section> - <title>Improvements and New Features</title> - <list type="bulleted"> - <item> - <p>It is now possible to start global channel factories.</p> - <p>Own Id: OTP-4078</p> - </item> - <item> - <p>The Orber, version 3.2.5 or later, configuration parameter - orber_debug_level can now be used to generate reports when abnormal - situations occurs. For more information consult the Orber User's Guide. - Note, it is not recommended to use this option for delivered systems - since some of the reports is not to be considered as errors. - The value of orber_debug_level must be 3, or higher, for reports to - be generated.</p> - <p>Own Id: OTP-4077, OTP-3962</p> - </item> - </list> - </section> - - <section> - <title>Fixed Bugs and Malfunctions</title> - <list type="bulleted"> - <item> - <p>When using the cosEvent API accessing a cosNotification admins - the objects returned by the functions obtain_push_supplier, - obtain_pull_supplier, obtain_push_consumer and obtain_pull_consumer - was not of the correct type. Due to the interface change - it is not possible to upgrade during runtime.</p> - <p>Own Id: OTP-4079</p> - </item> - </list> - </section> - </section> - - <section> - <title>cosNotification 1.0.2</title> - - <section> - <title>Improvements and New Features</title> - <list type="bulleted"> - <item> - <p>First release of the cosNotification application.</p> - <p>Own Id: -</p> - </item> - </list> - </section> - </section> -</chapter> - diff --git a/lib/cosNotification/doc/src/notificationFlow.gif b/lib/cosNotification/doc/src/notificationFlow.gif Binary files differdeleted file mode 100644 index 31d6ee97fb..0000000000 --- a/lib/cosNotification/doc/src/notificationFlow.gif +++ /dev/null diff --git a/lib/cosNotification/doc/src/part.xml b/lib/cosNotification/doc/src/part.xml deleted file mode 100644 index 9cc5a8a95a..0000000000 --- a/lib/cosNotification/doc/src/part.xml +++ /dev/null @@ -1,43 +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>2000</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>cosNotification User's Guide</title> - <prepared>Niclas Eklund</prepared> - <docno></docno> - <date>2000-01-31</date> - <rev>1.0</rev> - </header> - <description> - <p>The <em>cosNotification</em> application is an Erlang implementation - of the OMG CORBA Notification Service.</p> - </description> - <xi:include href="ch_contents.xml"/> - <xi:include href="ch_introduction.xml"/> - <xi:include href="ch_install.xml"/> - <xi:include href="ch_system.xml"/> - <xi:include href="ch_BNF.xml"/> - <xi:include href="ch_QoS.xml"/> - <xi:include href="ch_example.xml"/> -</part> - diff --git a/lib/cosNotification/doc/src/ref_man.xml b/lib/cosNotification/doc/src/ref_man.xml deleted file mode 100644 index 58fb4febd2..0000000000 --- a/lib/cosNotification/doc/src/ref_man.xml +++ /dev/null @@ -1,64 +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>2000</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>cosNotification Reference Manual</title> - <prepared>Niclas Eklund</prepared> - <docno></docno> - <date>2000-01-31</date> - <rev>1.0</rev> - </header> - <description> - <p>The <em>cosNotification</em> application is an Erlang implementation - of the OMG CORBA Notification Service.</p> - </description> - <xi:include href="cosNotificationApp.xml"/> - <xi:include href="CosNotifyChannelAdmin_EventChannelFactory.xml"/> - <xi:include href="CosNotifyChannelAdmin_EventChannel.xml"/> - <xi:include href="CosNotification.xml"/> - <xi:include href="CosNotification_QoSAdmin.xml"/> - <xi:include href="CosNotification_AdminPropertiesAdmin.xml"/> - <xi:include href="CosNotifyChannelAdmin_ConsumerAdmin.xml"/> - <xi:include href="CosNotifyChannelAdmin_SupplierAdmin.xml"/> - <xi:include href="CosNotifyComm_NotifyPublish.xml"/> - <xi:include href="CosNotifyComm_NotifySubscribe.xml"/> - <xi:include href="CosNotifyFilter_FilterAdmin.xml"/> - <xi:include href="CosNotifyFilter_FilterFactory.xml"/> - <xi:include href="CosNotifyFilter_Filter.xml"/> - <xi:include href="CosNotifyFilter_MappingFilter.xml"/> - <xi:include href="CosNotifyChannelAdmin_ProxyConsumer.xml"/> - <xi:include href="CosNotifyChannelAdmin_ProxySupplier.xml"/> - <xi:include href="CosNotifyChannelAdmin_ProxyPullConsumer.xml"/> - <xi:include href="CosNotifyChannelAdmin_ProxyPullSupplier.xml"/> - <xi:include href="CosNotifyChannelAdmin_ProxyPushConsumer.xml"/> - <xi:include href="CosNotifyChannelAdmin_ProxyPushSupplier.xml"/> - <xi:include href="CosNotifyChannelAdmin_SequenceProxyPullConsumer.xml"/> - <xi:include href="CosNotifyChannelAdmin_SequenceProxyPullSupplier.xml"/> - <xi:include href="CosNotifyChannelAdmin_SequenceProxyPushConsumer.xml"/> - <xi:include href="CosNotifyChannelAdmin_SequenceProxyPushSupplier.xml"/> - <xi:include href="CosNotifyChannelAdmin_StructuredProxyPullConsumer.xml"/> - <xi:include href="CosNotifyChannelAdmin_StructuredProxyPullSupplier.xml"/> - <xi:include href="CosNotifyChannelAdmin_StructuredProxyPushConsumer.xml"/> - <xi:include href="CosNotifyChannelAdmin_StructuredProxyPushSupplier.xml"/> -</application> - |
