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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
|
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>omniEvents-win32</title>
<link rel="stylesheet" href="omnievents.docbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.65.1">
<link rel="home" href="index.html" title="omniEvents">
<link rel="up" href="ar01s07.html" title="7.Reference">
<link rel="previous" href="re01.html" title="omniEvents">
<link rel="next" href="re03.html" title="eventc">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<div class="navheader">
<table width="100%" summary="Navigation header">
<tr><th colspan="3" align="center">omniEvents-win32</th></tr>
<tr>
<td width="20%" align="left">
<a accesskey="p" href="re01.html">Prev</a></td>
<th width="60%" align="center">7.Reference</th>
<td width="20%" align="right"><a accesskey="n" href="re03.html">Next</a>
</td>
</tr>
</table>
<hr>
</div>
<div class="refentry" lang="en">
<a name="reference_service"></a><div class="titlepage">
<div></div>
<div></div>
</div>
<div class="refnamediv">
<h2>Name</h2>
<p>omniEvents-win32 — CORBA Event Service for Windows</p>
</div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<p>Command:</p>
<div class="cmdsynopsis"><p><tt class="command">omniEvents</tt> [-p <i class="replaceable"><tt>port</tt></i>] [-a <i class="replaceable"><tt>endpoint</tt></i>] [-l <i class="replaceable"><tt>directory</tt></i>] [-N <i class="replaceable"><tt>factory-name</tt></i>] [-t <i class="replaceable"><tt>file</tt></i>] [-vVh]<br> [-ORB<i class="replaceable"><tt>parameter</tt></i>
<i class="replaceable"><tt>value</tt></i>]</p></div>
<p>Windows service control:</p>
<div class="cmdsynopsis"><p><tt class="command">omniEvents</tt> [ install [<i class="replaceable"><tt>OPTIONS</tt></i>] | uninstall | setoptions [<i class="replaceable"><tt>OPTIONS</tt></i>] | getoptions ]</p></div>
</div>
<div class="refsect1" lang="en">
<a name="id2459725"></a><h2>Description</h2>
<p><span><b class="command">omniEvents</b></span> is a CORBA Event Service server
program. It is designed to be run as a Windows service.</p>
<p>The server continuously saves its state to a file. Event channels
are re-created from this file each time the server restarts. The
options <tt class="option">-p</tt> and <tt class="option">-a</tt> affect the identity
of the server's event channels, so these options can only be set the
first time the server is run.</p>
<p>Servers may be configured to operate in pairs - if one fails then
clients automatically switch over to the alternate.</p>
</div>
<div class="refsect1" lang="en">
<a name="id2459762"></a><h2>Service Control</h2>
<p><span><b class="command">omniEvents</b></span> itself has four service set-up
commands. The command name must immediately follow the
<span><b class="command">omniEvents</b></span>. Any normal command-line options which
follow the command are stored in the Windows registry. They will be
used when the service starts up.</p>
<div class="variablelist"><dl>
<dt><span class="term"><span><b class="command">omniEvents install OPTIONS</b></span></span></dt>
<dd>
<p>Install the service with the specified options. The only
option that will usually be useful is <tt class="option">-t</tt>, which
instructs omniEvents to send trace logs to a file.</p>
<p>Example: <span><b class="command">omniEvents install
-t "C:\omniEvents\trace.out"</b></span></p>
</dd>
<dt><span class="term"><span><b class="command">omniEvents uninstall</b></span></span></dt>
<dd><p>Uninstalls the service.</p></dd>
<dt><span class="term"><span><b class="command">omniEvents setoptions OPTIONS</b></span></span></dt>
<dd><p>Changes the service's stored options.</p></dd>
<dt><span class="term"><span><b class="command">omniEvents getoptions</b></span></span></dt>
<dd><p>Outputs the service's stored option to standard
output.</p></dd>
</dl></div>
<p>Once the <span><b class="command">omniEvents</b></span> is installed, you can
control it from the command line, or from scripts with the
<span><b class="command">Sc.exe</b></span> command. <span><b class="command">Sc.exe</b></span> is
distributed with the “<span class="quote">Microsoft SDK</span>”.</p>
<div class="variablelist"><dl>
<dt><span class="term"><span><b class="command">sc start omniEvents</b></span></span></dt>
<dd><p>Starts the server.</p></dd>
<dt><span class="term"><span><b class="command">sc stop omniEvents</b></span></span></dt>
<dd><p>Shuts down the server.</p></dd>
<dt><span class="term"><span><b class="command">sc control omniEvents 128</b></span></span></dt>
<dd><p>You can change the traceLevel while the application is
running. Send control signal <tt class="literal">128</tt> to the
server to bump its traceLevel up by 5. The traceLevel is wrapped
at 45, so you can always get it back to where it started by
repeatedly sending signal <tt class="literal">128</tt>.</p></dd>
</dl></div>
</div>
<div class="refsect1" lang="en">
<a name="id2459972"></a><h2>Options</h2>
<div class="variablelist"><dl>
<dt><span class="term"><tt class="option">-p port</tt></span></dt>
<dd>
<p>Sets the TCP port on which a new server will listen. The
default is <tt class="literal">11169</tt></p>
<p>This value is stored in the new server's persistent state.
There is no need to supply this option when a server is
restarted, since the value is read from the file. If the option
is supplied then it is simply compared with the stored value - if
the two do not match then the program exits with an error.</p>
</dd>
<dt><span class="term"><tt class="option">-a endpoint</tt></span></dt>
<dd>
<p>Sets an alternate endPoint for a new server. All CORBA
object references generated by the server include the alternate
address. When clients cannot contact the server, they
automatically fall back to trying the alternate address.</p>
<p>This option is exactly equivalent to the ORB parameter
<tt class="option">endPointNoListen</tt>, except that the value is saved
in the server's persistency file, so that it is remembered
whenever omniEvents is restarted.</p>
<p>The format for a TCP endpoint is
<tt class="literal">giop:tcp:HOST:PORT</tt>, for example:
<tt class="literal">-a giop:tcp:secondary.host:11169</tt></p>
<p>This value is stored in the server's persistent state.
There is no need to supply this option when a server is
restarted, since the value is read from the file. If the option
is supplied then it is simply compared with the stored value - if
the two do not match then the program exits with an error.</p>
</dd>
<dt><span class="term"><tt class="option">-l directory</tt></span></dt>
<dd><p>Full path to data directory, where omniEvents stores its
persistent state. The default is
<tt class="filename">C:\omniEvents</tt></p></dd>
<dt><span class="term"><tt class="option">-N factory-name</tt></span></dt>
<dd>
<p>Sets the CORBA Name Service name for the EventChannelFactory
CORBA object. Each time the server starts, it registers its
channel factory object with <tt class="literal">factory-name</tt>
in the Name Service.</p>
<p>Format for name:
<tt class="literal">[CONTEXT-ID[.CONTEXT-KIND]/]*OBJECT-ID[.OBJECT-KIND]</tt>
</p>
<p>Examples: <tt class="literal">foo</tt>,
<tt class="literal">foo.bar</tt>, <tt class="literal">foo.bar/baz/qux</tt>,
<tt class="literal">foo/bar/baz.qux</tt>.</p>
<p>The default is <tt class="literal">EventChannelFactory</tt></p>
</dd>
<dt><span class="term"><tt class="option">-t file</tt></span></dt>
<dd><p>Send trace messages to <tt class="literal">file</tt>.</p></dd>
<dt><span class="term"><tt class="option">-v</tt></span></dt>
<dd><p>Output the CORBA IOR of the EventChannelFactory CORBA
object when the server starts.</p></dd>
<dt><span class="term"><tt class="option">-V</tt></span></dt>
<dd><p>Display version.</p></dd>
<dt><span class="term"><tt class="option">-h</tt></span></dt>
<dd><p>Display a short summary of command-line options.</p></dd>
<dt><span class="term"><tt class="option">-ORBparameter value</tt></span></dt>
<dd>
<p>Standard omniORB options. see omniORB documentation for
details. Do NOT use this option to set the
<tt class="literal">endPoint</tt> or
<tt class="literal">alternateEndPoint</tt>. This option is commonly
used to set the omniORB <tt class="literal">traceLevel</tt>, in order
to get more detailed output.</p>
<p>Example: <span><b class="command">-ORBtraceLevel 5</b></span></p>
</dd>
</dl></div>
</div>
<div class="refsect1" lang="en">
<a name="id2460267"></a><h2>Event Channel Parameters</h2>
<p>The omniEvents::EventChannelFactory object implements the
standard CosLifeCycle::GenericFactory interface. An EventChannel object
is created by a call to the
<tt class="literal">create_object(key,the_criteria)</tt> operation.</p>
<p>The “<span class="quote">key</span>” parameter must be set to
<tt class="literal">“<span class="quote">EventChannel</span>”.“<span class="quote">object
interface</span>”</tt>. The “<span class="quote">the_criteria</span>” parameter
is a sequence of various service parameters. Supported parameters are
listed below.</p>
<div class="variablelist"><dl>
<dt><span class="term">CyclePeriod_ns (<tt class="literal">long</tt>)</span></dt>
<dd><p>Sets the cycle period of the channel (nanoseconds). This is
the time that the channel waits before transferring messages from
the incoming queue to the outgoing queue. While messages are
being transferred, incoming calls are queued. The default is 0.1
seconds.</p></dd>
<dt><span class="term">FilterId (<tt class="literal">string</tt>)</span></dt>
<dd><p>Only types whose <tt class="literal">RepositoryId</tt> matches
the parameter are permitted to pass through the channel. Other
events are silently ignored.</p></dd>
<dt><span class="term">InsName (<tt class="literal">string</tt>)</span></dt>
<dd><p>Sets the name by which the EventChannel is known in
omniEvents' INSPOA. You can refer to the channel with a corbaloc
string like this:
<tt class="literal">corbaloc::HOST:11169/NAME</tt></p></dd>
<dt><span class="term">MaxNumProxies (<tt class="literal">long</tt>)</span></dt>
<dd><p>The maximum number of <tt class="literal">ProxyPullSuppliers</tt>
per channel.</p></dd>
<dt><span class="term">MaxQueueLength (<tt class="literal">long</tt>)</span></dt>
<dd><p>How many events are buffered by the
<tt class="literal">ConsumerAdmin</tt> object. The discard policy is
FIFO, meaning that the oldest events are discarded first in case
of overflow.</p></dd>
<dt><span class="term">PullRetryPeriod_ms (<tt class="literal">long</tt>)</span></dt>
<dd><p>Period (milliseconds) between polls when in Pull Supplier -
Push Consumer mode.</p></dd>
</dl></div>
</div>
<div class="refsect1" lang="en">
<a name="id2460467"></a><h2>Environment Variables</h2>
<div class="variablelist"><dl>
<dt><span class="term">OMNIEVENTS_LOGDIR</span></dt>
<dd><p>Sets the directory where data files are kept by default.
An alternative to the <tt class="option">-l</tt> option.</p></dd>
<dt><span class="term">OMNIORB_CONFIG</span></dt>
<dd><p>The location of the omniORB configuration file.</p></dd>
</dl></div>
</div>
<div class="refsect1" lang="en">
<a name="id2460510"></a><h2>Copyright</h2>
<p>Copyright 2003-2005 Alex Tingle, 1999 Paul Nader.</p>
<p>This is free software; see the source for copying conditions.
There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE.</p>
</div>
</div>
<div class="navfooter">
<hr>
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left">
<a accesskey="p" href="re01.html">Prev</a></td>
<td width="20%" align="center"><a accesskey="u" href="ar01s07.html">Up</a></td>
<td width="40%" align="right"><a accesskey="n" href="re03.html">Next</a>
</td>
</tr>
<tr>
<td width="40%" align="left" valign="top">omniEvents</td>
<td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td>
<td width="40%" align="right" valign="top">eventc</td>
</tr>
</table>
</div>
</body>
</html>
|
