1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148
|
.TH cosEventDomainApp 3 "cosEventDomain 1.1.3" "Ericsson AB" "ERLANG MODULE DEFINITION"
.SH MODULE
cosEventDomainApp \- The main module of the cosEventDomain application\&.
.SH DESCRIPTION
.LP
To get access to the record definitions for the structures use:
.br
\fI-include_lib("cosEventDomain/include/*\&.hrl")\&.\fR
.LP
This module contains the functions for starting and stopping the application\&.
.SH EXPORTS
.LP
.B
install() -> Return
.br
.RS
.TP
Types
Return = ok | {\&'EXCEPTION\&', E} | {\&'EXIT\&', R}
.br
.RE
.RS
.LP
This operation installs the cosEventDomain application\&.
.RE
.LP
.B
uninstall() -> Return
.br
.RS
.TP
Types
Return = ok | {\&'EXCEPTION\&', E} | {\&'EXIT\&', R}
.br
.RE
.RS
.LP
This operation uninstalls the cosEventDomain application\&.
.RE
.LP
.B
start() -> Return
.br
.RS
.TP
Types
Return = ok | {error, Reason}
.br
.RE
.RS
.LP
This operation starts the cosEventDomain application\&.
.RE
.LP
.B
stop() -> Return
.br
.RS
.TP
Types
Return = ok | {error, Reason}
.br
.RE
.RS
.LP
This operation stops the cosEventDomain application\&.
.RE
.LP
.B
start_factory() -> Factory
.br
.RS
.TP
Types
Factory = #objref
.br
.RE
.RS
.LP
This operation creates a new instance of a Event Domain Factory using the default settings\&.
.RE
.LP
.B
start_factory(Options) -> Factory
.br
.RS
.TP
Types
Options = [Option]
.br
Option = currently no options defined\&.
.br
Factory = #objref
.br
.RE
.RS
.LP
This operation creates a new instance of a Event Domain Factory
.RE
.LP
.B
start_factory_link() -> Factory
.br
.RS
.TP
Types
Factory = #objref
.br
.RE
.RS
.LP
This operation creates a new instance of a Event Domain Factory, which is linked to the invoking process, using the default settings\&.
.RE
.LP
.B
start_factory_link(Options) -> Factory
.br
.RS
.TP
Types
Options = [Option]
.br
Option = currently no options defined\&.
.br
Factory = #objref
.br
.RE
.RS
.LP
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 \fIcosEventDomainApp:start_factory/1\fR\&.
.RE
.LP
.B
stop_factory(Factory) -> Reply
.br
.RS
.TP
Types
Factory = #objref
.br
Reply = ok | {\&'EXCEPTION\&', E}
.br
.RE
.RS
.LP
This operation stop the target factory\&.
.RE
|