linux man page for coseventapp

cosEventApp(3erl)					     Erlang Module Definition						 cosEventApp(3erl)

NAME
       cosEventApp - The main module of the cosEvent application.

DESCRIPTION
       To get access to the record definitions for the structures use:
       -include_lib("cosEvent/include/*.hrl").

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

EXPORTS
       install() -> Return

	      Types  Return = ok | {'EXCEPTION', E} | {'EXIT', R}

	      This operation installs the cosEvent application.

       uninstall() -> Return

	      Types  Return = ok | {'EXCEPTION', E} | {'EXIT', R}

	      This operation uninstalls the cosEvent application.

       start() -> Return

	      Types  Return = ok | {error, Reason}

	      This operation starts the cosEvent application.

       stop() -> Return

	      Types  Return = ok | {error, Reason}

	      This operation stops the cosEvent application.

       start_channel() -> Channel

	      Types  Channel = #objref

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

       start_channel(Options) -> Channel

	      Types  Options = [Option]
		     Option = {pull_interval, Seconds} | {typecheck, Boolean} | {maxEvents, Integer} | {blocking, Boolean}
		     Channel = #objref

	      This operation creates a new instance of a Event Channel

		* {pull_interval,  Seconds}  - determine how often Proxy Pull Consumers will check for new events with the client application. The
		  default value is 20 seconds.

		* {typecheck, Boolean} - 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.

		* {maxEvents,  Integer} - this option determine how many events the ProxyPullSuppliers will store before discarding events. If the
		  limit is reached events will be discarded in any order. The default value is 300.

		* {blocking, Boolean} - this option determine the behavior of the channel when handling events internally. If set to true the risk
		  of a single event supplier floods the system is reduced, but the performance may also be reduced. The default value is true .

       start_channel_link() -> Channel

	      Types  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

	      Types  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 cosEventApp:start_channel/1 .

       stop_channel(Channel) -> Reply

	      Types  Channel = #objref
		     Reply = ok | {'EXCEPTION', E}

	      This operation stop the target event channel.

Ericsson AB							  cosEvent 2.1.10						 cosEventApp(3erl)