1cosEventApp(3)             Erlang Module Definition             cosEventApp(3)
2
3
4

NAME

6       cosEventApp - The main module of the cosEvent application.
7

DESCRIPTION

9       To get access to the record definitions for the structures use:
10       -include_lib("cosEvent/include/*.hrl").
11
12       This module contains the functions for starting and stopping the appli‐
13       cation.
14

EXPORTS

16       install() -> Return
17
18              Types:
19
20                 Return = ok | {'EXCEPTION', E} | {'EXIT', R}
21
22              This operation installs the cosEvent application.
23
24       uninstall() -> Return
25
26              Types:
27
28                 Return = ok | {'EXCEPTION', E} | {'EXIT', R}
29
30              This operation uninstalls the cosEvent application.
31
32       start() -> Return
33
34              Types:
35
36                 Return = ok | {error, Reason}
37
38              This operation starts the cosEvent application.
39
40       stop() -> Return
41
42              Types:
43
44                 Return = ok | {error, Reason}
45
46              This operation stops the cosEvent application.
47
48       start_channel() -> Channel
49
50              Types:
51
52                 Channel = #objref
53
54              This operation creates a new instance of a Event  Channel  using
55              the default settings.
56
57       start_channel(Options) -> Channel
58
59              Types:
60
61                 Options = [Option]
62                 Option  =  {pull_interval,  Seconds} | {typecheck, Boolean} |
63                 {maxEvents, Integer} | {blocking, Boolean}
64                 Channel = #objref
65
66              This operation creates a new instance of a Event Channel
67
68                * {pull_interval, Seconds} - determine how  often  Proxy  Pull
69                  Consumers will check for new events with the client applica‐
70                  tion. The default value is 20 seconds.
71
72                * {typecheck, Boolean} - if this option is  set  to  true  the
73                  proxies  will check if the supplied client object is of cor‐
74                  rect type. The default value is false.
75
76                * {maxEvents, Integer} - this option determine how many events
77                  the  ProxyPullSuppliers will store before discarding events.
78                  If the limit is reached events will be discarded in any  or‐
79                  der. The default value is 300.
80
81                * {blocking,  Boolean} - this option determine the behavior of
82                  the channel when handling events internally. If set to  true
83                  the risk of a single event supplier floods the system is re‐
84                  duced, but the performance may also be reduced. The  default
85                  value is true.
86
87       start_channel_link() -> Channel
88
89              Types:
90
91                 Channel = #objref
92
93              This  operation creates a new instance of a Event Channel, which
94              is linked to the invoking process, using the default settings.
95
96       start_channel_link(Options) -> Channel
97
98              Types:
99
100                 Options = [Option]
101                 Option = {pull_interval, Seconds} |  {typecheck,  Boolean}  |
102                 {maxEvents, Integer} | {blocking, Boolean}
103                 Channel = #objref
104
105              This  operation creates a new instance of a Event Channel, which
106              is linked to the invoking process, with settings defined by  the
107              given  options.  Allowed  options  are  the same as for cosEven‐
108              tApp:start_channel/1.
109
110       stop_channel(Channel) -> Reply
111
112              Types:
113
114                 Channel = #objref
115                 Reply = ok | {'EXCEPTION', E}
116
117              This operation stop the target event channel.
118
119
120
121Ericsson AB                     cosEvent 5.0.2                  cosEventApp(3)