2001 2013 Ericsson AB, 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. 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.