From 84adefa331c4159d432d22840663c38f155cd4c1 Mon Sep 17 00:00:00 2001 From: Erlang/OTP Date: Fri, 20 Nov 2009 14:54:40 +0000 Subject: The R13B03 release. --- lib/cosEventDomain/doc/html/.gitignore | 0 lib/cosEventDomain/doc/man3/.gitignore | 0 lib/cosEventDomain/doc/man6/.gitignore | 0 lib/cosEventDomain/doc/pdf/.gitignore | 0 lib/cosEventDomain/doc/src/CosEventDomainAdmin.xml | 92 +++ .../doc/src/CosEventDomainAdmin_EventDomain.xml | 627 +++++++++++++++++++++ .../src/CosEventDomainAdmin_EventDomainFactory.xml | 88 +++ lib/cosEventDomain/doc/src/Makefile | 227 ++++++++ lib/cosEventDomain/doc/src/book.gif | Bin 0 -> 1081 bytes lib/cosEventDomain/doc/src/book.xml | 48 ++ lib/cosEventDomain/doc/src/ch_QoS.xml | 117 ++++ lib/cosEventDomain/doc/src/ch_contents.xml | 68 +++ .../doc/src/ch_event_domain_service.xml | 110 ++++ lib/cosEventDomain/doc/src/ch_introduction.xml | 52 ++ lib/cosEventDomain/doc/src/cosEventDomainApp.xml | 149 +++++ lib/cosEventDomain/doc/src/fascicules.xml | 18 + lib/cosEventDomain/doc/src/make.dep | 23 + lib/cosEventDomain/doc/src/notes.gif | Bin 0 -> 2005 bytes lib/cosEventDomain/doc/src/notes.xml | 168 ++++++ lib/cosEventDomain/doc/src/part.xml | 39 ++ lib/cosEventDomain/doc/src/part_notes.xml | 36 ++ lib/cosEventDomain/doc/src/ref_man.gif | Bin 0 -> 1530 bytes lib/cosEventDomain/doc/src/ref_man.xml | 39 ++ lib/cosEventDomain/doc/src/summary.html.src | 1 + lib/cosEventDomain/doc/src/user_guide.gif | Bin 0 -> 1581 bytes 25 files changed, 1902 insertions(+) create mode 100644 lib/cosEventDomain/doc/html/.gitignore create mode 100644 lib/cosEventDomain/doc/man3/.gitignore create mode 100644 lib/cosEventDomain/doc/man6/.gitignore create mode 100644 lib/cosEventDomain/doc/pdf/.gitignore create mode 100644 lib/cosEventDomain/doc/src/CosEventDomainAdmin.xml create mode 100644 lib/cosEventDomain/doc/src/CosEventDomainAdmin_EventDomain.xml create mode 100644 lib/cosEventDomain/doc/src/CosEventDomainAdmin_EventDomainFactory.xml create mode 100644 lib/cosEventDomain/doc/src/Makefile create mode 100644 lib/cosEventDomain/doc/src/book.gif create mode 100644 lib/cosEventDomain/doc/src/book.xml create mode 100644 lib/cosEventDomain/doc/src/ch_QoS.xml create mode 100644 lib/cosEventDomain/doc/src/ch_contents.xml create mode 100644 lib/cosEventDomain/doc/src/ch_event_domain_service.xml create mode 100644 lib/cosEventDomain/doc/src/ch_introduction.xml create mode 100644 lib/cosEventDomain/doc/src/cosEventDomainApp.xml create mode 100644 lib/cosEventDomain/doc/src/fascicules.xml create mode 100644 lib/cosEventDomain/doc/src/make.dep create mode 100644 lib/cosEventDomain/doc/src/notes.gif create mode 100644 lib/cosEventDomain/doc/src/notes.xml create mode 100644 lib/cosEventDomain/doc/src/part.xml create mode 100644 lib/cosEventDomain/doc/src/part_notes.xml create mode 100644 lib/cosEventDomain/doc/src/ref_man.gif create mode 100644 lib/cosEventDomain/doc/src/ref_man.xml create mode 100644 lib/cosEventDomain/doc/src/summary.html.src create mode 100644 lib/cosEventDomain/doc/src/user_guide.gif (limited to 'lib/cosEventDomain/doc') diff --git a/lib/cosEventDomain/doc/html/.gitignore b/lib/cosEventDomain/doc/html/.gitignore new file mode 100644 index 0000000000..e69de29bb2 diff --git a/lib/cosEventDomain/doc/man3/.gitignore b/lib/cosEventDomain/doc/man3/.gitignore new file mode 100644 index 0000000000..e69de29bb2 diff --git a/lib/cosEventDomain/doc/man6/.gitignore b/lib/cosEventDomain/doc/man6/.gitignore new file mode 100644 index 0000000000..e69de29bb2 diff --git a/lib/cosEventDomain/doc/pdf/.gitignore b/lib/cosEventDomain/doc/pdf/.gitignore new file mode 100644 index 0000000000..e69de29bb2 diff --git a/lib/cosEventDomain/doc/src/CosEventDomainAdmin.xml b/lib/cosEventDomain/doc/src/CosEventDomainAdmin.xml new file mode 100644 index 0000000000..d0aac961d7 --- /dev/null +++ b/lib/cosEventDomain/doc/src/CosEventDomainAdmin.xml @@ -0,0 +1,92 @@ + + + + +
+ + 2002 + 2007 + Ericsson AB, All Rights Reserved + + + The contents of this file are subject to the Erlang Public License, + Version 1.1, (the "License"); you may not use this file except in + compliance with the License. You should have received a copy of the + Erlang Public License along with this software. If not, it can be + retrieved online at http://www.erlang.org/. + + Software distributed under the License is distributed on an "AS IS" + basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See + the License for the specific language governing rights and limitations + under the License. + + The Initial Developer of the Original Code is Ericsson AB. + + + CosEventDomainAdmin + Niclas Eklund + Niclas Eklund + + Niclas Eklund + + 2001-08-20 + PA1 +
+ CosEventDomainAdmin + This module export functions which return QoS and Admin Properties constants. + +

To get access to all definitions include necessary files by using:

+ + + + 'CycleDetection'() -> string() + Return the CycleDetection identifier required when defining QoS Properties + +

This function returns the CycleDetection identifier; required when + defining QoS Properties.

+ + + + 'AuthorizeCycles'() -> short() + Return the AuthorizeCycles value; required when defining QoS Properties + +

This function returns the AuthorizeCycles value; required when + defining QoS Properties.

+ + + + 'ForbidCycles'() -> short() + Return the ForbidCycles value; required when defining QoS Properties + +

This function returns the ForbidCycles value; required when + defining QoS Properties.

+ + + + 'DiamondDetection'() -> string() + Return the DiamondDetection identifier required when defining QoS Properties + +

This function returns the DiamondDetection identifier; required when + defining QoS Properties.

+ + + + 'AuthorizeDiamonds'() -> short() + Return the AuthorizeDiamonds value; required when defining QoS Properties + +

This function returns the AuthorizeDiamonds value; required when + defining QoS Properties.

+ + + + 'ForbidDiamonds'() -> short() + Return the ForbidDiamonds value; required when defining QoS Properties + +

This function returns the ForbidDiamonds value; required when + defining QoS Properties.

+ + + + + + diff --git a/lib/cosEventDomain/doc/src/CosEventDomainAdmin_EventDomain.xml b/lib/cosEventDomain/doc/src/CosEventDomainAdmin_EventDomain.xml new file mode 100644 index 0000000000..cf1cdab966 --- /dev/null +++ b/lib/cosEventDomain/doc/src/CosEventDomainAdmin_EventDomain.xml @@ -0,0 +1,627 @@ + + + + +
+ + 20012009 + Ericsson AB. All Rights Reserved. + + + The contents of this file are subject to the Erlang Public License, + Version 1.1, (the "License"); you may not use this file except in + compliance with the License. You should have received a copy of the + Erlang Public License along with this software. If not, it can be + retrieved online at http://www.erlang.org/. + + Software distributed under the License is distributed on an "AS IS" + basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See + the License for the specific language governing rights and limitations + under the License. + + + + CosEventDomainAdmin_­EventDomain + ..._EventDomain + + + Niclas Eklund + + 2001-08-20 + PA1 +
+ CosEventDomainAdmin_EventDomain + This module implements the Event Domain interface. + +

To get access to all definitions include necessary files by using:

+

This module also exports the functions described in:

+ + CosNotification_QoSAdmin + CosNotification_AdminPropertiesAdmin + + + + + add_channel(EventDomain, Channel) -> MemberID + Add a new channel to the EventDomain + + EventDomain = Channel = #objref + MemberID = long() + + +

Adds the given channel to the target domain. The channel + must be a .

+ + + + get_all_channels(EventDomain) -> MemberIDSeq + Return all channel id's associated with target object + + EventDomain = #objref + MemberIDSeq = [long()] + + +

Returns a a sequence of all channels associated with + the target object.

+ + + + get_channel(EventDomain, MemberID) -> Reply + Return the channel associated with the given id + + EventDomain = #objref + MemberID = long() + Reply = Channel | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}} + Channel = #objref + + +

If the target domain have a + represented by the given id this channel is returned. Otherwise, + an exception is raised.

+ + + + remove_channel(EventDomain, MemberID) -> Reply + Remove the channel associated with the given id and remove all connections of that channel + + EventDomain = #objref + MemberID = long() + Reply = ok | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}} + + +

If a with the + exists it will removed and all its + terminated. Otherwise an exception is raised.

+ + + + add_connection(EventDomain, Connection) -> Reply + If possible, setup a connection described by the struct + + EventDomain = #objref + Connection = 'CosEventDomainAdmin_Connection'{supplier_id=MemberID, consumer_id=MemberID, ctype=Type, notification_style=Style} + MemberID = long() + Type = 'ANY_EVENT' | 'STRUCTURED_EVENT' | 'SEQUENCE_EVENT' + Style = 'Pull' | 'Push' + Reply = ConnectionID | {'EXCEPTION', Exc} + ConnectionID = long() + Exc = #'CosNotifyChannelAdmin_ChannelNotFound'{} | #'CosNotifyChannelAdmin_TypeError'{} | #'CosEventDomainAdmin_AlreadyExists'{} | #'CosEventDomainAdmin_DiamondCreationForbidden'{diam=RouteSeq} | #'CosEventDomainAdmin_CycleCreationForbidden'{cyc=MemberIDSeq} + RouteSeq = [MemberIDSeq] + MemberIDSeq = [long()] + + +

The Connection parameter must contain valid data to enable + the target domain to setup a connection between two channels. + The struct members and + determines which channel should produce and consume events. + which type of events and if the supplier should push or the + consumer pull events is determined by and + respectively.

+

If the target domain is not able to setup the connection + the appropriate exception is raised.

+ + + + get_all_connections(EventDomain) -> ConnectionIDSeq + Return a sequence of all connections within the target domain + + EventDomain = #objref + ConnectionIDSeq = [long()] + + +

This operation returns a sequence of all connections within + the target domain.

+ + + + get_connection(EventDomain, ConnectionID) -> Reply + Return a struct describing the connection associated with the given id within the target domain + + EventDomain = #objref + ConnectionID = long() + Reply = Connection | {'EXCEPTION', #'CosEventDomainAdmin_ConnectionNotFound'{}} + Connection = 'CosEventDomainAdmin_Connection'{supplier_id=MemberID, consumer_id=MemberID, ctype=Type, notification_style=Style} + MemberID = long() + Type = 'ANY_EVENT' | 'STRUCTURED_EVENT' | 'SEQUENCE_EVENT' + Style = 'Pull' | 'Push' + + +

If a connection identified by the given id exists within the + target domain, a which + describe the connection is returned. Otherwise, an exception + is raised.

+ + + + remove_connection(EventDomain, ConnectionID) -> Reply + Remove the connection identified by the given id from the target domain + + EventDomain = #objref + ConnectionID = long() + Reply = ok | {'EXCEPTION', #'CosEventDomainAdmin_ConnectionNotFound'{}} + + +

If the supplied connection id exists, the connection the + id represents is terminated. Otherwise, an exception is raised.

+ + + + get_offer_channels(EventDomain, MemberID) -> Reply + Return all id's of the channels which produce events received by the channel identified by the given id + + EventDomain = #objref + MemberID = long() + Reply = MemberIDSeq | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}} + + +

This operation returns a sequence, containing the member id's + of all channels within the target domain which will supply events + to the channel identified by the given id. But, if no such + id exists in this domain, an exception is raised.

+ + + + get_subscription_channels(EventDomain, MemberID) -> Reply + Return all id's of the channels which consume events supplied by the channel identified by the given id + + EventDomain = #objref + Reply = MemberIDSeq | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}} + + +

This operations behaves like ; + the difference is that the id's returned identifies channels + which will consume events supplied by the channel associated + with the given id.

+ + + + destroy(EventDomain) -> ok + Destroy the event domain and all connections within it + + EventDomain = #objref + + +

Calling this operation will terminate all connections + within the target domain. The domain will terminate but + all channels will not be affected.

+ + + + get_cycles(EventDomain) -> RouteSeq + Return a list of all cycles which exists within the target domain + + EventDomain = #objref + RouteSeq = [MemberIDSeq] + MemberIDSeq = [long()] + + +

Returns a list of all cycles within the target domain.

+ + + + get_diamonds(EventDomain) -> DiamondSeq + Return a list of all diamonds which exists within the target domain + + EventDomain = #objref + DiamondSeq = [RouteSeq] + RouteSeq = [MemberIDSeq] + MemberIDSeq = [long()] + + +

Returns a list of all diamonds within the target domain

+ + + + set_default_consumer_channel(EventDomain, MemberID) -> Reply + Set the channel represented by the given id as default for supplier clients + + EventDomain = #objref + Reply = MemberID | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}} + MemberID = long() + + +

If the given id represents a channel within the target domain, + this channel will be used when connection a supplier client + without specifying a certain channel. If no such channel exists + an exceptions is raised.

+ + + + set_default_supplier_channel(EventDomain, MemberID) -> Reply + Set the channel represented by the given id as default for supplier clients + + EventDomain = #objref + Reply = MemberID | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}} + MemberID = long() + + +

If the given id represents a channel within the target domain, + this channel will be used when connection a consumer client + without specifying a certain channel. If no such channel exists + an exceptions is raised.

+ + + + connect_push_consumer(EventDomain, Consumer) -> Reply + Connect the PushConsumer to the default Channel + + EventDomain = #objref + Consumer = CosEventComm::PushConsumer + Reply = CosNotifyChannelAdmin::ProxyPushSupplier | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}} + + +

If a default Channel have been set, this operation connects the given + PushConsumer to it. Otherwise, the + exception is raised.

+ + + + connect_pull_consumer(EventDomain, Consumer) -> Reply + Connect the PullConsumer to the default Channel + + EventDomain = #objref + Consumer = CosEventComm::PullConsumer + Reply = CosNotifyChannelAdmin::ProxyPullSupplier | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}} + + +

If a default Channel have been set, this operation connects the given + PullConsumer to it. Otherwise, the + exception is raised.

+ + + + connect_push_supplier(EventDomain, Supplier) -> Reply + Connect the PushSupplier to the default Channel + + EventDomain = #objref + Supplier = CosEventComm::PushSupplier + Reply = CosNotifyChannelAdmin::ProxyPushConsumer | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}} + + +

If a default Channel have been set, this operation connects the given + PushSupplier to it. Otherwise, the + exception is raised.

+ + + + connect_pull_supplier(EventDomain, Supplier) -> Reply + Connect the PullSupplier to the default Channel + + EventDomain = #objref + Supplier = CosEventComm::PullSupplier + Reply = CosNotifyChannelAdmin::ProxyPushConsumer | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}} + + +

If a default Channel have been set, this operation connects the given + PullSupplier to it. Otherwise, the + exception is raised.

+ + + + connect_structured_push_consumer(EventDomain, Consumer) -> Reply + Connect the StructuredPushConsumer to the default Channel + + EventDomain = #objref + Consumer = CosNotifyComm::StructuredPushConsumer + Reply = CosNotifyChannelAdmin::StructuredProxyPushSupplier | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}} + + +

If a default Channel have been set, this operation connects the given + StructuredPushConsumer to it. Otherwise, the + exception is raised.

+ + + + connect_structured_pull_consumer(EventDomain, Consumer) -> Reply + Connect the StructuredPullConsumer to the default Channel + + EventDomain = #objref + Consumer = CosNotifyComm::StructuredPullConsumer + Reply = CosNotifyChannelAdmin::StructuredProxyPullSupplier | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}} + + +

If a default Channel have been set, this operation connects the given + StructuredPullConsumer to it. Otherwise, the + exception is raised.

+ + + + connect_structured_push_supplier(EventDomain, Supplier) -> Reply + Connect the StructuredPushSupplier to the default Channel + + EventDomain = #objref + Supplier = CosNotifyComm::StructuredPushSupplier + Reply = CosNotifyChannelAdmin::StructuredProxyPushConsumer | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}} + + +

If a default Channel have been set, this operation connects the given + StructuredPushSupplier to it. Otherwise, the + exception is raised.

+ + + + connect_structured_pull_supplier(EventDomain, Supplier) -> Reply + Connect the StructuredPullSupplier to the default Channel + + EventDomain = #objref + Supplier = CosNotifyComm::StructuredPullSupplier + Reply = CosNotifyChannelAdmin::StructuredProxyPullConsume | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}} + + +

If a default Channel have been set, this operation connects the given + StructuredPullSupplier to it. Otherwise, the + exception is raised.

+ + + + connect_sequence_push_consumer(EventDomain, Consumer) -> Reply + Connect the SequencePushConsumer to the default Channel + + EventDomain = #objref + Consumer = CosNotifyComm::SequencePushConsumer + Reply = CosNotifyChannelAdmin::SequenceProxyPushSupplier | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}} + + +

If a default Channel have been set, this operation connects the given + SequencePushConsumer to it. Otherwise, the + exception is raised.

+ + + + connect_sequence_pull_consumer(EventDomain, Consumer) -> Reply + Connect the SequencePullConsumer to the default Channel + + EventDomain = #objref + Consumer = CosNotifyComm::SequencePullConsumer + Reply = CosNotifyChannelAdmin::SequenceProxyPullSupplier | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}} + + +

If a default Channel have been set, this operation connects the given + SequencePullConsumer to it. Otherwise, the + exception is raised.

+ + + + connect_sequence_push_supplier(EventDomain, Supplier) -> Reply + Connect the SequencePushSupplier to the default Channel + + EventDomain = #objref + Supplier = CosNotifyComm::SequencePushSupplier + Reply = CosNotifyChannelAdmin::SequenceProxyPushConsumer | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}} + + +

If a default Channel have been set, this operation connects the given + SequencePushSupplier to it. Otherwise, the + exception is raised.

+ + + + connect_sequence_pull_supplier(EventDomain, Supplier) -> Reply + Connect the SequencePullSupplier to the default Channel + + EventDomain = #objref + Supplier = CosNotifyComm::SequencePullSupplier + Reply = CosNotifyChannelAdmin::SequenceProxyPullConsumer | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}} + + +

If a default Channel have been set, this operation connects the given + SequencePullSupplier to it. Otherwise, the + exception is raised.

+ + + + connect_push_consumer_with_id(EventDomain, Consumer, MemberID) -> Reply + Connect the PushConsumer to the Channel with the given MemberID + + EventDomain = #objref + Consumer = CosEventComm::PushConsumer + MemberID = long() + Reply = CosNotifyChannelAdmin::ProxyPushSupplier | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}} + + +

If a Channel associated with the given MemberID exists within the + target Domain, this operation connects the given PushConsumer + to it. Otherwise, the + exception is raised.

+ + + + connect_pull_consumer_with_id(EventDomain, Consumer, MemberID) -> Reply + Connect the PullConsumer to the Channel with the given MemberID + + EventDomain = #objref + Consumer = CosEventComm::PullConsumer + MemberID = long() + Reply = CosNotifyChannelAdmin::ProxyPullSupplier | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}} + + +

If a Channel associated with the given MemberID exists within the + target Domain, this operation connects the given PullConsumer + to it. Otherwise, the + exception is raised.

+ + + + connect_push_supplier_with_id(EventDomain, Supplier, MemberID) -> Reply + Connect the PushSupplier to the Channel with the given MemberID + + EventDomain = #objref + Supplier = CosEventComm::PushSupplier + MemberID = long() + Reply = CosNotifyChannelAdmin::ProxyPushConsumer | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}} + + +

If a Channel associated with the given MemberID exists within the + target Domain, this operation connects the given PushSupplier + to it. Otherwise, the + exception is raised.

+ + + + connect_pull_supplier_with_id(EventDomain, Supplier, MemberID) -> Reply + Connect the PullSupplier to the Channel with the given MemberID + + EventDomain = #objref + Supplier = CosEventComm::PullSupplier + MemberID = long() + Reply = CosNotifyChannelAdmin::ProxyPushConsumer | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}} + + +

If a Channel associated with the given MemberID exists within the + target Domain, this operation connects the given PullSupplier + to it. Otherwise, the + exception is raised.

+ + + + connect_structured_push_consumer_with_id(EventDomain, Consumer, MemberID) -> Reply + Connect the StructuredPushConsumer to the Channel with the given MemberID + + EventDomain = #objref + Consumer = CosNotifyComm::StructuredPushConsumer + MemberID = long() + Reply = CosNotifyChannelAdmin::StructuredProxyPushSupplier | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}} + + +

If a Channel associated with the given MemberID exists within the + target Domain, this operation connects the given StructuredPushConsumer + to it. Otherwise, the + exception is raised.

+ + + + connect_structured_pull_consumer_with_id(EventDomain, Consumer, MemberID) -> Reply + Connect the StructuredPullConsumer to the Channel with the given MemberID + + EventDomain = #objref + Consumer = CosNotifyComm::StructuredPullConsumer + MemberID = long() + Reply = CosNotifyChannelAdmin::StructuredProxyPullSupplier | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}} + + +

If a Channel associated with the given MemberID exists within the + target Domain, this operation connects the given StructuredPullConsumer + to it. Otherwise, the + exception is raised.

+ + + + connect_structured_push_supplier_with_id(EventDomain, Supplier, MemberID) -> Reply + Connect the StructuredPushSupplier to the Channel with the given MemberID + + EventDomain = #objref + Supplier = CosNotifyComm::StructuredPushSupplier + MemberID = long() + Reply = CosNotifyChannelAdmin::StructuredProxyPushConsumer | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}} + + +

If a Channel associated with the given MemberID exists within the + target Domain, this operation connects the given StructuredPushSupplier + to it. Otherwise, the + exception is raised.

+ + + + connect_structured_pull_supplier_with_id(EventDomain, Supplier, MemberID) -> Reply + Connect the StructuredPullSupplier to the Channel with the given MemberID + + EventDomain = #objref + Supplier = CosNotifyComm::StructuredPullSupplier + MemberID = long() + Reply = CosNotifyChannelAdmin::StructuredProxyPullConsumer | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}} + + +

If a Channel associated with the given MemberID exists within the + target Domain, this operation connects the given StructuredPullSupplier + to it. Otherwise, the + exception is raised.

+ + + + connect_sequence_push_consumer_with_id(EventDomain, Consumer, MemberID) -> Reply + Connect the SequencePushConsumer to the Channel with the given MemberID + + EventDomain = #objref + Consumer = CosNotifyComm::SequencePushConsumer + MemberID = long() + Reply = CosNotifyChannelAdmin::SequenceProxyPushSupplier | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}} + + +

If a Channel associated with the given MemberID exists within the + target Domain, this operation connects the given SequencePushConsumer + to it. Otherwise, the + exception is raised.

+ + + + connect_sequence_pull_consumer_with_id(EventDomain, Consumer, MemberID) -> Reply + Connect the SequencePullConsumer to the Channel with the given MemberID + + EventDomain = #objref + Consumer = CosNotifyComm::SequencePullConsumer + MemberID = long() + Reply = CosNotifyChannelAdmin::SequenceProxyPullSupplier | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}} + + +

If a Channel associated with the given MemberID exists within the + target Domain, this operation connects the given SequencePullConsumer + to it. Otherwise, the + exception is raised.

+ + + + connect_sequence_push_supplier_with_id(EventDomain, Supplier, MemberID) -> Reply + Connect the SequencePushSupplier to the Channel with the given MemberID + + EventDomain = #objref + Supplier = CosNotifyComm::SequencePushSupplier + MemberID = long() + Reply = CosNotifyChannelAdmin::SequenceProxyPushConsumer | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}} + + +

If a Channel associated with the given MemberID exists within the + target Domain, this operation connects the given SequencePushSupplier + to it. Otherwise, the + exception is raised.

+ + + + connect_sequence_pull_supplier_with_id(EventDomain, Supplier, MemberID) -> Reply + Connect the SequencePullSupplier to the Channel with the given MemberID + + EventDomain = #objref + Supplier = CosNotifyComm::SequencePullSupplier + MemberID = long() + Reply = CosNotifyChannelAdmin::SequenceProxyPullConsumer | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}} + + +

If a Channel associated with the given MemberID exists within the + target Domain, this operation connects the given SequencePullSupplier + to it. Otherwise, the + exception is raised.

+ + + + + + diff --git a/lib/cosEventDomain/doc/src/CosEventDomainAdmin_EventDomainFactory.xml b/lib/cosEventDomain/doc/src/CosEventDomainAdmin_EventDomainFactory.xml new file mode 100644 index 0000000000..0720a4b930 --- /dev/null +++ b/lib/cosEventDomain/doc/src/CosEventDomainAdmin_EventDomainFactory.xml @@ -0,0 +1,88 @@ + + + + +
+ + 2001 + 2007 + Ericsson AB, All Rights Reserved + + + The contents of this file are subject to the Erlang Public License, + Version 1.1, (the "License"); you may not use this file except in + compliance with the License. You should have received a copy of the + Erlang Public License along with this software. If not, it can be + retrieved online at http://www.erlang.org/. + + Software distributed under the License is distributed on an "AS IS" + basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See + the License for the specific language governing rights and limitations + under the License. + + The Initial Developer of the Original Code is Ericsson AB. + + + CosEventDomainAdmin_­EventDomainFactory + ..._EventChannel + Niclas Eklund + Niclas Eklund + + Niclas Eklund + + 2001-08-20 + PA1 +
+ CosEventDomainAdmin_EventDomainFactory + This module implements an Event Domain Factory interface, which is used to create new Event Domain instances. + +

To get access to all definitions include necessary files by using:

+ + + + create_event_domain(Factory, QoS, Admin) -> Reply + Create a new ConsumerAdmin object + + Factory = #objref + QoS = CosNotification::QoSProperties + Admin = CosNotification::AdminProperties + Reply = {EventDomain, DomainID} | {'EXCEPTION', #'CosNotification_UnsupportedQoS'{}} | {'EXCEPTION', #'CosNotification_UnsupportedAdmin'{}} + EventDomain = #objref + + +

To create a new EventDomain this operation is used. If it is not + possible to support the given or + an exception is raised, which list the properties not supported. For more + information see the user's guide.

+ + + + get_all_domains(Factory) -> DomainIDSeq + Return a DomainID sequence of all domains associated with the target object + + Factory = #objref + DomainIDSeq = [long()] + + +

This function returns a DomainID sequence of all domains associated with the + target object.

+ + + + get_event_domain(Factory, DomainID) -> Reply + Return the domain associated with the given id + + Factory = #objref + DomainID = long() + Reply = EventDomain | {'EXCEPTION', #'CosEventDomainAdmin_DomainNotFound'{}} + EventDomain = #objref + + +

This operation returns the EventDomain object associated with the + given DomainID. If no such binding exists an exception is raised.

+ + + + + + diff --git a/lib/cosEventDomain/doc/src/Makefile b/lib/cosEventDomain/doc/src/Makefile new file mode 100644 index 0000000000..465b726ad1 --- /dev/null +++ b/lib/cosEventDomain/doc/src/Makefile @@ -0,0 +1,227 @@ +# +# %CopyrightBegin% +# +# Copyright Ericsson AB 2001-2009. All Rights Reserved. +# +# The contents of this file are subject to the Erlang Public License, +# Version 1.1, (the "License"); you may not use this file except in +# compliance with the License. You should have received a copy of the +# Erlang Public License along with this software. If not, it can be +# retrieved online at http://www.erlang.org/. +# +# Software distributed under the License is distributed on an "AS IS" +# basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See +# the License for the specific language governing rights and limitations +# under the License. +# +# %CopyrightEnd% +# +# +include $(ERL_TOP)/make/target.mk +include $(ERL_TOP)/make/$(TARGET)/otp.mk + +# ---------------------------------------------------- +# Application version +# ---------------------------------------------------- +include ../../vsn.mk +VSN=$(COSEVENTDOMAIN_VSN) +APPLICATION=cosEventDomain + +# ---------------------------------------------------- +# Include dependency +# ---------------------------------------------------- + +ifndef DOCSUPPORT +include make.dep +endif + +# ---------------------------------------------------- +# Release directory specification +# ---------------------------------------------------- +RELSYSDIR = $(RELEASE_PATH)/lib/$(APPLICATION)-$(VSN) + +# ---------------------------------------------------- +# Target Specs +# ---------------------------------------------------- +XML_APPLICATION_FILES = ref_man.xml +XML_REF3_FILES = \ + CosEventDomainAdmin_EventDomainFactory.xml \ + CosEventDomainAdmin_EventDomain.xml \ + CosEventDomainAdmin.xml \ + cosEventDomainApp.xml + +XML_PART_FILES = \ + part.xml \ + part_notes.xml +XML_CHAPTER_FILES = \ + ch_contents.xml \ + ch_introduction.xml \ + ch_QoS.xml \ + ch_event_domain_service.xml \ + notes.xml + +BOOK_FILES = book.xml + +TECHNICAL_DESCR_FILES = + +GIF_FILES = \ + book.gif \ + notes.gif \ + ref_man.gif \ + user_guide.gif + + +PS_FILES = + + +# ---------------------------------------------------- + +INTERNAL_HTML_FILES = $(TECHNICAL_DESCR_FILES:%.xml=$(HTMLDIR)/%.html) + +HTML_FILES = $(XML_APPLICATION_FILES:%.xml=$(HTMLDIR)/%.html) \ + $(XML_PART_FILES:%.xml=$(HTMLDIR)/%.html) + +INFO_FILE = ../../info +EXTRA_FILES = summary.html.src \ + $(DEFAULT_GIF_FILES) \ + $(DEFAULT_HTML_FILES) \ + $(XML_REF3_FILES:%.xml=$(HTMLDIR)/%.html) \ + $(XML_CHAPTER_FILES:%.xml=$(HTMLDIR)/%.html) + +MAN3_FILES = $(XML_REF3_FILES:%.xml=$(MAN3DIR)/%.3) + +ifdef DOCSUPPORT + +HTML_REF_MAN_FILE = $(HTMLDIR)/index.html + +TOP_PDF_FILE = $(PDFDIR)/$(APPLICATION)-$(VSN).pdf + +else + +TEX_FILES_BOOK = \ + $(BOOK_FILES:%.xml=%.tex) +TEX_FILES_REF_MAN = $(XML_REF3_FILES:%.xml=%.tex) \ + $(XML_APPLICATION_FILES:%.xml=%.tex) +TEX_FILES_USERS_GUIDE = \ + $(XML_CHAPTER_FILES:%.xml=%.tex) + +TOP_PDF_FILE = $(APPLICATION)-$(VSN).pdf + +TOP_PS_FILE = $(APPLICATION)-$(VSN).ps + +$(TOP_PDF_FILE): book.dvi ../../vsn.mk + $(DVI2PS) $(DVIPS_FLAGS) -f $< | $(DISTILL) $(DISTILL_FLAGS) > $@ + +$(TOP_PS_FILE): book.dvi ../../vsn.mk + $(DVI2PS) $(DVIPS_FLAGS) -f $< > $@ + +endif + +# ---------------------------------------------------- +# FLAGS +# ---------------------------------------------------- +XML_FLAGS += +DVIPS_FLAGS += + +# ---------------------------------------------------- +# Targets +# ---------------------------------------------------- +$(HTMLDIR)/%.gif: %.gif + $(INSTALL_DATA) $< $@ + +ifdef DOCSUPPORT + +docs: pdf html man + +$(TOP_PDF_FILE): $(XML_FILES) + +pdf: $(TOP_PDF_FILE) + +html: gifs $(HTML_REF_MAN_FILE) + +clean clean_docs: + rm -rf $(HTMLDIR)/* + rm -f $(MAN3DIR)/* + rm -f $(TOP_PDF_FILE) $(TOP_PDF_FILE:%.pdf=%.fo) + rm -f errs core *~ + rm -f $(JD_HTML) $(JD_PACK) + +else + +ifeq ($(DOCTYPE),pdf) +docs: pdf +else +ifeq ($(DOCTYPE),ps) +docs: ps +else +docs: html gifs man +endif +endif + +pdf: $(TOP_PDF_FILE) + +ps: $(TOP_PS_FILE) + +html: $(HTML_FILES) $(INTERNAL_HTML_FILES) + +clean clean_docs clean_tex: + rm -f $(TEX_FILES_USERS_GUIDE) $(TEX_FILES_REF_MAN) $(TEX_FILES_BOOK) + rm -f $(HTML_FILES) $(MAN3_FILES) + rm -f $(TOP_PDF_FILE) $(TOP_PS_FILE) + rm -f errs core *~ *xmls_output *xmls_errs $(LATEX_CLEAN) + +endif + +man: $(MAN3_FILES) + +gifs: $(GIF_FILES:%=$(HTMLDIR)/%) + +$(INDEX_TARGET): $(INDEX_SRC) + sed -e 's;%VSN%;$(VSN);' $(INDEX_SRC) > $(INDEX_TARGET) + +debug opt: + +# ---------------------------------------------------- +# Release Target +# ---------------------------------------------------- +include $(ERL_TOP)/make/otp_release_targets.mk + + +ifdef DOCSUPPORT + +release_docs_spec: docs + $(INSTALL_DIR) $(RELSYSDIR)/doc/pdf + $(INSTALL_DATA) $(TOP_PDF_FILE) $(RELSYSDIR)/doc/pdf + $(INSTALL_DIR) $(RELSYSDIR)/doc/html + $(INSTALL_DATA) $(HTMLDIR)/* \ + $(RELSYSDIR)/doc/html + $(INSTALL_DATA) $(INFO_FILE) $(RELSYSDIR) + $(INSTALL_DIR) $(RELEASE_PATH)/man/man3 + $(INSTALL_DATA) $(MAN3DIR)/* $(RELEASE_PATH)/man/man3 +else + +ifeq ($(DOCTYPE),pdf) +release_docs_spec: pdf + $(INSTALL_DIR) $(RELEASE_PATH)/pdf + $(INSTALL_DATA) $(TOP_PDF_FILE) $(RELEASE_PATH)/pdf +else +ifeq ($(DOCTYPE),ps) +release_docs_spec: ps + $(INSTALL_DIR) $(RELEASE_PATH)/ps + $(INSTALL_DATA) $(TOP_PS_FILE) $(RELEASE_PATH)/ps +else +release_docs_spec: docs + $(INSTALL_DIR) $(RELSYSDIR)/doc/html + $(INSTALL_DATA) $(GIF_FILES) $(EXTRA_FILES) $(HTML_FILES) \ + $(RELSYSDIR)/doc/html + $(INSTALL_DATA) $(INFO_FILE) $(RELSYSDIR) + $(INSTALL_DIR) $(RELEASE_PATH)/man/man3 + $(INSTALL_DATA) $(MAN3_FILES) $(RELEASE_PATH)/man/man3 + +endif +endif + +endif + +release_spec: + diff --git a/lib/cosEventDomain/doc/src/book.gif b/lib/cosEventDomain/doc/src/book.gif new file mode 100644 index 0000000000..94b3868792 Binary files /dev/null and b/lib/cosEventDomain/doc/src/book.gif differ diff --git a/lib/cosEventDomain/doc/src/book.xml b/lib/cosEventDomain/doc/src/book.xml new file mode 100644 index 0000000000..3a36704355 --- /dev/null +++ b/lib/cosEventDomain/doc/src/book.xml @@ -0,0 +1,48 @@ + + + + +
+ + 20012009 + Ericsson AB. All Rights Reserved. + + + The contents of this file are subject to the Erlang Public License, + Version 1.1, (the "License"); you may not use this file except in + compliance with the License. You should have received a copy of the + Erlang Public License along with this software. If not, it can be + retrieved online at http://www.erlang.org/. + + Software distributed under the License is distributed on an "AS IS" + basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See + the License for the specific language governing rights and limitations + under the License. + + + + cosEventDomain + Niclas Eklund + + 2001-08-20 + 1.0 +
+ + + cosEventDomain + + + + + + + + + + + + + + + + diff --git a/lib/cosEventDomain/doc/src/ch_QoS.xml b/lib/cosEventDomain/doc/src/ch_QoS.xml new file mode 100644 index 0000000000..232cc4021a --- /dev/null +++ b/lib/cosEventDomain/doc/src/ch_QoS.xml @@ -0,0 +1,117 @@ + + + + +
+ + 20022009 + Ericsson AB. All Rights Reserved. + + + The contents of this file are subject to the Erlang Public License, + Version 1.1, (the "License"); you may not use this file except in + compliance with the License. You should have received a copy of the + Erlang Public License along with this software. If not, it can be + retrieved online at http://www.erlang.org/. + + Software distributed under the License is distributed on an "AS IS" + basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See + the License for the specific language governing rights and limitations + under the License. + + + + Quality Of Service and Admin Properties + + + 2000-05-29 + + ch_QoS.xml +
+ +
+ Quality Of Service and Admin Properties +

This chapter explains the allowed properties it is possible to set for this + application.

+ +
+ Quality Of Service +

The cosEventDomain application supports the following QoS settings:

+ + + QoS + Range + Default + + + CycleDetection + AuthorizeCycles/ForbidCycles + ForbidCycles + + + DiamondDetection + AuthorizeDiamonds/ForbidDiamonds + ForbidDiamonds + + Supported QoS settings +
+







Comments on the table 'Supported QoS Settings':

+ + CycleDetection + If a cycle is created, the user must be aware of the fact + that unless they set timeout on events, events that are not filtered + will loop endlessly through the topology. + DiamondDetection + A Diamond in this context, means that the same + event may reach a point in the graph by more than one route + (i.e. transitive). Hence, it is possible that multiple copies + are delivered. + +
+ +
+ Setting Quality Of Service +

Assume we have a Consumer Admin object which we want to change + the current Quality of Service. Typical usage:

+ +

If it is not possible to set the requested QoS the + exception is raised, which includes a sequence of 's + describing which QoS, possible range and why is not allowed. The error + codes are:

+ + UNSUPPORTED_PROPERTY - QoS not supported for this type of target object. + UNAVAILABLE_PROPERTY - due to current QoS settings the given property + is not allowed. + UNSUPPORTED_VALUE - property value out of range; valid range is returned. + UNAVAILABLE_VALUE - due to current QoS settings the given value is + not allowed; valid range is returned. + BAD_PROPERTY - unrecognized property. + BAD_TYPE - type of supplied property is incorrect. + BAD_VALUE - illegal value. + +

The CosEventDomainAdmin_EventDomain interface also supports an operation + called . 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.

+
+ +
+ Admin Properties +

The OMG specification do not contain any definitions of Admin Properties. + Hence, the cosEventDomain application currently does not support any Admin + Properties.

+
+
+ + diff --git a/lib/cosEventDomain/doc/src/ch_contents.xml b/lib/cosEventDomain/doc/src/ch_contents.xml new file mode 100644 index 0000000000..bdb951566f --- /dev/null +++ b/lib/cosEventDomain/doc/src/ch_contents.xml @@ -0,0 +1,68 @@ + + + + +
+ + 20012009 + Ericsson AB. All Rights Reserved. + + + The contents of this file are subject to the Erlang Public License, + Version 1.1, (the "License"); you may not use this file except in + compliance with the License. You should have received a copy of the + Erlang Public License along with this software. If not, it can be + retrieved online at http://www.erlang.org/. + + Software distributed under the License is distributed on an "AS IS" + basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See + the License for the specific language governing rights and limitations + under the License. + + + + The cosEventDomain Application + Niclas Eklund + + 2001-08-20 + B + ch_contents.xml +
+ +
+ Content Overview +

The cosEventDomain documentation is divided into three sections: +

+ + +

PART ONE - The User's Guide +

Description of the cosEventDomain Application including + services and a small tutorial demonstrating + the development of a simple service.

+ + +

PART TWO - Release Notes +

A concise history of cosEventDomain.

+ + +

PART THREE - The Reference Manual +

A quick reference guide, including a + brief description, to all the functions available in cosEventDomain.

+ + +
+ +
+ Brief Description of the User's Guide +

The User's Guide contains the following parts:

+ + +

CosEventDomain overview

+ + +

CosEventDomain installation and examples

+ + +
+ + diff --git a/lib/cosEventDomain/doc/src/ch_event_domain_service.xml b/lib/cosEventDomain/doc/src/ch_event_domain_service.xml new file mode 100644 index 0000000000..62378cac91 --- /dev/null +++ b/lib/cosEventDomain/doc/src/ch_event_domain_service.xml @@ -0,0 +1,110 @@ + + + + +
+ + 20012009 + Ericsson AB. All Rights Reserved. + + + The contents of this file are subject to the Erlang Public License, + Version 1.1, (the "License"); you may not use this file except in + compliance with the License. You should have received a copy of the + Erlang Public License along with this software. If not, it can be + retrieved online at http://www.erlang.org/. + + Software distributed under the License is distributed on an "AS IS" + basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See + the License for the specific language governing rights and limitations + under the License. + + + + Event Domain Service + Niclas Eklund + + 2001-08-20 + A + ch_event_domain_service.xml +
+ +
+ Overview of the CosEventDomain Service +

The Event Domain service allows programmers to manage a cluster + of information channels.

+ +
+ Event Domain Service Components +

There are two components in the OMG CosEventDomainAdmin service architecture:

+ + EventDomainFactory: a factory for creating EventDomains. + EventDomain: supplies a tool, which makes it easy to create + topologies of interconnected channels (i.e. a directed graph). + +
+ +
+ A Tutorial on How to Create a Simple Service +

To be able to use the cosEventDomain application, the cosNotification + and, possibly, the cosTime application must be installed.

+
+ +
+ How to Run Everything +

Below is a short transcript on how to run cosEventDomain.

+ +
+
+ + diff --git a/lib/cosEventDomain/doc/src/ch_introduction.xml b/lib/cosEventDomain/doc/src/ch_introduction.xml new file mode 100644 index 0000000000..8a85fc052f --- /dev/null +++ b/lib/cosEventDomain/doc/src/ch_introduction.xml @@ -0,0 +1,52 @@ + + + + +
+ + 20012009 + Ericsson AB. All Rights Reserved. + + + The contents of this file are subject to the Erlang Public License, + Version 1.1, (the "License"); you may not use this file except in + compliance with the License. You should have received a copy of the + Erlang Public License along with this software. If not, it can be + retrieved online at http://www.erlang.org/. + + Software distributed under the License is distributed on an "AS IS" + basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See + the License for the specific language governing rights and limitations + under the License. + + + + Introduction to cosEventDomain + Niclas Eklund + + 2001-08-20 + + ch_introduction.xml +
+ +
+ Overview +

The cosEventDomain application is a Event Domain Service compliant with the OMG + Service CosEventDomainAdmin. +

+ +
+ Purpose and Dependencies +

CosEventDomain is dependent on Orber, which provides CORBA functionality in an Erlang environment.

+
+ +
+ Prerequisites +

To fully understand the concepts presented in the + documentation, it is recommended that the user is familiar + with distributed programming and CORBA. +

+
+
+ + diff --git a/lib/cosEventDomain/doc/src/cosEventDomainApp.xml b/lib/cosEventDomain/doc/src/cosEventDomainApp.xml new file mode 100644 index 0000000000..fe8df55929 --- /dev/null +++ b/lib/cosEventDomain/doc/src/cosEventDomainApp.xml @@ -0,0 +1,149 @@ + + + + +
+ + 2001 + 2007 + Ericsson AB, All Rights Reserved + + + The contents of this file are subject to the Erlang Public License, + Version 1.1, (the "License"); you may not use this file except in + compliance with the License. You should have received a copy of the + Erlang Public License along with this software. If not, it can be + retrieved online at http://www.erlang.org/. + + Software distributed under the License is distributed on an "AS IS" + basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See + the License for the specific language governing rights and limitations + under the License. + + The Initial Developer of the Original Code is Ericsson AB. + + + cosEventDomainApp + Niclas Eklund + Niclas Eklund + + Niclas Eklund + + 2001-08-20 + PA1 +
+ cosEventDomainApp + The main module of the cosEventDomain application. + +

To get access to the record definitions for the structures use:

+

This module contains the functions for starting and stopping the application.

+ + + + install() -> Return + Install the cosEventDomain application + + Return = ok | {'EXCEPTION', E} | {'EXIT', R} + + +

This operation installs the cosEventDomain application.

+ + + + uninstall() -> Return + Uninstall the cosEventDomain application + + Return = ok | {'EXCEPTION', E} | {'EXIT', R} + + +

This operation uninstalls the cosEventDomain application.

+ + + + start() -> Return + Start the cosEventDomain application + + Return = ok | {error, Reason} + + +

This operation starts the cosEventDomain application.

+ + + + stop() -> Return + Stop the cosEventDomain application + + Return = ok | {error, Reason} + + +

This operation stops the cosEventDomain application.

+ + + + start_factory() -> Factory + Start a factory with default settings + + Factory = #objref + + +

This operation creates a new instance of a + Event Domain Factory + using the default settings.

+ + + + start_factory(Options) -> Factory + Start a factory with settings defined by the given options + + Options = [Option] + Option = currently no options defined. + Factory = #objref + + +

This operation creates a new instance of a + Event Domain Factory

+ + + + start_factory_link() -> Factory + Start a factory, which is linked to the invoking process, with default settings + + Factory = #objref + + +

This operation creates a new instance of a + Event Domain Factory, + which is linked to the invoking process, using the default settings.

+ + + + start_factory_link(Options) -> Factory + Start a factory, which is linked to the invoking process, with settings defined by the given options + + Options = [Option] + Option = currently no options defined. + Factory = #objref + + +

This operation creates a new instance of a + Event Domain Factory, + which is linked to the invoking process, with settings defined by the + given options. Allowed options are the same as for + .

+ + + + stop_factory(Factory) -> Reply + Terminate the target object + + Factory = #objref + Reply = ok | {'EXCEPTION', E} + + +

This operation stop the target factory.

+ + + + + + diff --git a/lib/cosEventDomain/doc/src/fascicules.xml b/lib/cosEventDomain/doc/src/fascicules.xml new file mode 100644 index 0000000000..0678195e07 --- /dev/null +++ b/lib/cosEventDomain/doc/src/fascicules.xml @@ -0,0 +1,18 @@ + + + + + + User's Guide + + + Reference Manual + + + Release Notes + + + Off-Print + + + diff --git a/lib/cosEventDomain/doc/src/make.dep b/lib/cosEventDomain/doc/src/make.dep new file mode 100644 index 0000000000..2f3f1ae53d --- /dev/null +++ b/lib/cosEventDomain/doc/src/make.dep @@ -0,0 +1,23 @@ +# ---------------------------------------------------- +# >>>> Do not edit this file <<<< +# This file was automaticly generated by +# /home/otp/bin/docdepend +# ---------------------------------------------------- + + +# ---------------------------------------------------- +# TeX files that the DVI file depend on +# ---------------------------------------------------- + +book.dvi: CosEventDomainAdmin.tex CosEventDomainAdmin_EventDomain.tex \ + CosEventDomainAdmin_EventDomainFactory.tex \ + book.tex ch_QoS.tex ch_contents.tex ch_event_domain_service.tex \ + ch_introduction.tex cosEventDomainApp.tex \ + part.tex ref_man.tex + +# ---------------------------------------------------- +# Source inlined when transforming from source to LaTeX +# ---------------------------------------------------- + +book.tex: ref_man.xml + diff --git a/lib/cosEventDomain/doc/src/notes.gif b/lib/cosEventDomain/doc/src/notes.gif new file mode 100644 index 0000000000..e000cca26a Binary files /dev/null and b/lib/cosEventDomain/doc/src/notes.gif differ diff --git a/lib/cosEventDomain/doc/src/notes.xml b/lib/cosEventDomain/doc/src/notes.xml new file mode 100644 index 0000000000..fdfb21c046 --- /dev/null +++ b/lib/cosEventDomain/doc/src/notes.xml @@ -0,0 +1,168 @@ + + + + +
+ + 20012009 + Ericsson AB. All Rights Reserved. + + + The contents of this file are subject to the Erlang Public License, + Version 1.1, (the "License"); you may not use this file except in + compliance with the License. You should have received a copy of the + Erlang Public License along with this software. If not, it can be + retrieved online at http://www.erlang.org/. + + Software distributed under the License is distributed on an "AS IS" + basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See + the License for the specific language governing rights and limitations + under the License. + + + + cosEventDomain Release Notes + Niclas Eklund + + + + 2001-08-20 + A + notes.xml +
+ +
+ cosEventDomain 1.1.7 + +
+ Improvements and New Features + + +

+ 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.

+

+ Own Id: OTP-8201 Aux Id:

+ + +
+
+ +
+ cosEventDomain 1.1.6 + +
+ Improvements and New Features + + +

Obsolete guards, e.g. record vs is_record, has been changed + to avoid compiler warnings.

+

Own id: OTP-7987

+ + +
+
+ +
+ cosEventDomain 1.1.5 + +
+ Improvements and New Features + + +

Updated file headers.

+

Own id: OTP-7837

+ + +
+
+ +
+ cosEventDomain 1.1.4 + +
+ Improvements and New Features + + +

Documentation source included in open source releases.

+

Own id: OTP-7595

+ + +
+
+ +
+ cosEventDomain 1.1.3 + +
+ Improvements and New Features + + +

Updated file headers.

+

Own id: OTP-7011

+ + +
+
+ +
+ cosEventDomain 1.1.2 + +
+ Improvements and New Features + + +

The documentation source has been converted from SGML to XML.

+

Own id: OTP-6754

+ + +
+
+ +
+ cosEventDomain 1.1.1 + +
+ Improvements and New Features + + +

Minor Makefile changes.

+

Own id: OTP-6701

+ + +
+
+ +
+ cosEventDomain 1.1 + +
+ Improvements and New Features + + +

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.

+

Own id: OTP-4576

+ + +
+
+ +
+ cosEventDomain 1.0 + +
+ Improvements and New Features + + +

First release of the cosEventDomain application.

+ + +
+
+ + diff --git a/lib/cosEventDomain/doc/src/part.xml b/lib/cosEventDomain/doc/src/part.xml new file mode 100644 index 0000000000..720a4d3feb --- /dev/null +++ b/lib/cosEventDomain/doc/src/part.xml @@ -0,0 +1,39 @@ + + + + +
+ + 20012009 + Ericsson AB. All Rights Reserved. + + + The contents of this file are subject to the Erlang Public License, + Version 1.1, (the "License"); you may not use this file except in + compliance with the License. You should have received a copy of the + Erlang Public License along with this software. If not, it can be + retrieved online at http://www.erlang.org/. + + Software distributed under the License is distributed on an "AS IS" + basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See + the License for the specific language governing rights and limitations + under the License. + + + + cosEventDomain User's Guide + Niclas Eklund + + 2001-08-20 + 1.0 +
+ +

The cosEventDomain application is an Erlang implementation of a + CORBA Service CosEventDomainAdmin.

+ + + + + + + diff --git a/lib/cosEventDomain/doc/src/part_notes.xml b/lib/cosEventDomain/doc/src/part_notes.xml new file mode 100644 index 0000000000..0979d6e491 --- /dev/null +++ b/lib/cosEventDomain/doc/src/part_notes.xml @@ -0,0 +1,36 @@ + + + + +
+ + 20012009 + Ericsson AB. All Rights Reserved. + + + The contents of this file are subject to the Erlang Public License, + Version 1.1, (the "License"); you may not use this file except in + compliance with the License. You should have received a copy of the + Erlang Public License along with this software. If not, it can be + retrieved online at http://www.erlang.org/. + + Software distributed under the License is distributed on an "AS IS" + basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See + the License for the specific language governing rights and limitations + under the License. + + + + cosEventDomain Release Notes + Niclas Eklund + + 2001-08-20 + 1.0 +
+ +

The cosEventDomain Application is an Erlang implementation of a CORBA Service + CosEventDomainAdmin.

+ + + + diff --git a/lib/cosEventDomain/doc/src/ref_man.gif b/lib/cosEventDomain/doc/src/ref_man.gif new file mode 100644 index 0000000000..b13c4efd53 Binary files /dev/null and b/lib/cosEventDomain/doc/src/ref_man.gif differ diff --git a/lib/cosEventDomain/doc/src/ref_man.xml b/lib/cosEventDomain/doc/src/ref_man.xml new file mode 100644 index 0000000000..ddb836e1d6 --- /dev/null +++ b/lib/cosEventDomain/doc/src/ref_man.xml @@ -0,0 +1,39 @@ + + + + +
+ + 20012009 + Ericsson AB. All Rights Reserved. + + + The contents of this file are subject to the Erlang Public License, + Version 1.1, (the "License"); you may not use this file except in + compliance with the License. You should have received a copy of the + Erlang Public License along with this software. If not, it can be + retrieved online at http://www.erlang.org/. + + Software distributed under the License is distributed on an "AS IS" + basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See + the License for the specific language governing rights and limitations + under the License. + + + + cosEventDomain Reference Manual + Niclas Eklund + + 2001-08-20 + 1.0 +
+ +

The cosEventDomain application is an Erlang implementation of + a CORBA Service CosEventDomainAdmin.

+ + + + + + + diff --git a/lib/cosEventDomain/doc/src/summary.html.src b/lib/cosEventDomain/doc/src/summary.html.src new file mode 100644 index 0000000000..922c956633 --- /dev/null +++ b/lib/cosEventDomain/doc/src/summary.html.src @@ -0,0 +1 @@ +Orber OMG Event Domain Service \ No newline at end of file diff --git a/lib/cosEventDomain/doc/src/user_guide.gif b/lib/cosEventDomain/doc/src/user_guide.gif new file mode 100644 index 0000000000..e6275a803d Binary files /dev/null and b/lib/cosEventDomain/doc/src/user_guide.gif differ -- cgit v1.2.3