diff options
Diffstat (limited to 'lib/cosNotification/doc/src/CosNotifyComm_NotifySubscribe.xml')
-rw-r--r-- | lib/cosNotification/doc/src/CosNotifyComm_NotifySubscribe.xml | 64 |
1 files changed, 64 insertions, 0 deletions
diff --git a/lib/cosNotification/doc/src/CosNotifyComm_NotifySubscribe.xml b/lib/cosNotification/doc/src/CosNotifyComm_NotifySubscribe.xml new file mode 100644 index 0000000000..1ed7f860c0 --- /dev/null +++ b/lib/cosNotification/doc/src/CosNotifyComm_NotifySubscribe.xml @@ -0,0 +1,64 @@ +<?xml version="1.0" encoding="latin1" ?> +<!DOCTYPE erlref SYSTEM "erlref.dtd"> + +<erlref> + <header> + <copyright> + <year>2000</year> + <year>2007</year> + <holder>Ericsson AB, All Rights Reserved</holder> + </copyright> + <legalnotice> + The contents of this file are subject to the Erlang Public License, + Version 1.1, (the "License"); you may not use this file except in + compliance with the License. You should have received a copy of the + Erlang Public License along with this software. If not, it can be + retrieved online at http://www.erlang.org/. + + Software distributed under the License is distributed on an "AS IS" + basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See + the License for the specific language governing rights and limitations + under the License. + + The Initial Developer of the Original Code is Ericsson AB. + </legalnotice> + + <title>CosNotifyComm_­NotifySubscribe</title> + <shorttitle>..._NotifySubscribe</shorttitle> + <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_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> + |