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/cosEvent/doc/src/cosEventApp.xml | 168 +++++++++++++++++++++++++++++++++++ 1 file changed, 168 insertions(+) create mode 100644 lib/cosEvent/doc/src/cosEventApp.xml (limited to 'lib/cosEvent/doc/src/cosEventApp.xml') diff --git a/lib/cosEvent/doc/src/cosEventApp.xml b/lib/cosEvent/doc/src/cosEventApp.xml new file mode 100644 index 0000000000..d83f44acb1 --- /dev/null +++ b/lib/cosEvent/doc/src/cosEventApp.xml @@ -0,0 +1,168 @@ + + + + +
+ + 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. + + + cosEventApp + Niclas Eklund + Niclas Eklund + + Niclas Eklund + + 2000-01-31 + PA1 + cosEventApp.xml +
+ cosEventApp + The main module of the cosEvent 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 cosEvent application + + Return = ok | {'EXCEPTION', E} | {'EXIT', R} + + +

This operation installs the cosEvent application.

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

This operation uninstalls the cosEvent application.

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

This operation starts the cosEvent application.

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

This operation stops the cosEvent application.

+ + + + start_channel() -> Channel + Start a channel with default settings + + Channel = #objref + + +

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

+ + + + start_channel(Options) -> Channel + Start a channel with settings defined by the given options + + Options = [Option] + Option = {pull_interval, Seconds} | {typecheck, Boolean} | {maxEvents, Integer} | {blocking, Boolean} + Channel = #objref + + +

This operation creates a new instance of a + Event Channel

+

+ + - determine how often Proxy Pull + Consumers will check for new events with the client application. The + default value is 20 seconds. + - if this option is set to true the + proxies will check if the supplied client object is of correct type. + The default value is false. + - this option determine how many events + the will store before discarding events. + If the limit is reached events will be discarded in any order. + The default value is 300. + - this option determine the behavior of + the channel when handling events internally. If set to the + risk of a single event supplier floods the system is reduced, but + the performance may also be reduced. + The default value is . + + + + + start_channel_link() -> Channel + Start a channel, which is linked to the invoking process, with default settings + + Channel = #objref + + +

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

+ + + + start_channel_link(Options) -> Channel + Start a channel, which is linked to the invoking process, with settings defined by the given options + + Options = [Option] + Option = {pull_interval, Seconds} | {typecheck, Boolean} | {maxEvents, Integer} | {blocking, Boolean} + Channel = #objref + + +

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

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

This operation stop the target event channel.

+ + + + + + -- cgit v1.2.3