copland 0.8.0
Sign up to get free protection for your applications and to get access to all the features.
- data/doc/README +88 -0
- data/doc/manual-html/chapter-1.html +454 -0
- data/doc/manual-html/chapter-10.html +399 -0
- data/doc/manual-html/chapter-11.html +600 -0
- data/doc/manual-html/chapter-12.html +406 -0
- data/doc/manual-html/chapter-2.html +382 -0
- data/doc/manual-html/chapter-3.html +424 -0
- data/doc/manual-html/chapter-4.html +432 -0
- data/doc/manual-html/chapter-5.html +381 -0
- data/doc/manual-html/chapter-6.html +364 -0
- data/doc/manual-html/chapter-7.html +434 -0
- data/doc/manual-html/chapter-8.html +373 -0
- data/doc/manual-html/chapter-9.html +324 -0
- data/doc/manual-html/copland.png +0 -0
- data/doc/manual-html/index.html +331 -0
- data/doc/manual-html/manual.css +179 -0
- data/doc/manual-html/tutorial-1.html +407 -0
- data/doc/manual-html/tutorial-2.html +451 -0
- data/doc/manual-html/tutorial-3.html +484 -0
- data/doc/manual-html/tutorial-4.html +446 -0
- data/doc/manual-html/tutorial-5.html +520 -0
- data/doc/manual/chapter.erb +18 -0
- data/doc/manual/example.erb +18 -0
- data/doc/manual/img/copland.png +0 -0
- data/doc/manual/index.erb +30 -0
- data/doc/manual/manual.css +179 -0
- data/doc/manual/manual.rb +239 -0
- data/doc/manual/manual.yml +2643 -0
- data/doc/manual/page.erb +102 -0
- data/doc/manual/tutorial.erb +30 -0
- data/doc/packages/copland.html +764 -0
- data/doc/packages/copland.lib.html +439 -0
- data/doc/packages/copland.remote.html +2096 -0
- data/doc/packages/copland.webrick.html +925 -0
- data/doc/packages/index.html +49 -0
- data/doc/packages/packrat.css +125 -0
- data/examples/calc/calc.rb +47 -0
- data/examples/calc/package.yml +35 -0
- data/examples/calc/services.rb +74 -0
- data/examples/solitaire-cipher/README +11 -0
- data/examples/solitaire-cipher/Rakefile +57 -0
- data/examples/solitaire-cipher/bin/main.rb +14 -0
- data/examples/solitaire-cipher/lib/cipher.rb +230 -0
- data/examples/solitaire-cipher/lib/cli.rb +24 -0
- data/examples/solitaire-cipher/lib/package.yml +106 -0
- data/examples/solitaire-cipher/test/tc_deck.rb +30 -0
- data/examples/solitaire-cipher/test/tc_key-stream.rb +19 -0
- data/examples/solitaire-cipher/test/tc_keying-algorithms.rb +31 -0
- data/examples/solitaire-cipher/test/tc_solitaire-cipher.rb +66 -0
- data/examples/solitaire-cipher/test/tc_unkeyed-algorithm.rb +17 -0
- data/examples/solitaire-cipher/test/tests.rb +2 -0
- data/lib/copland.rb +56 -0
- data/lib/copland/class-factory.rb +95 -0
- data/lib/copland/configuration-point.rb +38 -0
- data/lib/copland/configuration-point/common.rb +203 -0
- data/lib/copland/configuration-point/errors.rb +44 -0
- data/lib/copland/configuration-point/list.rb +59 -0
- data/lib/copland/configuration-point/map.rb +59 -0
- data/lib/copland/configuration/errors.rb +43 -0
- data/lib/copland/configuration/loader.rb +113 -0
- data/lib/copland/configuration/yaml/configuration-point.rb +87 -0
- data/lib/copland/configuration/yaml/implementor.rb +134 -0
- data/lib/copland/configuration/yaml/interceptor.rb +63 -0
- data/lib/copland/configuration/yaml/listener.rb +56 -0
- data/lib/copland/configuration/yaml/loader.rb +122 -0
- data/lib/copland/configuration/yaml/package.rb +125 -0
- data/lib/copland/configuration/yaml/parser.rb +71 -0
- data/lib/copland/configuration/yaml/schema.rb +165 -0
- data/lib/copland/configuration/yaml/service-point.rb +116 -0
- data/lib/copland/configuration/yaml/utils.rb +82 -0
- data/lib/copland/default-schema-processor.rb +144 -0
- data/lib/copland/errors.rb +82 -0
- data/lib/copland/event-producer.rb +95 -0
- data/lib/copland/impl/builder-factory.rb +112 -0
- data/lib/copland/impl/copland-config.yml +1 -0
- data/lib/copland/impl/include-exclude.rb +140 -0
- data/lib/copland/impl/logging-interceptor.rb +106 -0
- data/lib/copland/impl/package.yml +217 -0
- data/lib/copland/impl/startup.rb +116 -0
- data/lib/copland/impl/symbol-source-manager.rb +131 -0
- data/lib/copland/impl/symbol-source.rb +63 -0
- data/lib/copland/instantiator.rb +38 -0
- data/lib/copland/instantiator/abstract.rb +91 -0
- data/lib/copland/instantiator/complex.rb +96 -0
- data/lib/copland/instantiator/identity.rb +58 -0
- data/lib/copland/instantiator/simple.rb +68 -0
- data/lib/copland/interceptor-chain.rb +166 -0
- data/lib/copland/interceptor.rb +139 -0
- data/lib/copland/log-factory.rb +206 -0
- data/lib/copland/models.rb +39 -0
- data/lib/copland/models/abstract.rb +78 -0
- data/lib/copland/models/prototype-deferred.rb +58 -0
- data/lib/copland/models/prototype.rb +58 -0
- data/lib/copland/models/proxy.rb +100 -0
- data/lib/copland/models/singleton-deferred.rb +59 -0
- data/lib/copland/models/singleton.rb +77 -0
- data/lib/copland/models/threaded.rb +65 -0
- data/lib/copland/ordering.rb +123 -0
- data/lib/copland/package.rb +246 -0
- data/lib/copland/registry.rb +368 -0
- data/lib/copland/schema.rb +206 -0
- data/lib/copland/service-point.rb +282 -0
- data/lib/copland/utils.rb +221 -0
- data/lib/copland/version.rb +47 -0
- data/test/conf-test/list-bad-key.yml +30 -0
- data/test/conf-test/list-bad-missing.yml +28 -0
- data/test/conf-test/list-bad-type.yml +28 -0
- data/test/conf-test/list-good.yml +29 -0
- data/test/conf-test/map-bad-key.yml +25 -0
- data/test/conf-test/map-bad-missing.yml +24 -0
- data/test/conf-test/map-bad-type.yml +23 -0
- data/test/conf-test/map-good.yml +25 -0
- data/test/configuration-point/package.yml +52 -0
- data/test/configuration/yaml/config/copland-config.yml +2 -0
- data/test/configuration/yaml/config/module.yml +2 -0
- data/test/configuration/yaml/config/subdir/copland-config.yml +2 -0
- data/test/configuration/yaml/config/subdir/package.yml +4 -0
- data/test/configuration/yaml/defaults/package.yml +5 -0
- data/test/configuration/yaml/defaults/subdir/package.yml +4 -0
- data/test/configuration/yaml/tc_config-loader.rb +86 -0
- data/test/configuration/yaml/tc_configuration-point-processor.rb +134 -0
- data/test/configuration/yaml/tc_implementor-processor.rb +104 -0
- data/test/configuration/yaml/tc_interceptor-processor.rb +85 -0
- data/test/configuration/yaml/tc_listener-processor.rb +69 -0
- data/test/configuration/yaml/tc_loader.rb +74 -0
- data/test/configuration/yaml/tc_package-processor.rb +120 -0
- data/test/configuration/yaml/tc_parser.rb +94 -0
- data/test/configuration/yaml/tc_schema-parser.rb +160 -0
- data/test/configuration/yaml/tc_service-point-processor.rb +104 -0
- data/test/configuration/yaml/tc_type-validator.rb +90 -0
- data/test/custom-logger.yml +3 -0
- data/test/impl/logging/package.yml +44 -0
- data/test/impl/logging/services.rb +84 -0
- data/test/impl/startup/package.yml +46 -0
- data/test/impl/startup/services.rb +47 -0
- data/test/impl/symbols/package.yml +24 -0
- data/test/impl/symbols/services.rb +38 -0
- data/test/impl/tc_builder-factory.rb +173 -0
- data/test/impl/tc_logging-interceptor.rb +148 -0
- data/test/impl/tc_startup.rb +59 -0
- data/test/impl/tc_symbol-sources.rb +61 -0
- data/test/logger.yml +6 -0
- data/test/mock.rb +201 -0
- data/test/schema/bad-package.yml +65 -0
- data/test/schema/package.yml +102 -0
- data/test/schema/services.rb +5 -0
- data/test/services/package.yml +79 -0
- data/test/services/simple.rb +87 -0
- data/test/tc_class-factory.rb +93 -0
- data/test/tc_complex-instantiator.rb +107 -0
- data/test/tc_configuration-point-contrib.rb +74 -0
- data/test/tc_configuration-point-schema.rb +122 -0
- data/test/tc_configuration-point.rb +91 -0
- data/test/tc_default-schema-processor.rb +297 -0
- data/test/tc_identity-instantiator.rb +61 -0
- data/test/tc_interceptors.rb +84 -0
- data/test/tc_logger.rb +131 -0
- data/test/tc_models.rb +176 -0
- data/test/tc_package.rb +165 -0
- data/test/tc_proxy.rb +65 -0
- data/test/tc_registry.rb +141 -0
- data/test/tc_schema.rb +78 -0
- data/test/tc_service-point.rb +178 -0
- data/test/tc_service.rb +70 -0
- data/test/tc_simple-instantiator.rb +61 -0
- data/test/tests.rb +93 -0
- data/tutorial/01/main.rb +7 -0
- data/tutorial/01/package.yml +8 -0
- data/tutorial/01/tutorial.rb +7 -0
- data/tutorial/02/main.rb +10 -0
- data/tutorial/02/package.yml +27 -0
- data/tutorial/02/tutorial.rb +46 -0
- data/tutorial/03/main.rb +24 -0
- data/tutorial/03/package.yml +29 -0
- data/tutorial/03/tutorial.rb +48 -0
- data/tutorial/04/main.rb +24 -0
- data/tutorial/04/package.yml +35 -0
- data/tutorial/04/tutorial.rb +48 -0
- data/tutorial/05/functions/package.yml +16 -0
- data/tutorial/05/functions/services.rb +15 -0
- data/tutorial/05/main.rb +10 -0
- data/tutorial/05/package.yml +35 -0
- data/tutorial/05/tutorial.rb +53 -0
- metadata +260 -0
|
@@ -0,0 +1,439 @@
|
|
|
1
|
+
<html>
|
|
2
|
+
<head>
|
|
3
|
+
<title>copland.lib</title>
|
|
4
|
+
<link rel="stylesheet" type="text/css" href="packrat.css" />
|
|
5
|
+
</head>
|
|
6
|
+
<body>
|
|
7
|
+
<h1>copland.lib</h1>
|
|
8
|
+
|
|
9
|
+
<!-- INDEX OF PACKAGE CONTENTS -->
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
<div class="description">
|
|
13
|
+
This package contains additional services, providing functionality beyond that given by the core set of services in Copland itself. These additional services include a multicast service factory, a synchronizing interceptor, and more.
|
|
14
|
+
</div>
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
<div class="nav">
|
|
18
|
+
Return to
|
|
19
|
+
|
|
20
|
+
<a href="index.html">index</a>
|
|
21
|
+
|
|
22
|
+
</div>
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
<h3>Service Points</h3>
|
|
26
|
+
<ul>
|
|
27
|
+
|
|
28
|
+
<li><a href="copland.lib.html#BlockingInterceptor_sp">BlockingInterceptor</a></li>
|
|
29
|
+
|
|
30
|
+
<li><a href="copland.lib.html#ClassBuilderFactory_sp">ClassBuilderFactory</a></li>
|
|
31
|
+
|
|
32
|
+
<li><a href="copland.lib.html#ENVSymbolSource_sp">ENVSymbolSource</a></li>
|
|
33
|
+
|
|
34
|
+
<li><a href="copland.lib.html#MulticastFactory_sp">MulticastFactory</a></li>
|
|
35
|
+
|
|
36
|
+
<li><a href="copland.lib.html#RedirectingInterceptor_sp">RedirectingInterceptor</a></li>
|
|
37
|
+
|
|
38
|
+
<li><a href="copland.lib.html#RubySymbolSource_sp">RubySymbolSource</a></li>
|
|
39
|
+
|
|
40
|
+
<li><a href="copland.lib.html#SynchronizingInterceptor_sp">SynchronizingInterceptor</a></li>
|
|
41
|
+
|
|
42
|
+
</ul>
|
|
43
|
+
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
<!-- SERVICE POINTS -->
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
<h2>Service Points</h2>
|
|
53
|
+
|
|
54
|
+
|
|
55
|
+
<h3><a name="BlockingInterceptor_sp">BlockingInterceptor</a> <small><em>(singleton)</em></small></h3>
|
|
56
|
+
|
|
57
|
+
<div class="item-body">
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
<p class="description">
|
|
61
|
+
Blocks access to certain messages, effectively limiting the interface of the service it wraps. The definition of the interceptor can specify the behavior when a blocked message is intercepted, either failing silently, or raising an exception.
|
|
62
|
+
</p>
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
<h4>Implementor</h4>
|
|
66
|
+
<div class="definition-item">
|
|
67
|
+
|
|
68
|
+
copland/lib/blocking-interceptor/Copland::Library::BlockingInterceptorFactory
|
|
69
|
+
|
|
70
|
+
</div>
|
|
71
|
+
|
|
72
|
+
|
|
73
|
+
<h4>Schema</h4>
|
|
74
|
+
<div class="definition-item">
|
|
75
|
+
|
|
76
|
+
|
|
77
|
+
|
|
78
|
+
|
|
79
|
+
<div class="schema-item-title">Extends <a href="copland.html#IncludeExcludeSchema_scm">copland.IncludeExcludeSchema</a></div>
|
|
80
|
+
|
|
81
|
+
|
|
82
|
+
|
|
83
|
+
|
|
84
|
+
|
|
85
|
+
<div class="schema-item">
|
|
86
|
+
|
|
87
|
+
<div class="subschema-name">
|
|
88
|
+
behavior
|
|
89
|
+
[string]
|
|
90
|
+
|
|
91
|
+
</div>
|
|
92
|
+
<div class="subschema">
|
|
93
|
+
|
|
94
|
+
<div class="description">
|
|
95
|
+
This should be either "silent", or the name of an exception to raise. It describes the behavior to select when a message is blocked. It defaults to "NoMethodError".
|
|
96
|
+
</div>
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
|
|
100
|
+
|
|
101
|
+
|
|
102
|
+
|
|
103
|
+
|
|
104
|
+
|
|
105
|
+
</div>
|
|
106
|
+
</div>
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
</div>
|
|
110
|
+
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
|
|
114
|
+
|
|
115
|
+
|
|
116
|
+
</div>
|
|
117
|
+
|
|
118
|
+
|
|
119
|
+
<h3><a name="ClassBuilderFactory_sp">ClassBuilderFactory</a> <small><em>(singleton)</em></small></h3>
|
|
120
|
+
|
|
121
|
+
<div class="item-body">
|
|
122
|
+
|
|
123
|
+
|
|
124
|
+
<p class="description">
|
|
125
|
+
This is just like BuilderFactory, but it works on classes instead of objects. That is to say, instead of instantiating an object, it instead just returns a class reference. This is useful for backing a service with a class instead of an object.
|
|
126
|
+
</p>
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
<h4>Implementor</h4>
|
|
130
|
+
<div class="definition-item">
|
|
131
|
+
|
|
132
|
+
copland/lib/class-builder-factory/Copland::Library::ClassBuilderFactory
|
|
133
|
+
|
|
134
|
+
</div>
|
|
135
|
+
|
|
136
|
+
|
|
137
|
+
<h4>Schema</h4>
|
|
138
|
+
<div class="definition-item">
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
<div class="schema-item">
|
|
147
|
+
|
|
148
|
+
<div class="subschema-name">
|
|
149
|
+
class
|
|
150
|
+
[string]
|
|
151
|
+
<em>(required)</em>
|
|
152
|
+
</div>
|
|
153
|
+
<div class="subschema">
|
|
154
|
+
|
|
155
|
+
<div class="description">
|
|
156
|
+
That path to class to return. This has the same format as for BuilderFactory.
|
|
157
|
+
</div>
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
|
|
166
|
+
</div>
|
|
167
|
+
<div class="subschema-name">
|
|
168
|
+
initialize-method
|
|
169
|
+
[string]
|
|
170
|
+
|
|
171
|
+
</div>
|
|
172
|
+
<div class="subschema">
|
|
173
|
+
|
|
174
|
+
<div class="description">
|
|
175
|
+
This describes the name of the (class) method to invoke when the service has been completely initialized (and all properties wired into it). This defaults to "initialize_service". If the method does not exist, then nothing is invoked.
|
|
176
|
+
</div>
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
</div>
|
|
186
|
+
<div class="subschema-name">
|
|
187
|
+
properties
|
|
188
|
+
[hash]
|
|
189
|
+
|
|
190
|
+
</div>
|
|
191
|
+
<div class="subschema">
|
|
192
|
+
|
|
193
|
+
<div class="description">
|
|
194
|
+
A hash of properties to set on the class. First, setters are searched for, of the format "name=" or "set_name". If one is found, it will be invoked. Otherwise, the properties are set directly using "class_eval".
|
|
195
|
+
</div>
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
|
|
201
|
+
|
|
202
|
+
|
|
203
|
+
|
|
204
|
+
</div>
|
|
205
|
+
</div>
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
</div>
|
|
209
|
+
|
|
210
|
+
|
|
211
|
+
|
|
212
|
+
|
|
213
|
+
|
|
214
|
+
|
|
215
|
+
</div>
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
<h3><a name="ENVSymbolSource_sp">ENVSymbolSource</a> <small><em>(singleton)</em></small></h3>
|
|
219
|
+
|
|
220
|
+
<div class="item-body">
|
|
221
|
+
|
|
222
|
+
|
|
223
|
+
<p class="description">
|
|
224
|
+
A symbol source that draws its values from the ENV hash. This source is not made available by default--applications wishing to use it must manually add it to the copland.SymbolSources configuration point.
|
|
225
|
+
</p>
|
|
226
|
+
|
|
227
|
+
|
|
228
|
+
<h4>Implementor</h4>
|
|
229
|
+
<div class="definition-item">
|
|
230
|
+
|
|
231
|
+
copland/lib/env-symbol-source/Copland::Library::ENVSymbolSource
|
|
232
|
+
|
|
233
|
+
</div>
|
|
234
|
+
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
|
|
238
|
+
|
|
239
|
+
|
|
240
|
+
|
|
241
|
+
</div>
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
<h3><a name="MulticastFactory_sp">MulticastFactory</a> <small><em>(singleton)</em></small></h3>
|
|
245
|
+
|
|
246
|
+
<div class="item-body">
|
|
247
|
+
|
|
248
|
+
|
|
249
|
+
<p class="description">
|
|
250
|
+
A specialized builder factory for constructing a multicast service. A multicast service is one which will forward any messages it recieves to all registered targets.
|
|
251
|
+
</p>
|
|
252
|
+
|
|
253
|
+
|
|
254
|
+
<h4>Implementor</h4>
|
|
255
|
+
<div class="definition-item">
|
|
256
|
+
|
|
257
|
+
copland/lib/multicast-factory/Copland::Library::MulticastFactory
|
|
258
|
+
|
|
259
|
+
</div>
|
|
260
|
+
|
|
261
|
+
|
|
262
|
+
<h4>Schema</h4>
|
|
263
|
+
<div class="definition-item">
|
|
264
|
+
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
|
|
268
|
+
|
|
269
|
+
|
|
270
|
+
|
|
271
|
+
<div class="schema-item">
|
|
272
|
+
|
|
273
|
+
<div class="subschema-name">
|
|
274
|
+
targets
|
|
275
|
+
[configuration]
|
|
276
|
+
<em>(required)</em>
|
|
277
|
+
</div>
|
|
278
|
+
<div class="subschema">
|
|
279
|
+
|
|
280
|
+
<div class="description">
|
|
281
|
+
This must be a 'list' configuration point, where each element in the list must be a service to forward messages to.
|
|
282
|
+
</div>
|
|
283
|
+
|
|
284
|
+
|
|
285
|
+
|
|
286
|
+
|
|
287
|
+
|
|
288
|
+
|
|
289
|
+
|
|
290
|
+
|
|
291
|
+
</div>
|
|
292
|
+
</div>
|
|
293
|
+
|
|
294
|
+
|
|
295
|
+
</div>
|
|
296
|
+
|
|
297
|
+
|
|
298
|
+
|
|
299
|
+
|
|
300
|
+
|
|
301
|
+
|
|
302
|
+
</div>
|
|
303
|
+
|
|
304
|
+
|
|
305
|
+
<h3><a name="RedirectingInterceptor_sp">RedirectingInterceptor</a> <small><em>(singleton)</em></small></h3>
|
|
306
|
+
|
|
307
|
+
<div class="item-body">
|
|
308
|
+
|
|
309
|
+
|
|
310
|
+
<p class="description">
|
|
311
|
+
Redirects incoming messages, so that a message A might get rerouted to message B. You can do more complex redirections as well, specifying a regular expression and a replacement pattern. Any message not matching one of the patterns will be routed through, unchanged.
|
|
312
|
+
</p>
|
|
313
|
+
|
|
314
|
+
|
|
315
|
+
<h4>Implementor</h4>
|
|
316
|
+
<div class="definition-item">
|
|
317
|
+
|
|
318
|
+
copland/lib/redirecting-interceptor/Copland::Library::RedirectingInterceptorFactory
|
|
319
|
+
|
|
320
|
+
</div>
|
|
321
|
+
|
|
322
|
+
|
|
323
|
+
<h4>Schema</h4>
|
|
324
|
+
<div class="definition-item">
|
|
325
|
+
|
|
326
|
+
|
|
327
|
+
|
|
328
|
+
|
|
329
|
+
|
|
330
|
+
|
|
331
|
+
|
|
332
|
+
<div class="schema-item">
|
|
333
|
+
|
|
334
|
+
<div class="subschema-name">
|
|
335
|
+
redirect
|
|
336
|
+
[any]
|
|
337
|
+
<em>(required)</em>
|
|
338
|
+
</div>
|
|
339
|
+
<div class="subschema">
|
|
340
|
+
|
|
341
|
+
<div class="description">
|
|
342
|
+
This should be either a hash or a map configuration point that defines the mappings for redirection. Each key should be a regular expression (implicitly wrapped in "^(.*)$"), and the value should be a string (possibly containing literals of the form "\1", for substituting the corresponding subgroup in the pattern).
|
|
343
|
+
</div>
|
|
344
|
+
|
|
345
|
+
|
|
346
|
+
|
|
347
|
+
|
|
348
|
+
|
|
349
|
+
|
|
350
|
+
|
|
351
|
+
|
|
352
|
+
</div>
|
|
353
|
+
</div>
|
|
354
|
+
|
|
355
|
+
|
|
356
|
+
</div>
|
|
357
|
+
|
|
358
|
+
|
|
359
|
+
|
|
360
|
+
|
|
361
|
+
|
|
362
|
+
|
|
363
|
+
</div>
|
|
364
|
+
|
|
365
|
+
|
|
366
|
+
<h3><a name="RubySymbolSource_sp">RubySymbolSource</a> <small><em>(singleton)</em></small></h3>
|
|
367
|
+
|
|
368
|
+
<div class="item-body">
|
|
369
|
+
|
|
370
|
+
|
|
371
|
+
<p class="description">
|
|
372
|
+
A symbol source that draws its values from the Config::CONFIG hash. This source is not made available by default--applications wishing to use it must manually add it to the copland.SymbolSources configuration point.
|
|
373
|
+
</p>
|
|
374
|
+
|
|
375
|
+
|
|
376
|
+
<h4>Implementor</h4>
|
|
377
|
+
<div class="definition-item">
|
|
378
|
+
|
|
379
|
+
copland/lib/ruby-symbol-source/Copland::Library::RubySymbolSource
|
|
380
|
+
|
|
381
|
+
</div>
|
|
382
|
+
|
|
383
|
+
|
|
384
|
+
|
|
385
|
+
|
|
386
|
+
|
|
387
|
+
|
|
388
|
+
|
|
389
|
+
</div>
|
|
390
|
+
|
|
391
|
+
|
|
392
|
+
<h3><a name="SynchronizingInterceptor_sp">SynchronizingInterceptor</a> <small><em>(singleton)</em></small></h3>
|
|
393
|
+
|
|
394
|
+
<div class="item-body">
|
|
395
|
+
|
|
396
|
+
|
|
397
|
+
<p class="description">
|
|
398
|
+
An interceptor that wraps each invocation of a service's methods inside a mutex's synchronization block. Each method is protected by its own mutex.
|
|
399
|
+
</p>
|
|
400
|
+
|
|
401
|
+
|
|
402
|
+
<h4>Implementor</h4>
|
|
403
|
+
<div class="definition-item">
|
|
404
|
+
|
|
405
|
+
copland/lib/synchronizing-interceptor/Copland::Library::SynchronizingInterceptorFactory
|
|
406
|
+
|
|
407
|
+
</div>
|
|
408
|
+
|
|
409
|
+
|
|
410
|
+
<h4>Schema</h4>
|
|
411
|
+
<div class="definition-item">
|
|
412
|
+
<a href="copland.html#IncludeExcludeSchema_scm">copland.IncludeExcludeSchema</a>
|
|
413
|
+
</div>
|
|
414
|
+
|
|
415
|
+
|
|
416
|
+
|
|
417
|
+
|
|
418
|
+
|
|
419
|
+
|
|
420
|
+
</div>
|
|
421
|
+
|
|
422
|
+
|
|
423
|
+
|
|
424
|
+
|
|
425
|
+
<!-- CONFIGURATION POINTS -->
|
|
426
|
+
|
|
427
|
+
|
|
428
|
+
|
|
429
|
+
<!-- SCHEMAS -->
|
|
430
|
+
|
|
431
|
+
|
|
432
|
+
<div class="generated-by">
|
|
433
|
+
Generated by
|
|
434
|
+
<a href="http://copland.rubyforge.org">Copland</a>'s
|
|
435
|
+
Packrat documentation extractor
|
|
436
|
+
on Sun Sep 26 21:37:13 MDT 2004
|
|
437
|
+
</div>
|
|
438
|
+
</body>
|
|
439
|
+
</html>
|
|
@@ -0,0 +1,2096 @@
|
|
|
1
|
+
<html>
|
|
2
|
+
<head>
|
|
3
|
+
<title>copland.remote</title>
|
|
4
|
+
<link rel="stylesheet" type="text/css" href="packrat.css" />
|
|
5
|
+
</head>
|
|
6
|
+
<body>
|
|
7
|
+
<h1>copland.remote</h1>
|
|
8
|
+
|
|
9
|
+
<!-- INDEX OF PACKAGE CONTENTS -->
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
<div class="description">
|
|
13
|
+
The copland.remote package is where standard Copland services dealing with remote access to services or servers are kept.
|
|
14
|
+
</div>
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
<div class="nav">
|
|
18
|
+
Return to
|
|
19
|
+
|
|
20
|
+
<a href="index.html">index</a>
|
|
21
|
+
|
|
22
|
+
</div>
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
<h3>Service Points</h3>
|
|
26
|
+
<ul>
|
|
27
|
+
|
|
28
|
+
<li><a href="copland.remote.html#DRbServerFactory_sp">DRbServerFactory</a></li>
|
|
29
|
+
|
|
30
|
+
<li><a href="copland.remote.html#DRbServiceFactory_sp">DRbServiceFactory</a></li>
|
|
31
|
+
|
|
32
|
+
<li><a href="copland.remote.html#DefaultDRbServer_sp">DefaultDRbServer</a></li>
|
|
33
|
+
|
|
34
|
+
<li><a href="copland.remote.html#DefaultSOAPServer_sp">DefaultSOAPServer</a></li>
|
|
35
|
+
|
|
36
|
+
<li><a href="copland.remote.html#DefaultXMLRPCServer_sp">DefaultXMLRPCServer</a></li>
|
|
37
|
+
|
|
38
|
+
<li><a href="copland.remote.html#SOAPServerFactory_sp">SOAPServerFactory</a></li>
|
|
39
|
+
|
|
40
|
+
<li><a href="copland.remote.html#SOAPServiceFactory_sp">SOAPServiceFactory</a></li>
|
|
41
|
+
|
|
42
|
+
<li><a href="copland.remote.html#XMLRPCServerFactory_sp">XMLRPCServerFactory</a></li>
|
|
43
|
+
|
|
44
|
+
<li><a href="copland.remote.html#XMLRPCServiceFactory_sp">XMLRPCServiceFactory</a></li>
|
|
45
|
+
|
|
46
|
+
</ul>
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
|
|
50
|
+
<h3>Configuration Points</h3>
|
|
51
|
+
<ul>
|
|
52
|
+
|
|
53
|
+
<li><a href="copland.remote.html#DefaultDRbServerConfiguration_cp">DefaultDRbServerConfiguration</a></li>
|
|
54
|
+
|
|
55
|
+
<li><a href="copland.remote.html#DefaultDRbServerExport_cp">DefaultDRbServerExport</a></li>
|
|
56
|
+
|
|
57
|
+
<li><a href="copland.remote.html#DefaultSOAPServerConfiguration_cp">DefaultSOAPServerConfiguration</a></li>
|
|
58
|
+
|
|
59
|
+
<li><a href="copland.remote.html#DefaultSOAPServices_cp">DefaultSOAPServices</a></li>
|
|
60
|
+
|
|
61
|
+
<li><a href="copland.remote.html#DefaultXMLRPCServerConfiguration_cp">DefaultXMLRPCServerConfiguration</a></li>
|
|
62
|
+
|
|
63
|
+
<li><a href="copland.remote.html#DefaultXMLRPCServices_cp">DefaultXMLRPCServices</a></li>
|
|
64
|
+
|
|
65
|
+
</ul>
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
|
|
69
|
+
<h3>Schemas</h3>
|
|
70
|
+
<ul>
|
|
71
|
+
|
|
72
|
+
<li><a href="copland.remote.html#DRbServerConfiguration_scm">DRbServerConfiguration</a></li>
|
|
73
|
+
|
|
74
|
+
<li><a href="copland.remote.html#DRbServerExport_scm">DRbServerExport</a></li>
|
|
75
|
+
|
|
76
|
+
<li><a href="copland.remote.html#SOAPServerConfiguration_scm">SOAPServerConfiguration</a></li>
|
|
77
|
+
|
|
78
|
+
<li><a href="copland.remote.html#SOAPServices_scm">SOAPServices</a></li>
|
|
79
|
+
|
|
80
|
+
<li><a href="copland.remote.html#XMLRPCServerConfiguration_scm">XMLRPCServerConfiguration</a></li>
|
|
81
|
+
|
|
82
|
+
<li><a href="copland.remote.html#XMLRPCServices_scm">XMLRPCServices</a></li>
|
|
83
|
+
|
|
84
|
+
</ul>
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
<!-- SERVICE POINTS -->
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
<h2>Service Points</h2>
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
<h3><a name="DRbServerFactory_sp">DRbServerFactory</a> <small><em>(singleton)</em></small></h3>
|
|
94
|
+
|
|
95
|
+
<div class="item-body">
|
|
96
|
+
|
|
97
|
+
|
|
98
|
+
<p class="description">
|
|
99
|
+
This factory service will create new DRb servers, based on the configuration given. Each server may export a single Copland service, and may specify which methods of the service to export (and even alias them, if desired).
|
|
100
|
+
</p>
|
|
101
|
+
|
|
102
|
+
|
|
103
|
+
<h4>Implementor</h4>
|
|
104
|
+
<div class="definition-item">
|
|
105
|
+
|
|
106
|
+
copland/remote/drb-server-factory/Copland::Remote::DRbServerFactory
|
|
107
|
+
|
|
108
|
+
</div>
|
|
109
|
+
|
|
110
|
+
|
|
111
|
+
<h4>Schema</h4>
|
|
112
|
+
<div class="definition-item">
|
|
113
|
+
|
|
114
|
+
<div class="description">
|
|
115
|
+
One of 'export' and 'export-configuration' must always be specified.
|
|
116
|
+
</div>
|
|
117
|
+
|
|
118
|
+
|
|
119
|
+
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
|
|
123
|
+
|
|
124
|
+
<div class="schema-item">
|
|
125
|
+
|
|
126
|
+
<div class="subschema-name">
|
|
127
|
+
export
|
|
128
|
+
|
|
129
|
+
|
|
130
|
+
</div>
|
|
131
|
+
<div class="subschema">
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
<div class="schema-item">
|
|
140
|
+
|
|
141
|
+
<div class="subschema-name">
|
|
142
|
+
service
|
|
143
|
+
[service]
|
|
144
|
+
<em>(required)</em>
|
|
145
|
+
</div>
|
|
146
|
+
<div class="subschema">
|
|
147
|
+
|
|
148
|
+
<div class="description">
|
|
149
|
+
A reference tot he service to export.
|
|
150
|
+
</div>
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
</div>
|
|
160
|
+
<div class="subschema-name">
|
|
161
|
+
methods
|
|
162
|
+
[array]
|
|
163
|
+
|
|
164
|
+
</div>
|
|
165
|
+
<div class="subschema">
|
|
166
|
+
|
|
167
|
+
<div class="description">
|
|
168
|
+
A list of the methods to export. It may be a list of strings or hashes, or a combination of the two. Where an element is a string, it is the name of the method to export. Where it is a hash, it must contain a "name" key (defining the name of the method to export), and may contain an "alias" key (defining the name by which the method ought to be exported).
|
|
169
|
+
</div>
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
|
|
177
|
+
|
|
178
|
+
</div>
|
|
179
|
+
</div>
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
</div>
|
|
183
|
+
<div class="subschema-name">
|
|
184
|
+
export-configuration
|
|
185
|
+
[configuration]
|
|
186
|
+
|
|
187
|
+
</div>
|
|
188
|
+
<div class="subschema">
|
|
189
|
+
|
|
190
|
+
<div class="description">
|
|
191
|
+
A configuration point that ought to have the DRbServerExport schema. If 'export' is given, then this option should not be given, and vice versa.
|
|
192
|
+
</div>
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
|
|
201
|
+
</div>
|
|
202
|
+
<div class="subschema-name">
|
|
203
|
+
setup
|
|
204
|
+
|
|
205
|
+
|
|
206
|
+
</div>
|
|
207
|
+
<div class="subschema">
|
|
208
|
+
|
|
209
|
+
|
|
210
|
+
|
|
211
|
+
|
|
212
|
+
|
|
213
|
+
|
|
214
|
+
|
|
215
|
+
<div class="schema-item">
|
|
216
|
+
|
|
217
|
+
<div class="subschema-name">
|
|
218
|
+
server.auto.start
|
|
219
|
+
[boolean]
|
|
220
|
+
|
|
221
|
+
</div>
|
|
222
|
+
<div class="subschema">
|
|
223
|
+
|
|
224
|
+
<div class="description">
|
|
225
|
+
Whether or not the server should be started when the service is instantiated. If false, then the application must start the service manually.
|
|
226
|
+
</div>
|
|
227
|
+
|
|
228
|
+
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
|
|
235
|
+
</div>
|
|
236
|
+
<div class="subschema-name">
|
|
237
|
+
server.bind.address
|
|
238
|
+
[string]
|
|
239
|
+
|
|
240
|
+
</div>
|
|
241
|
+
<div class="subschema">
|
|
242
|
+
|
|
243
|
+
<div class="description">
|
|
244
|
+
The address that the server should bind to. This defaults to "127.0.0.1", which means that (by default) the server will not accept connections from other machines.
|
|
245
|
+
</div>
|
|
246
|
+
|
|
247
|
+
|
|
248
|
+
|
|
249
|
+
|
|
250
|
+
|
|
251
|
+
|
|
252
|
+
|
|
253
|
+
|
|
254
|
+
</div>
|
|
255
|
+
<div class="subschema-name">
|
|
256
|
+
server.port
|
|
257
|
+
[integer]
|
|
258
|
+
|
|
259
|
+
</div>
|
|
260
|
+
<div class="subschema">
|
|
261
|
+
|
|
262
|
+
<div class="description">
|
|
263
|
+
The port that the server will listen on.
|
|
264
|
+
</div>
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
|
|
268
|
+
|
|
269
|
+
|
|
270
|
+
|
|
271
|
+
|
|
272
|
+
|
|
273
|
+
</div>
|
|
274
|
+
<div class="subschema-name">
|
|
275
|
+
server.use-log
|
|
276
|
+
[boolean]
|
|
277
|
+
|
|
278
|
+
</div>
|
|
279
|
+
<div class="subschema">
|
|
280
|
+
|
|
281
|
+
<div class="description">
|
|
282
|
+
Whether or not a log should be created for the new service. Default to false.
|
|
283
|
+
</div>
|
|
284
|
+
|
|
285
|
+
|
|
286
|
+
|
|
287
|
+
|
|
288
|
+
|
|
289
|
+
|
|
290
|
+
|
|
291
|
+
|
|
292
|
+
</div>
|
|
293
|
+
</div>
|
|
294
|
+
|
|
295
|
+
|
|
296
|
+
</div>
|
|
297
|
+
<div class="subschema-name">
|
|
298
|
+
setup-configuration
|
|
299
|
+
[configuration]
|
|
300
|
+
|
|
301
|
+
</div>
|
|
302
|
+
<div class="subschema">
|
|
303
|
+
|
|
304
|
+
<div class="description">
|
|
305
|
+
A configuration point that ought to have the DRbServerConfiguration schema. If 'setup' is given, then this option should not be given, and vice versa.
|
|
306
|
+
</div>
|
|
307
|
+
|
|
308
|
+
|
|
309
|
+
|
|
310
|
+
|
|
311
|
+
|
|
312
|
+
|
|
313
|
+
|
|
314
|
+
|
|
315
|
+
</div>
|
|
316
|
+
</div>
|
|
317
|
+
|
|
318
|
+
|
|
319
|
+
</div>
|
|
320
|
+
|
|
321
|
+
|
|
322
|
+
|
|
323
|
+
|
|
324
|
+
|
|
325
|
+
|
|
326
|
+
</div>
|
|
327
|
+
|
|
328
|
+
|
|
329
|
+
<h3><a name="DRbServiceFactory_sp">DRbServiceFactory</a> <small><em>(singleton)</em></small></h3>
|
|
330
|
+
|
|
331
|
+
<div class="item-body">
|
|
332
|
+
|
|
333
|
+
|
|
334
|
+
<p class="description">
|
|
335
|
+
This factory allows remote Ruby objects (exported via DRb) to be wrapped transparently as services.
|
|
336
|
+
</p>
|
|
337
|
+
|
|
338
|
+
|
|
339
|
+
<h4>Implementor</h4>
|
|
340
|
+
<div class="definition-item">
|
|
341
|
+
|
|
342
|
+
copland/remote/drb-service-factory/Copland::Remote::DRbServiceFactory
|
|
343
|
+
|
|
344
|
+
</div>
|
|
345
|
+
|
|
346
|
+
|
|
347
|
+
<h4>Schema</h4>
|
|
348
|
+
<div class="definition-item">
|
|
349
|
+
|
|
350
|
+
|
|
351
|
+
|
|
352
|
+
|
|
353
|
+
|
|
354
|
+
|
|
355
|
+
|
|
356
|
+
<div class="schema-item">
|
|
357
|
+
|
|
358
|
+
<div class="subschema-name">
|
|
359
|
+
uri
|
|
360
|
+
[string]
|
|
361
|
+
<em>(required)</em>
|
|
362
|
+
</div>
|
|
363
|
+
<div class="subschema">
|
|
364
|
+
|
|
365
|
+
<div class="description">
|
|
366
|
+
The URI of the remote object to wrap.
|
|
367
|
+
</div>
|
|
368
|
+
|
|
369
|
+
|
|
370
|
+
|
|
371
|
+
|
|
372
|
+
|
|
373
|
+
|
|
374
|
+
|
|
375
|
+
|
|
376
|
+
</div>
|
|
377
|
+
</div>
|
|
378
|
+
|
|
379
|
+
|
|
380
|
+
</div>
|
|
381
|
+
|
|
382
|
+
|
|
383
|
+
|
|
384
|
+
|
|
385
|
+
|
|
386
|
+
|
|
387
|
+
</div>
|
|
388
|
+
|
|
389
|
+
|
|
390
|
+
<h3><a name="DefaultDRbServer_sp">DefaultDRbServer</a> <small><em>(singleton-deferred)</em></small></h3>
|
|
391
|
+
|
|
392
|
+
<div class="item-body">
|
|
393
|
+
|
|
394
|
+
|
|
395
|
+
<p class="description">
|
|
396
|
+
A default DRb server that applications may configure. If more than one DRb server is needed, then the application should create its own servers using the DRbServerFactory.
|
|
397
|
+
</p>
|
|
398
|
+
|
|
399
|
+
|
|
400
|
+
<h4>Implementor</h4>
|
|
401
|
+
<div class="definition-item">
|
|
402
|
+
|
|
403
|
+
<ul>
|
|
404
|
+
<li>factory: <a href="copland.remote.html#DRbServerFactory_sp">copland.remote.DRbServerFactory</a></li>
|
|
405
|
+
|
|
406
|
+
<li>export-configuration: !!configuration <a href="copland.remote.html#DefaultDRbServerExport_cp">copland.remote.DefaultDRbServerExport</a></li><li>setup-configuration: !!configuration <a href="copland.remote.html#DefaultDRbServerConfiguration_cp">copland.remote.DefaultDRbServerConfiguration</a></li>
|
|
407
|
+
|
|
408
|
+
</ul>
|
|
409
|
+
|
|
410
|
+
</div>
|
|
411
|
+
|
|
412
|
+
|
|
413
|
+
|
|
414
|
+
|
|
415
|
+
|
|
416
|
+
|
|
417
|
+
|
|
418
|
+
</div>
|
|
419
|
+
|
|
420
|
+
|
|
421
|
+
<h3><a name="DefaultSOAPServer_sp">DefaultSOAPServer</a> <small><em>(singleton-deferred)</em></small></h3>
|
|
422
|
+
|
|
423
|
+
<div class="item-body">
|
|
424
|
+
|
|
425
|
+
|
|
426
|
+
<p class="description">
|
|
427
|
+
A default SOAP server that applications may configure and use. If an application requires more than one SOAP server, it should set them up manually via the SOAPServerFactory service.
|
|
428
|
+
</p>
|
|
429
|
+
|
|
430
|
+
|
|
431
|
+
<h4>Implementor</h4>
|
|
432
|
+
<div class="definition-item">
|
|
433
|
+
|
|
434
|
+
<ul>
|
|
435
|
+
<li>factory: <a href="copland.remote.html#SOAPServerFactory_sp">copland.remote.SOAPServerFactory</a></li>
|
|
436
|
+
|
|
437
|
+
<li>services-configuration: !!configuration <a href="copland.remote.html#DefaultSOAPServices_cp">copland.remote.DefaultSOAPServices</a></li><li>setup-configuration: !!configuration <a href="copland.remote.html#DefaultSOAPServerConfiguration_cp">copland.remote.DefaultSOAPServerConfiguration</a></li>
|
|
438
|
+
|
|
439
|
+
</ul>
|
|
440
|
+
|
|
441
|
+
</div>
|
|
442
|
+
|
|
443
|
+
|
|
444
|
+
|
|
445
|
+
|
|
446
|
+
|
|
447
|
+
|
|
448
|
+
|
|
449
|
+
</div>
|
|
450
|
+
|
|
451
|
+
|
|
452
|
+
<h3><a name="DefaultXMLRPCServer_sp">DefaultXMLRPCServer</a> <small><em>(singleton-deferred)</em></small></h3>
|
|
453
|
+
|
|
454
|
+
<div class="item-body">
|
|
455
|
+
|
|
456
|
+
|
|
457
|
+
<p class="description">
|
|
458
|
+
This service will create a an XMLRPC server instance.
|
|
459
|
+
</p>
|
|
460
|
+
|
|
461
|
+
|
|
462
|
+
<h4>Implementor</h4>
|
|
463
|
+
<div class="definition-item">
|
|
464
|
+
|
|
465
|
+
<ul>
|
|
466
|
+
<li>factory: <a href="copland.remote.html#XMLRPCServerFactory_sp">copland.remote.XMLRPCServerFactory</a></li>
|
|
467
|
+
|
|
468
|
+
<li>services-configuration: !!configuration <a href="copland.remote.html#DefaultXMLRPCServices_cp">copland.remote.DefaultXMLRPCServices</a></li><li>setup-configuration: !!configuration <a href="copland.remote.html#DefaultXMLRPCServerConfiguration_cp">copland.remote.DefaultXMLRPCServerConfiguration</a></li>
|
|
469
|
+
|
|
470
|
+
</ul>
|
|
471
|
+
|
|
472
|
+
</div>
|
|
473
|
+
|
|
474
|
+
|
|
475
|
+
|
|
476
|
+
|
|
477
|
+
|
|
478
|
+
|
|
479
|
+
|
|
480
|
+
</div>
|
|
481
|
+
|
|
482
|
+
|
|
483
|
+
<h3><a name="SOAPServerFactory_sp">SOAPServerFactory</a> <small><em>(singleton)</em></small></h3>
|
|
484
|
+
|
|
485
|
+
<div class="item-body">
|
|
486
|
+
|
|
487
|
+
|
|
488
|
+
<p class="description">
|
|
489
|
+
This service creates new SOAP servers, based on the configuration given. This allows applications to define multiple SOAP servers. If an application only needs one, it will be easier just to use the predefined DefaultSOAPServer service.
|
|
490
|
+
</p>
|
|
491
|
+
|
|
492
|
+
|
|
493
|
+
<h4>Implementor</h4>
|
|
494
|
+
<div class="definition-item">
|
|
495
|
+
|
|
496
|
+
copland/remote/soap-server-factory/Copland::Remote::SOAPServerFactory
|
|
497
|
+
|
|
498
|
+
</div>
|
|
499
|
+
|
|
500
|
+
|
|
501
|
+
<h4>Schema</h4>
|
|
502
|
+
<div class="definition-item">
|
|
503
|
+
|
|
504
|
+
<div class="description">
|
|
505
|
+
One of 'services' and 'services-configuration' must always be specified. When given, only one of 'setup' and 'setup-configuration' should be given as well.
|
|
506
|
+
</div>
|
|
507
|
+
|
|
508
|
+
|
|
509
|
+
|
|
510
|
+
|
|
511
|
+
|
|
512
|
+
|
|
513
|
+
|
|
514
|
+
<div class="schema-item">
|
|
515
|
+
|
|
516
|
+
<div class="subschema-name">
|
|
517
|
+
services
|
|
518
|
+
|
|
519
|
+
|
|
520
|
+
</div>
|
|
521
|
+
<div class="subschema">
|
|
522
|
+
|
|
523
|
+
|
|
524
|
+
|
|
525
|
+
|
|
526
|
+
|
|
527
|
+
|
|
528
|
+
|
|
529
|
+
<div class="schema-item">
|
|
530
|
+
|
|
531
|
+
<div class="subschema-name">
|
|
532
|
+
namespace
|
|
533
|
+
[string]
|
|
534
|
+
<em>(required)</em>
|
|
535
|
+
</div>
|
|
536
|
+
<div class="subschema">
|
|
537
|
+
|
|
538
|
+
<div class="description">
|
|
539
|
+
The name by which remote clients should request this service.
|
|
540
|
+
</div>
|
|
541
|
+
|
|
542
|
+
|
|
543
|
+
|
|
544
|
+
|
|
545
|
+
|
|
546
|
+
|
|
547
|
+
|
|
548
|
+
|
|
549
|
+
</div>
|
|
550
|
+
<div class="subschema-name">
|
|
551
|
+
service
|
|
552
|
+
[service]
|
|
553
|
+
<em>(required)</em>
|
|
554
|
+
</div>
|
|
555
|
+
<div class="subschema">
|
|
556
|
+
|
|
557
|
+
<div class="description">
|
|
558
|
+
The service to export.
|
|
559
|
+
</div>
|
|
560
|
+
|
|
561
|
+
|
|
562
|
+
|
|
563
|
+
|
|
564
|
+
|
|
565
|
+
|
|
566
|
+
|
|
567
|
+
|
|
568
|
+
</div>
|
|
569
|
+
<div class="subschema-name">
|
|
570
|
+
methods
|
|
571
|
+
[array]
|
|
572
|
+
|
|
573
|
+
</div>
|
|
574
|
+
<div class="subschema">
|
|
575
|
+
|
|
576
|
+
<div class="description">
|
|
577
|
+
The list of methods that should be exported by this service. Each element of the list ought to be either a string (naming a method), or a hash. The hash must have at least the "name" key (to identify the method to export), and may optionally have an "alias" key (to identify the name by which the method should be exported).
|
|
578
|
+
</div>
|
|
579
|
+
|
|
580
|
+
|
|
581
|
+
|
|
582
|
+
|
|
583
|
+
|
|
584
|
+
|
|
585
|
+
|
|
586
|
+
|
|
587
|
+
</div>
|
|
588
|
+
</div>
|
|
589
|
+
|
|
590
|
+
|
|
591
|
+
</div>
|
|
592
|
+
<div class="subschema-name">
|
|
593
|
+
services-configuration
|
|
594
|
+
[configuration]
|
|
595
|
+
|
|
596
|
+
</div>
|
|
597
|
+
<div class="subschema">
|
|
598
|
+
|
|
599
|
+
<div class="description">
|
|
600
|
+
A configuration point that ought to have the SOAPServices schema. If 'services' is given, then this option should not be given, and vice versa.
|
|
601
|
+
</div>
|
|
602
|
+
|
|
603
|
+
|
|
604
|
+
|
|
605
|
+
|
|
606
|
+
|
|
607
|
+
|
|
608
|
+
|
|
609
|
+
|
|
610
|
+
</div>
|
|
611
|
+
<div class="subschema-name">
|
|
612
|
+
setup
|
|
613
|
+
|
|
614
|
+
|
|
615
|
+
</div>
|
|
616
|
+
<div class="subschema">
|
|
617
|
+
|
|
618
|
+
|
|
619
|
+
|
|
620
|
+
|
|
621
|
+
|
|
622
|
+
|
|
623
|
+
|
|
624
|
+
<div class="schema-item">
|
|
625
|
+
|
|
626
|
+
<div class="subschema-name">
|
|
627
|
+
server.auto.start
|
|
628
|
+
[boolean]
|
|
629
|
+
|
|
630
|
+
</div>
|
|
631
|
+
<div class="subschema">
|
|
632
|
+
|
|
633
|
+
<div class="description">
|
|
634
|
+
Whether or not the server should be started when the service is instantiated. If false, then the application must start the service manually.
|
|
635
|
+
</div>
|
|
636
|
+
|
|
637
|
+
|
|
638
|
+
|
|
639
|
+
|
|
640
|
+
|
|
641
|
+
|
|
642
|
+
|
|
643
|
+
|
|
644
|
+
</div>
|
|
645
|
+
<div class="subschema-name">
|
|
646
|
+
server.bind.address
|
|
647
|
+
[string]
|
|
648
|
+
|
|
649
|
+
</div>
|
|
650
|
+
<div class="subschema">
|
|
651
|
+
|
|
652
|
+
<div class="description">
|
|
653
|
+
The address that the server should bind to. This defaults to "127.0.0.1", which means that (by default) the server will not accept connections from other machines.
|
|
654
|
+
</div>
|
|
655
|
+
|
|
656
|
+
|
|
657
|
+
|
|
658
|
+
|
|
659
|
+
|
|
660
|
+
|
|
661
|
+
|
|
662
|
+
|
|
663
|
+
</div>
|
|
664
|
+
<div class="subschema-name">
|
|
665
|
+
server.port
|
|
666
|
+
[integer]
|
|
667
|
+
|
|
668
|
+
</div>
|
|
669
|
+
<div class="subschema">
|
|
670
|
+
|
|
671
|
+
<div class="description">
|
|
672
|
+
The port that the server will listen on.
|
|
673
|
+
</div>
|
|
674
|
+
|
|
675
|
+
|
|
676
|
+
|
|
677
|
+
|
|
678
|
+
|
|
679
|
+
|
|
680
|
+
|
|
681
|
+
|
|
682
|
+
</div>
|
|
683
|
+
<div class="subschema-name">
|
|
684
|
+
server.use-log
|
|
685
|
+
[boolean]
|
|
686
|
+
|
|
687
|
+
</div>
|
|
688
|
+
<div class="subschema">
|
|
689
|
+
|
|
690
|
+
<div class="description">
|
|
691
|
+
Whether or not a log should be created for the new service. Default to false.
|
|
692
|
+
</div>
|
|
693
|
+
|
|
694
|
+
|
|
695
|
+
|
|
696
|
+
|
|
697
|
+
|
|
698
|
+
|
|
699
|
+
|
|
700
|
+
|
|
701
|
+
</div>
|
|
702
|
+
</div>
|
|
703
|
+
|
|
704
|
+
|
|
705
|
+
</div>
|
|
706
|
+
<div class="subschema-name">
|
|
707
|
+
setup-configuration
|
|
708
|
+
[configuration]
|
|
709
|
+
|
|
710
|
+
</div>
|
|
711
|
+
<div class="subschema">
|
|
712
|
+
|
|
713
|
+
<div class="description">
|
|
714
|
+
A configuration point that ought to have the DRbServerConfiguration schema. If 'setup' is given, then this option should not be given, and vice versa.
|
|
715
|
+
</div>
|
|
716
|
+
|
|
717
|
+
|
|
718
|
+
|
|
719
|
+
|
|
720
|
+
|
|
721
|
+
|
|
722
|
+
|
|
723
|
+
|
|
724
|
+
</div>
|
|
725
|
+
</div>
|
|
726
|
+
|
|
727
|
+
|
|
728
|
+
</div>
|
|
729
|
+
|
|
730
|
+
|
|
731
|
+
|
|
732
|
+
|
|
733
|
+
|
|
734
|
+
|
|
735
|
+
</div>
|
|
736
|
+
|
|
737
|
+
|
|
738
|
+
<h3><a name="SOAPServiceFactory_sp">SOAPServiceFactory</a> <small><em>(singleton)</em></small></h3>
|
|
739
|
+
|
|
740
|
+
<div class="item-body">
|
|
741
|
+
|
|
742
|
+
|
|
743
|
+
<p class="description">
|
|
744
|
+
This factory allows remote objects (exported via SOAP) to be wrapped transparently as services.
|
|
745
|
+
</p>
|
|
746
|
+
|
|
747
|
+
|
|
748
|
+
<h4>Implementor</h4>
|
|
749
|
+
<div class="definition-item">
|
|
750
|
+
|
|
751
|
+
copland/remote/soap-service-factory/Copland::Remote::SOAPServiceFactory
|
|
752
|
+
|
|
753
|
+
</div>
|
|
754
|
+
|
|
755
|
+
|
|
756
|
+
<h4>Schema</h4>
|
|
757
|
+
<div class="definition-item">
|
|
758
|
+
|
|
759
|
+
|
|
760
|
+
|
|
761
|
+
|
|
762
|
+
|
|
763
|
+
|
|
764
|
+
|
|
765
|
+
<div class="schema-item">
|
|
766
|
+
|
|
767
|
+
<div class="subschema-name">
|
|
768
|
+
methods
|
|
769
|
+
[array]
|
|
770
|
+
<em>(required)</em>
|
|
771
|
+
</div>
|
|
772
|
+
<div class="subschema">
|
|
773
|
+
|
|
774
|
+
<div class="description">
|
|
775
|
+
The array of methods to be imported from the remote object.
|
|
776
|
+
</div>
|
|
777
|
+
|
|
778
|
+
|
|
779
|
+
|
|
780
|
+
|
|
781
|
+
|
|
782
|
+
|
|
783
|
+
|
|
784
|
+
<div class="schema-item">
|
|
785
|
+
|
|
786
|
+
<div class="subschema-name">
|
|
787
|
+
name
|
|
788
|
+
[string]
|
|
789
|
+
<em>(required)</em>
|
|
790
|
+
</div>
|
|
791
|
+
<div class="subschema">
|
|
792
|
+
|
|
793
|
+
<div class="description">
|
|
794
|
+
The method name to export.
|
|
795
|
+
</div>
|
|
796
|
+
|
|
797
|
+
|
|
798
|
+
|
|
799
|
+
|
|
800
|
+
|
|
801
|
+
|
|
802
|
+
|
|
803
|
+
|
|
804
|
+
</div>
|
|
805
|
+
<div class="subschema-name">
|
|
806
|
+
alias
|
|
807
|
+
[string]
|
|
808
|
+
|
|
809
|
+
</div>
|
|
810
|
+
<div class="subschema">
|
|
811
|
+
|
|
812
|
+
<div class="description">
|
|
813
|
+
The name that the method should be exported as.
|
|
814
|
+
</div>
|
|
815
|
+
|
|
816
|
+
|
|
817
|
+
|
|
818
|
+
|
|
819
|
+
|
|
820
|
+
|
|
821
|
+
|
|
822
|
+
|
|
823
|
+
</div>
|
|
824
|
+
<div class="subschema-name">
|
|
825
|
+
fixed-args
|
|
826
|
+
[integer]
|
|
827
|
+
|
|
828
|
+
</div>
|
|
829
|
+
<div class="subschema">
|
|
830
|
+
|
|
831
|
+
<div class="description">
|
|
832
|
+
The number of fixed arguments for this method. If this value is >= 0, then the method is assumed to be variable arity, with the parameter at index "fixed-args" being the one that collects all subsequent arguments.
|
|
833
|
+
</div>
|
|
834
|
+
|
|
835
|
+
|
|
836
|
+
|
|
837
|
+
|
|
838
|
+
|
|
839
|
+
|
|
840
|
+
|
|
841
|
+
|
|
842
|
+
</div>
|
|
843
|
+
<div class="subschema-name">
|
|
844
|
+
parameters
|
|
845
|
+
[array]
|
|
846
|
+
|
|
847
|
+
</div>
|
|
848
|
+
<div class="subschema">
|
|
849
|
+
|
|
850
|
+
<div class="description">
|
|
851
|
+
This is an array of strings that name the parameters to the method.
|
|
852
|
+
</div>
|
|
853
|
+
|
|
854
|
+
|
|
855
|
+
|
|
856
|
+
|
|
857
|
+
|
|
858
|
+
|
|
859
|
+
|
|
860
|
+
|
|
861
|
+
</div>
|
|
862
|
+
</div>
|
|
863
|
+
|
|
864
|
+
|
|
865
|
+
</div>
|
|
866
|
+
<div class="subschema-name">
|
|
867
|
+
name
|
|
868
|
+
[string]
|
|
869
|
+
<em>(required)</em>
|
|
870
|
+
</div>
|
|
871
|
+
<div class="subschema">
|
|
872
|
+
|
|
873
|
+
<div class="description">
|
|
874
|
+
The name of the remote object to wrap, as registered on the remote host.
|
|
875
|
+
</div>
|
|
876
|
+
|
|
877
|
+
|
|
878
|
+
|
|
879
|
+
|
|
880
|
+
|
|
881
|
+
|
|
882
|
+
|
|
883
|
+
|
|
884
|
+
</div>
|
|
885
|
+
<div class="subschema-name">
|
|
886
|
+
url
|
|
887
|
+
[string]
|
|
888
|
+
<em>(required)</em>
|
|
889
|
+
</div>
|
|
890
|
+
<div class="subschema">
|
|
891
|
+
|
|
892
|
+
<div class="description">
|
|
893
|
+
The URL of the remote object to wrap.
|
|
894
|
+
</div>
|
|
895
|
+
|
|
896
|
+
|
|
897
|
+
|
|
898
|
+
|
|
899
|
+
|
|
900
|
+
|
|
901
|
+
|
|
902
|
+
|
|
903
|
+
</div>
|
|
904
|
+
</div>
|
|
905
|
+
|
|
906
|
+
|
|
907
|
+
</div>
|
|
908
|
+
|
|
909
|
+
|
|
910
|
+
|
|
911
|
+
|
|
912
|
+
|
|
913
|
+
|
|
914
|
+
</div>
|
|
915
|
+
|
|
916
|
+
|
|
917
|
+
<h3><a name="XMLRPCServerFactory_sp">XMLRPCServerFactory</a> <small><em>(singleton)</em></small></h3>
|
|
918
|
+
|
|
919
|
+
<div class="item-body">
|
|
920
|
+
|
|
921
|
+
|
|
922
|
+
<p class="description">
|
|
923
|
+
This service creates new XML-RPC server instances, based on the configuration given to it.
|
|
924
|
+
</p>
|
|
925
|
+
|
|
926
|
+
|
|
927
|
+
<h4>Implementor</h4>
|
|
928
|
+
<div class="definition-item">
|
|
929
|
+
|
|
930
|
+
copland/remote/xmlrpc-server-factory/Copland::Remote::XMLRPCServerFactory
|
|
931
|
+
|
|
932
|
+
</div>
|
|
933
|
+
|
|
934
|
+
|
|
935
|
+
<h4>Schema</h4>
|
|
936
|
+
<div class="definition-item">
|
|
937
|
+
|
|
938
|
+
|
|
939
|
+
|
|
940
|
+
|
|
941
|
+
|
|
942
|
+
|
|
943
|
+
|
|
944
|
+
<div class="schema-item">
|
|
945
|
+
|
|
946
|
+
<div class="subschema-name">
|
|
947
|
+
services
|
|
948
|
+
|
|
949
|
+
|
|
950
|
+
</div>
|
|
951
|
+
<div class="subschema">
|
|
952
|
+
|
|
953
|
+
|
|
954
|
+
|
|
955
|
+
|
|
956
|
+
|
|
957
|
+
|
|
958
|
+
|
|
959
|
+
<div class="schema-item">
|
|
960
|
+
|
|
961
|
+
<div class="subschema-name">
|
|
962
|
+
prefix
|
|
963
|
+
[string]
|
|
964
|
+
<em>(required)</em>
|
|
965
|
+
</div>
|
|
966
|
+
<div class="subschema">
|
|
967
|
+
|
|
968
|
+
<div class="description">
|
|
969
|
+
The name by which remote clients should request this service.
|
|
970
|
+
</div>
|
|
971
|
+
|
|
972
|
+
|
|
973
|
+
|
|
974
|
+
|
|
975
|
+
|
|
976
|
+
|
|
977
|
+
|
|
978
|
+
|
|
979
|
+
</div>
|
|
980
|
+
<div class="subschema-name">
|
|
981
|
+
service
|
|
982
|
+
[service]
|
|
983
|
+
<em>(required)</em>
|
|
984
|
+
</div>
|
|
985
|
+
<div class="subschema">
|
|
986
|
+
|
|
987
|
+
<div class="description">
|
|
988
|
+
The service to export.
|
|
989
|
+
</div>
|
|
990
|
+
|
|
991
|
+
|
|
992
|
+
|
|
993
|
+
|
|
994
|
+
|
|
995
|
+
|
|
996
|
+
|
|
997
|
+
|
|
998
|
+
</div>
|
|
999
|
+
<div class="subschema-name">
|
|
1000
|
+
interface
|
|
1001
|
+
[array]
|
|
1002
|
+
|
|
1003
|
+
</div>
|
|
1004
|
+
<div class="subschema">
|
|
1005
|
+
|
|
1006
|
+
<div class="description">
|
|
1007
|
+
An array of maps that describe the methods that this service should export.
|
|
1008
|
+
</div>
|
|
1009
|
+
|
|
1010
|
+
|
|
1011
|
+
|
|
1012
|
+
|
|
1013
|
+
|
|
1014
|
+
|
|
1015
|
+
|
|
1016
|
+
<div class="schema-item">
|
|
1017
|
+
|
|
1018
|
+
<div class="subschema-name">
|
|
1019
|
+
signature
|
|
1020
|
+
[string]
|
|
1021
|
+
<em>(required)</em>
|
|
1022
|
+
</div>
|
|
1023
|
+
<div class="subschema">
|
|
1024
|
+
|
|
1025
|
+
<div class="description">
|
|
1026
|
+
A valid XMLRPC signature for the method. This is the name by which the method will be invoked.
|
|
1027
|
+
</div>
|
|
1028
|
+
|
|
1029
|
+
|
|
1030
|
+
|
|
1031
|
+
|
|
1032
|
+
|
|
1033
|
+
|
|
1034
|
+
|
|
1035
|
+
|
|
1036
|
+
</div>
|
|
1037
|
+
<div class="subschema-name">
|
|
1038
|
+
help
|
|
1039
|
+
[string]
|
|
1040
|
+
|
|
1041
|
+
</div>
|
|
1042
|
+
<div class="subschema">
|
|
1043
|
+
|
|
1044
|
+
<div class="description">
|
|
1045
|
+
This is just arbitrary text that describes this method and what it does. It is useful for XMLRPC clients to query, to know what an interface is capable of.
|
|
1046
|
+
</div>
|
|
1047
|
+
|
|
1048
|
+
|
|
1049
|
+
|
|
1050
|
+
|
|
1051
|
+
|
|
1052
|
+
|
|
1053
|
+
|
|
1054
|
+
|
|
1055
|
+
</div>
|
|
1056
|
+
<div class="subschema-name">
|
|
1057
|
+
method
|
|
1058
|
+
[string]
|
|
1059
|
+
|
|
1060
|
+
</div>
|
|
1061
|
+
<div class="subschema">
|
|
1062
|
+
|
|
1063
|
+
<div class="description">
|
|
1064
|
+
This is the actual method name (as declared in the service), if it differs from the name given in the signature. This allows for aliasing of method names.
|
|
1065
|
+
</div>
|
|
1066
|
+
|
|
1067
|
+
|
|
1068
|
+
|
|
1069
|
+
|
|
1070
|
+
|
|
1071
|
+
|
|
1072
|
+
|
|
1073
|
+
|
|
1074
|
+
</div>
|
|
1075
|
+
</div>
|
|
1076
|
+
|
|
1077
|
+
|
|
1078
|
+
</div>
|
|
1079
|
+
</div>
|
|
1080
|
+
|
|
1081
|
+
|
|
1082
|
+
</div>
|
|
1083
|
+
<div class="subschema-name">
|
|
1084
|
+
services-configuration
|
|
1085
|
+
[configuration]
|
|
1086
|
+
|
|
1087
|
+
</div>
|
|
1088
|
+
<div class="subschema">
|
|
1089
|
+
|
|
1090
|
+
<div class="description">
|
|
1091
|
+
A configuration point that ought to have the XMLRPCServices schema. If 'services' is given, then this option should not be given, and vice versa.
|
|
1092
|
+
</div>
|
|
1093
|
+
|
|
1094
|
+
|
|
1095
|
+
|
|
1096
|
+
|
|
1097
|
+
|
|
1098
|
+
|
|
1099
|
+
|
|
1100
|
+
|
|
1101
|
+
</div>
|
|
1102
|
+
<div class="subschema-name">
|
|
1103
|
+
setup
|
|
1104
|
+
|
|
1105
|
+
|
|
1106
|
+
</div>
|
|
1107
|
+
<div class="subschema">
|
|
1108
|
+
|
|
1109
|
+
|
|
1110
|
+
|
|
1111
|
+
|
|
1112
|
+
|
|
1113
|
+
|
|
1114
|
+
|
|
1115
|
+
<div class="schema-item">
|
|
1116
|
+
|
|
1117
|
+
<div class="subschema-name">
|
|
1118
|
+
max.connections
|
|
1119
|
+
[integer]
|
|
1120
|
+
|
|
1121
|
+
</div>
|
|
1122
|
+
<div class="subschema">
|
|
1123
|
+
|
|
1124
|
+
<div class="description">
|
|
1125
|
+
The maximum number of concurrent connections.
|
|
1126
|
+
</div>
|
|
1127
|
+
|
|
1128
|
+
|
|
1129
|
+
|
|
1130
|
+
|
|
1131
|
+
|
|
1132
|
+
|
|
1133
|
+
|
|
1134
|
+
|
|
1135
|
+
</div>
|
|
1136
|
+
<div class="subschema-name">
|
|
1137
|
+
server.auto.start
|
|
1138
|
+
[boolean]
|
|
1139
|
+
|
|
1140
|
+
</div>
|
|
1141
|
+
<div class="subschema">
|
|
1142
|
+
|
|
1143
|
+
<div class="description">
|
|
1144
|
+
Whether or not the server should start as soon as the service is instantiated.
|
|
1145
|
+
</div>
|
|
1146
|
+
|
|
1147
|
+
|
|
1148
|
+
|
|
1149
|
+
|
|
1150
|
+
|
|
1151
|
+
|
|
1152
|
+
|
|
1153
|
+
|
|
1154
|
+
</div>
|
|
1155
|
+
<div class="subschema-name">
|
|
1156
|
+
server.bind.address
|
|
1157
|
+
[string]
|
|
1158
|
+
|
|
1159
|
+
</div>
|
|
1160
|
+
<div class="subschema">
|
|
1161
|
+
|
|
1162
|
+
<div class="description">
|
|
1163
|
+
The address that the server should bind to.
|
|
1164
|
+
</div>
|
|
1165
|
+
|
|
1166
|
+
|
|
1167
|
+
|
|
1168
|
+
|
|
1169
|
+
|
|
1170
|
+
|
|
1171
|
+
|
|
1172
|
+
|
|
1173
|
+
</div>
|
|
1174
|
+
<div class="subschema-name">
|
|
1175
|
+
server.port
|
|
1176
|
+
[integer]
|
|
1177
|
+
|
|
1178
|
+
</div>
|
|
1179
|
+
<div class="subschema">
|
|
1180
|
+
|
|
1181
|
+
<div class="description">
|
|
1182
|
+
The port that the server should listen on.
|
|
1183
|
+
</div>
|
|
1184
|
+
|
|
1185
|
+
|
|
1186
|
+
|
|
1187
|
+
|
|
1188
|
+
|
|
1189
|
+
|
|
1190
|
+
|
|
1191
|
+
|
|
1192
|
+
</div>
|
|
1193
|
+
<div class="subschema-name">
|
|
1194
|
+
server.use-log
|
|
1195
|
+
[boolean]
|
|
1196
|
+
|
|
1197
|
+
</div>
|
|
1198
|
+
<div class="subschema">
|
|
1199
|
+
|
|
1200
|
+
<div class="description">
|
|
1201
|
+
Whether or not a new log should be created for each service.
|
|
1202
|
+
</div>
|
|
1203
|
+
|
|
1204
|
+
|
|
1205
|
+
|
|
1206
|
+
|
|
1207
|
+
|
|
1208
|
+
|
|
1209
|
+
|
|
1210
|
+
|
|
1211
|
+
</div>
|
|
1212
|
+
</div>
|
|
1213
|
+
|
|
1214
|
+
|
|
1215
|
+
</div>
|
|
1216
|
+
<div class="subschema-name">
|
|
1217
|
+
setup-configuration
|
|
1218
|
+
[configuration]
|
|
1219
|
+
|
|
1220
|
+
</div>
|
|
1221
|
+
<div class="subschema">
|
|
1222
|
+
|
|
1223
|
+
<div class="description">
|
|
1224
|
+
A configuration point that ought to have the XMLRPCServerConfiguration schema. If 'setup' is given, then this option should not be given, and vice versa.
|
|
1225
|
+
</div>
|
|
1226
|
+
|
|
1227
|
+
|
|
1228
|
+
|
|
1229
|
+
|
|
1230
|
+
|
|
1231
|
+
|
|
1232
|
+
|
|
1233
|
+
|
|
1234
|
+
</div>
|
|
1235
|
+
</div>
|
|
1236
|
+
|
|
1237
|
+
|
|
1238
|
+
</div>
|
|
1239
|
+
|
|
1240
|
+
|
|
1241
|
+
|
|
1242
|
+
|
|
1243
|
+
|
|
1244
|
+
|
|
1245
|
+
</div>
|
|
1246
|
+
|
|
1247
|
+
|
|
1248
|
+
<h3><a name="XMLRPCServiceFactory_sp">XMLRPCServiceFactory</a> <small><em>(singleton)</em></small></h3>
|
|
1249
|
+
|
|
1250
|
+
<div class="item-body">
|
|
1251
|
+
|
|
1252
|
+
|
|
1253
|
+
<p class="description">
|
|
1254
|
+
This factory allows remote objects (exported via XMLRPC) to be wrapped transparently as services.
|
|
1255
|
+
</p>
|
|
1256
|
+
|
|
1257
|
+
|
|
1258
|
+
<h4>Implementor</h4>
|
|
1259
|
+
<div class="definition-item">
|
|
1260
|
+
|
|
1261
|
+
copland/remote/xmlrpc-service-factory/Copland::Remote::XMLRPCServiceFactory
|
|
1262
|
+
|
|
1263
|
+
</div>
|
|
1264
|
+
|
|
1265
|
+
|
|
1266
|
+
<h4>Schema</h4>
|
|
1267
|
+
<div class="definition-item">
|
|
1268
|
+
|
|
1269
|
+
|
|
1270
|
+
|
|
1271
|
+
|
|
1272
|
+
|
|
1273
|
+
|
|
1274
|
+
|
|
1275
|
+
<div class="schema-item">
|
|
1276
|
+
|
|
1277
|
+
<div class="subschema-name">
|
|
1278
|
+
host
|
|
1279
|
+
[string]
|
|
1280
|
+
<em>(required)</em>
|
|
1281
|
+
</div>
|
|
1282
|
+
<div class="subschema">
|
|
1283
|
+
|
|
1284
|
+
<div class="description">
|
|
1285
|
+
The hostname of the remote object to wrap.
|
|
1286
|
+
</div>
|
|
1287
|
+
|
|
1288
|
+
|
|
1289
|
+
|
|
1290
|
+
|
|
1291
|
+
|
|
1292
|
+
|
|
1293
|
+
|
|
1294
|
+
|
|
1295
|
+
</div>
|
|
1296
|
+
<div class="subschema-name">
|
|
1297
|
+
name
|
|
1298
|
+
[string]
|
|
1299
|
+
<em>(required)</em>
|
|
1300
|
+
</div>
|
|
1301
|
+
<div class="subschema">
|
|
1302
|
+
|
|
1303
|
+
<div class="description">
|
|
1304
|
+
The name of the remote object to wrap, as registered on the remote host.
|
|
1305
|
+
</div>
|
|
1306
|
+
|
|
1307
|
+
|
|
1308
|
+
|
|
1309
|
+
|
|
1310
|
+
|
|
1311
|
+
|
|
1312
|
+
|
|
1313
|
+
|
|
1314
|
+
</div>
|
|
1315
|
+
<div class="subschema-name">
|
|
1316
|
+
path
|
|
1317
|
+
[string]
|
|
1318
|
+
|
|
1319
|
+
</div>
|
|
1320
|
+
<div class="subschema">
|
|
1321
|
+
|
|
1322
|
+
<div class="description">
|
|
1323
|
+
The web path to the XMLRPC service on the host. This defaults to the root of the web document tree "/".
|
|
1324
|
+
</div>
|
|
1325
|
+
|
|
1326
|
+
|
|
1327
|
+
|
|
1328
|
+
|
|
1329
|
+
|
|
1330
|
+
|
|
1331
|
+
|
|
1332
|
+
|
|
1333
|
+
</div>
|
|
1334
|
+
<div class="subschema-name">
|
|
1335
|
+
port
|
|
1336
|
+
[any]
|
|
1337
|
+
|
|
1338
|
+
</div>
|
|
1339
|
+
<div class="subschema">
|
|
1340
|
+
|
|
1341
|
+
<div class="description">
|
|
1342
|
+
The port of the remote object to wrap. This defaults to port 8080.
|
|
1343
|
+
</div>
|
|
1344
|
+
|
|
1345
|
+
|
|
1346
|
+
|
|
1347
|
+
|
|
1348
|
+
|
|
1349
|
+
|
|
1350
|
+
|
|
1351
|
+
|
|
1352
|
+
</div>
|
|
1353
|
+
</div>
|
|
1354
|
+
|
|
1355
|
+
|
|
1356
|
+
</div>
|
|
1357
|
+
|
|
1358
|
+
|
|
1359
|
+
|
|
1360
|
+
|
|
1361
|
+
|
|
1362
|
+
|
|
1363
|
+
</div>
|
|
1364
|
+
|
|
1365
|
+
|
|
1366
|
+
|
|
1367
|
+
|
|
1368
|
+
<!-- CONFIGURATION POINTS -->
|
|
1369
|
+
|
|
1370
|
+
|
|
1371
|
+
<h2>Configuration Points</h2>
|
|
1372
|
+
|
|
1373
|
+
|
|
1374
|
+
<h3><a name="DefaultDRbServerConfiguration_cp">DefaultDRbServerConfiguration</a> <small><em>(map)</em></small></h3>
|
|
1375
|
+
|
|
1376
|
+
<div class="item-body">
|
|
1377
|
+
|
|
1378
|
+
|
|
1379
|
+
<p class="description">
|
|
1380
|
+
This configuration point is used to configure the DefaultDRbServer service.
|
|
1381
|
+
</p>
|
|
1382
|
+
|
|
1383
|
+
|
|
1384
|
+
|
|
1385
|
+
<h4>Schema</h4>
|
|
1386
|
+
<div class="definition-item">
|
|
1387
|
+
<a href="copland.remote.html#DRbServerConfiguration_scm">copland.remote.DRbServerConfiguration</a>
|
|
1388
|
+
</div>
|
|
1389
|
+
|
|
1390
|
+
|
|
1391
|
+
</div>
|
|
1392
|
+
|
|
1393
|
+
|
|
1394
|
+
<h3><a name="DefaultDRbServerExport_cp">DefaultDRbServerExport</a> <small><em>(map)</em></small></h3>
|
|
1395
|
+
|
|
1396
|
+
<div class="item-body">
|
|
1397
|
+
|
|
1398
|
+
|
|
1399
|
+
<p class="description">
|
|
1400
|
+
This configuration defines the service that will be exported by the DefaultDRbServer service.
|
|
1401
|
+
</p>
|
|
1402
|
+
|
|
1403
|
+
|
|
1404
|
+
|
|
1405
|
+
<h4>Schema</h4>
|
|
1406
|
+
<div class="definition-item">
|
|
1407
|
+
<a href="copland.remote.html#DRbServerExport_scm">copland.remote.DRbServerExport</a>
|
|
1408
|
+
</div>
|
|
1409
|
+
|
|
1410
|
+
|
|
1411
|
+
</div>
|
|
1412
|
+
|
|
1413
|
+
|
|
1414
|
+
<h3><a name="DefaultSOAPServerConfiguration_cp">DefaultSOAPServerConfiguration</a> <small><em>(map)</em></small></h3>
|
|
1415
|
+
|
|
1416
|
+
<div class="item-body">
|
|
1417
|
+
|
|
1418
|
+
|
|
1419
|
+
<p class="description">
|
|
1420
|
+
This configuration point is used to configure the DefaultSOAPServer service.
|
|
1421
|
+
</p>
|
|
1422
|
+
|
|
1423
|
+
|
|
1424
|
+
|
|
1425
|
+
<h4>Schema</h4>
|
|
1426
|
+
<div class="definition-item">
|
|
1427
|
+
<a href="copland.remote.html#SOAPServerConfiguration_scm">copland.remote.SOAPServerConfiguration</a>
|
|
1428
|
+
</div>
|
|
1429
|
+
|
|
1430
|
+
|
|
1431
|
+
</div>
|
|
1432
|
+
|
|
1433
|
+
|
|
1434
|
+
<h3><a name="DefaultSOAPServices_cp">DefaultSOAPServices</a> <small><em>(list)</em></small></h3>
|
|
1435
|
+
|
|
1436
|
+
<div class="item-body">
|
|
1437
|
+
|
|
1438
|
+
|
|
1439
|
+
<p class="description">
|
|
1440
|
+
This configuration point is used to configure the DefaultSOAPServer service.
|
|
1441
|
+
</p>
|
|
1442
|
+
|
|
1443
|
+
|
|
1444
|
+
|
|
1445
|
+
<h4>Schema</h4>
|
|
1446
|
+
<div class="definition-item">
|
|
1447
|
+
<a href="copland.remote.html#SOAPServices_scm">copland.remote.SOAPServices</a>
|
|
1448
|
+
</div>
|
|
1449
|
+
|
|
1450
|
+
|
|
1451
|
+
</div>
|
|
1452
|
+
|
|
1453
|
+
|
|
1454
|
+
<h3><a name="DefaultXMLRPCServerConfiguration_cp">DefaultXMLRPCServerConfiguration</a> <small><em>(map)</em></small></h3>
|
|
1455
|
+
|
|
1456
|
+
<div class="item-body">
|
|
1457
|
+
|
|
1458
|
+
|
|
1459
|
+
<p class="description">
|
|
1460
|
+
This configuration point is used to configure the XMLRPCServer service. The value server.host defaults to 'localhost', and server.port defaults to 8080.
|
|
1461
|
+
</p>
|
|
1462
|
+
|
|
1463
|
+
|
|
1464
|
+
|
|
1465
|
+
<h4>Schema</h4>
|
|
1466
|
+
<div class="definition-item">
|
|
1467
|
+
<a href="copland.remote.html#XMLRPCServerConfiguration_scm">copland.remote.XMLRPCServerConfiguration</a>
|
|
1468
|
+
</div>
|
|
1469
|
+
|
|
1470
|
+
|
|
1471
|
+
</div>
|
|
1472
|
+
|
|
1473
|
+
|
|
1474
|
+
<h3><a name="DefaultXMLRPCServices_cp">DefaultXMLRPCServices</a> <small><em>(list)</em></small></h3>
|
|
1475
|
+
|
|
1476
|
+
<div class="item-body">
|
|
1477
|
+
|
|
1478
|
+
|
|
1479
|
+
<p class="description">
|
|
1480
|
+
Each contribution to this configuration point should define the XMLRPC interface for a single service.
|
|
1481
|
+
</p>
|
|
1482
|
+
|
|
1483
|
+
|
|
1484
|
+
|
|
1485
|
+
<h4>Schema</h4>
|
|
1486
|
+
<div class="definition-item">
|
|
1487
|
+
<a href="copland.remote.html#XMLRPCServices_scm">copland.remote.XMLRPCServices</a>
|
|
1488
|
+
</div>
|
|
1489
|
+
|
|
1490
|
+
|
|
1491
|
+
</div>
|
|
1492
|
+
|
|
1493
|
+
|
|
1494
|
+
|
|
1495
|
+
|
|
1496
|
+
<!-- SCHEMAS -->
|
|
1497
|
+
|
|
1498
|
+
|
|
1499
|
+
<h2>Schemas</h2>
|
|
1500
|
+
|
|
1501
|
+
|
|
1502
|
+
<h3><a name="DRbServerConfiguration_scm">DRbServerConfiguration</a></h3>
|
|
1503
|
+
|
|
1504
|
+
|
|
1505
|
+
|
|
1506
|
+
<div class="item-body">
|
|
1507
|
+
<div class="definition-item">
|
|
1508
|
+
|
|
1509
|
+
|
|
1510
|
+
|
|
1511
|
+
|
|
1512
|
+
|
|
1513
|
+
|
|
1514
|
+
|
|
1515
|
+
<div class="schema-item">
|
|
1516
|
+
|
|
1517
|
+
<div class="subschema-name">
|
|
1518
|
+
server.auto.start
|
|
1519
|
+
[boolean]
|
|
1520
|
+
|
|
1521
|
+
</div>
|
|
1522
|
+
<div class="subschema">
|
|
1523
|
+
|
|
1524
|
+
<div class="description">
|
|
1525
|
+
Whether or not the server should be started when the service is instantiated. If false, then the application must start the service manually.
|
|
1526
|
+
</div>
|
|
1527
|
+
|
|
1528
|
+
|
|
1529
|
+
|
|
1530
|
+
|
|
1531
|
+
|
|
1532
|
+
|
|
1533
|
+
|
|
1534
|
+
|
|
1535
|
+
</div>
|
|
1536
|
+
<div class="subschema-name">
|
|
1537
|
+
server.bind.address
|
|
1538
|
+
[string]
|
|
1539
|
+
|
|
1540
|
+
</div>
|
|
1541
|
+
<div class="subschema">
|
|
1542
|
+
|
|
1543
|
+
<div class="description">
|
|
1544
|
+
The address that the server should bind to. This defaults to "127.0.0.1", which means that (by default) the server will not accept connections from other machines.
|
|
1545
|
+
</div>
|
|
1546
|
+
|
|
1547
|
+
|
|
1548
|
+
|
|
1549
|
+
|
|
1550
|
+
|
|
1551
|
+
|
|
1552
|
+
|
|
1553
|
+
|
|
1554
|
+
</div>
|
|
1555
|
+
<div class="subschema-name">
|
|
1556
|
+
server.port
|
|
1557
|
+
[integer]
|
|
1558
|
+
|
|
1559
|
+
</div>
|
|
1560
|
+
<div class="subschema">
|
|
1561
|
+
|
|
1562
|
+
<div class="description">
|
|
1563
|
+
The port that the server will listen on.
|
|
1564
|
+
</div>
|
|
1565
|
+
|
|
1566
|
+
|
|
1567
|
+
|
|
1568
|
+
|
|
1569
|
+
|
|
1570
|
+
|
|
1571
|
+
|
|
1572
|
+
|
|
1573
|
+
</div>
|
|
1574
|
+
<div class="subschema-name">
|
|
1575
|
+
server.use-log
|
|
1576
|
+
[boolean]
|
|
1577
|
+
|
|
1578
|
+
</div>
|
|
1579
|
+
<div class="subschema">
|
|
1580
|
+
|
|
1581
|
+
<div class="description">
|
|
1582
|
+
Whether or not a log should be created for the new service. Default to false.
|
|
1583
|
+
</div>
|
|
1584
|
+
|
|
1585
|
+
|
|
1586
|
+
|
|
1587
|
+
|
|
1588
|
+
|
|
1589
|
+
|
|
1590
|
+
|
|
1591
|
+
|
|
1592
|
+
</div>
|
|
1593
|
+
</div>
|
|
1594
|
+
|
|
1595
|
+
|
|
1596
|
+
</div>
|
|
1597
|
+
</div>
|
|
1598
|
+
|
|
1599
|
+
<h3><a name="DRbServerExport_scm">DRbServerExport</a></h3>
|
|
1600
|
+
|
|
1601
|
+
|
|
1602
|
+
|
|
1603
|
+
<div class="item-body">
|
|
1604
|
+
<div class="definition-item">
|
|
1605
|
+
|
|
1606
|
+
|
|
1607
|
+
|
|
1608
|
+
|
|
1609
|
+
|
|
1610
|
+
|
|
1611
|
+
|
|
1612
|
+
<div class="schema-item">
|
|
1613
|
+
|
|
1614
|
+
<div class="subschema-name">
|
|
1615
|
+
service
|
|
1616
|
+
[service]
|
|
1617
|
+
<em>(required)</em>
|
|
1618
|
+
</div>
|
|
1619
|
+
<div class="subschema">
|
|
1620
|
+
|
|
1621
|
+
<div class="description">
|
|
1622
|
+
A reference tot he service to export.
|
|
1623
|
+
</div>
|
|
1624
|
+
|
|
1625
|
+
|
|
1626
|
+
|
|
1627
|
+
|
|
1628
|
+
|
|
1629
|
+
|
|
1630
|
+
|
|
1631
|
+
|
|
1632
|
+
</div>
|
|
1633
|
+
<div class="subschema-name">
|
|
1634
|
+
methods
|
|
1635
|
+
[array]
|
|
1636
|
+
|
|
1637
|
+
</div>
|
|
1638
|
+
<div class="subschema">
|
|
1639
|
+
|
|
1640
|
+
<div class="description">
|
|
1641
|
+
A list of the methods to export. It may be a list of strings or hashes, or a combination of the two. Where an element is a string, it is the name of the method to export. Where it is a hash, it must contain a "name" key (defining the name of the method to export), and may contain an "alias" key (defining the name by which the method ought to be exported).
|
|
1642
|
+
</div>
|
|
1643
|
+
|
|
1644
|
+
|
|
1645
|
+
|
|
1646
|
+
|
|
1647
|
+
|
|
1648
|
+
|
|
1649
|
+
|
|
1650
|
+
|
|
1651
|
+
</div>
|
|
1652
|
+
</div>
|
|
1653
|
+
|
|
1654
|
+
|
|
1655
|
+
</div>
|
|
1656
|
+
</div>
|
|
1657
|
+
|
|
1658
|
+
<h3><a name="SOAPServerConfiguration_scm">SOAPServerConfiguration</a></h3>
|
|
1659
|
+
|
|
1660
|
+
|
|
1661
|
+
|
|
1662
|
+
<div class="item-body">
|
|
1663
|
+
<div class="definition-item">
|
|
1664
|
+
|
|
1665
|
+
|
|
1666
|
+
|
|
1667
|
+
|
|
1668
|
+
|
|
1669
|
+
|
|
1670
|
+
|
|
1671
|
+
<div class="schema-item">
|
|
1672
|
+
|
|
1673
|
+
<div class="subschema-name">
|
|
1674
|
+
server.auto.start
|
|
1675
|
+
[boolean]
|
|
1676
|
+
|
|
1677
|
+
</div>
|
|
1678
|
+
<div class="subschema">
|
|
1679
|
+
|
|
1680
|
+
<div class="description">
|
|
1681
|
+
Whether the server should start as soon as the service is instantiated.
|
|
1682
|
+
</div>
|
|
1683
|
+
|
|
1684
|
+
|
|
1685
|
+
|
|
1686
|
+
|
|
1687
|
+
|
|
1688
|
+
|
|
1689
|
+
|
|
1690
|
+
|
|
1691
|
+
</div>
|
|
1692
|
+
<div class="subschema-name">
|
|
1693
|
+
server.bind.address
|
|
1694
|
+
[string]
|
|
1695
|
+
|
|
1696
|
+
</div>
|
|
1697
|
+
<div class="subschema">
|
|
1698
|
+
|
|
1699
|
+
<div class="description">
|
|
1700
|
+
The address that the server should bind to.
|
|
1701
|
+
</div>
|
|
1702
|
+
|
|
1703
|
+
|
|
1704
|
+
|
|
1705
|
+
|
|
1706
|
+
|
|
1707
|
+
|
|
1708
|
+
|
|
1709
|
+
|
|
1710
|
+
</div>
|
|
1711
|
+
<div class="subschema-name">
|
|
1712
|
+
server.port
|
|
1713
|
+
[integer]
|
|
1714
|
+
|
|
1715
|
+
</div>
|
|
1716
|
+
<div class="subschema">
|
|
1717
|
+
|
|
1718
|
+
<div class="description">
|
|
1719
|
+
The port that the server will listen on.
|
|
1720
|
+
</div>
|
|
1721
|
+
|
|
1722
|
+
|
|
1723
|
+
|
|
1724
|
+
|
|
1725
|
+
|
|
1726
|
+
|
|
1727
|
+
|
|
1728
|
+
|
|
1729
|
+
</div>
|
|
1730
|
+
<div class="subschema-name">
|
|
1731
|
+
server.use-log
|
|
1732
|
+
[boolean]
|
|
1733
|
+
|
|
1734
|
+
</div>
|
|
1735
|
+
<div class="subschema">
|
|
1736
|
+
|
|
1737
|
+
<div class="description">
|
|
1738
|
+
Whether or not a log should be created for the new service.
|
|
1739
|
+
</div>
|
|
1740
|
+
|
|
1741
|
+
|
|
1742
|
+
|
|
1743
|
+
|
|
1744
|
+
|
|
1745
|
+
|
|
1746
|
+
|
|
1747
|
+
|
|
1748
|
+
</div>
|
|
1749
|
+
</div>
|
|
1750
|
+
|
|
1751
|
+
|
|
1752
|
+
</div>
|
|
1753
|
+
</div>
|
|
1754
|
+
|
|
1755
|
+
<h3><a name="SOAPServices_scm">SOAPServices</a></h3>
|
|
1756
|
+
|
|
1757
|
+
|
|
1758
|
+
|
|
1759
|
+
<div class="item-body">
|
|
1760
|
+
<div class="definition-item">
|
|
1761
|
+
|
|
1762
|
+
|
|
1763
|
+
|
|
1764
|
+
|
|
1765
|
+
|
|
1766
|
+
|
|
1767
|
+
|
|
1768
|
+
<div class="schema-item">
|
|
1769
|
+
|
|
1770
|
+
<div class="subschema-name">
|
|
1771
|
+
namespace
|
|
1772
|
+
[string]
|
|
1773
|
+
<em>(required)</em>
|
|
1774
|
+
</div>
|
|
1775
|
+
<div class="subschema">
|
|
1776
|
+
|
|
1777
|
+
<div class="description">
|
|
1778
|
+
The name by which remote clients should request this service.
|
|
1779
|
+
</div>
|
|
1780
|
+
|
|
1781
|
+
|
|
1782
|
+
|
|
1783
|
+
|
|
1784
|
+
|
|
1785
|
+
|
|
1786
|
+
|
|
1787
|
+
|
|
1788
|
+
</div>
|
|
1789
|
+
<div class="subschema-name">
|
|
1790
|
+
service
|
|
1791
|
+
[service]
|
|
1792
|
+
<em>(required)</em>
|
|
1793
|
+
</div>
|
|
1794
|
+
<div class="subschema">
|
|
1795
|
+
|
|
1796
|
+
<div class="description">
|
|
1797
|
+
The service to export.
|
|
1798
|
+
</div>
|
|
1799
|
+
|
|
1800
|
+
|
|
1801
|
+
|
|
1802
|
+
|
|
1803
|
+
|
|
1804
|
+
|
|
1805
|
+
|
|
1806
|
+
|
|
1807
|
+
</div>
|
|
1808
|
+
<div class="subschema-name">
|
|
1809
|
+
methods
|
|
1810
|
+
[array]
|
|
1811
|
+
|
|
1812
|
+
</div>
|
|
1813
|
+
<div class="subschema">
|
|
1814
|
+
|
|
1815
|
+
<div class="description">
|
|
1816
|
+
The list of methods that should be exported by this service. Each element of the list ought to be either a string (naming a method), or a hash. The hash must have at least the "name" key (to identify the method to export), and may optionally have an "alias" key (to identify the name by which the method should be exported).
|
|
1817
|
+
</div>
|
|
1818
|
+
|
|
1819
|
+
|
|
1820
|
+
|
|
1821
|
+
|
|
1822
|
+
|
|
1823
|
+
|
|
1824
|
+
|
|
1825
|
+
|
|
1826
|
+
</div>
|
|
1827
|
+
</div>
|
|
1828
|
+
|
|
1829
|
+
|
|
1830
|
+
</div>
|
|
1831
|
+
</div>
|
|
1832
|
+
|
|
1833
|
+
<h3><a name="XMLRPCServerConfiguration_scm">XMLRPCServerConfiguration</a></h3>
|
|
1834
|
+
|
|
1835
|
+
|
|
1836
|
+
|
|
1837
|
+
<div class="item-body">
|
|
1838
|
+
<div class="definition-item">
|
|
1839
|
+
|
|
1840
|
+
|
|
1841
|
+
|
|
1842
|
+
|
|
1843
|
+
|
|
1844
|
+
|
|
1845
|
+
|
|
1846
|
+
<div class="schema-item">
|
|
1847
|
+
|
|
1848
|
+
<div class="subschema-name">
|
|
1849
|
+
max.connections
|
|
1850
|
+
[integer]
|
|
1851
|
+
|
|
1852
|
+
</div>
|
|
1853
|
+
<div class="subschema">
|
|
1854
|
+
|
|
1855
|
+
<div class="description">
|
|
1856
|
+
The maximum number of concurrent connections.
|
|
1857
|
+
</div>
|
|
1858
|
+
|
|
1859
|
+
|
|
1860
|
+
|
|
1861
|
+
|
|
1862
|
+
|
|
1863
|
+
|
|
1864
|
+
|
|
1865
|
+
|
|
1866
|
+
</div>
|
|
1867
|
+
<div class="subschema-name">
|
|
1868
|
+
server.auto.start
|
|
1869
|
+
[boolean]
|
|
1870
|
+
|
|
1871
|
+
</div>
|
|
1872
|
+
<div class="subschema">
|
|
1873
|
+
|
|
1874
|
+
<div class="description">
|
|
1875
|
+
Whether or not the server should start as soon as the service is instantiated.
|
|
1876
|
+
</div>
|
|
1877
|
+
|
|
1878
|
+
|
|
1879
|
+
|
|
1880
|
+
|
|
1881
|
+
|
|
1882
|
+
|
|
1883
|
+
|
|
1884
|
+
|
|
1885
|
+
</div>
|
|
1886
|
+
<div class="subschema-name">
|
|
1887
|
+
server.bind.address
|
|
1888
|
+
[string]
|
|
1889
|
+
|
|
1890
|
+
</div>
|
|
1891
|
+
<div class="subschema">
|
|
1892
|
+
|
|
1893
|
+
<div class="description">
|
|
1894
|
+
The address that the server should bind to.
|
|
1895
|
+
</div>
|
|
1896
|
+
|
|
1897
|
+
|
|
1898
|
+
|
|
1899
|
+
|
|
1900
|
+
|
|
1901
|
+
|
|
1902
|
+
|
|
1903
|
+
|
|
1904
|
+
</div>
|
|
1905
|
+
<div class="subschema-name">
|
|
1906
|
+
server.port
|
|
1907
|
+
[integer]
|
|
1908
|
+
|
|
1909
|
+
</div>
|
|
1910
|
+
<div class="subschema">
|
|
1911
|
+
|
|
1912
|
+
<div class="description">
|
|
1913
|
+
The port that the server should listen on.
|
|
1914
|
+
</div>
|
|
1915
|
+
|
|
1916
|
+
|
|
1917
|
+
|
|
1918
|
+
|
|
1919
|
+
|
|
1920
|
+
|
|
1921
|
+
|
|
1922
|
+
|
|
1923
|
+
</div>
|
|
1924
|
+
<div class="subschema-name">
|
|
1925
|
+
server.use-log
|
|
1926
|
+
[boolean]
|
|
1927
|
+
|
|
1928
|
+
</div>
|
|
1929
|
+
<div class="subschema">
|
|
1930
|
+
|
|
1931
|
+
<div class="description">
|
|
1932
|
+
Whether or not a new log should be created for each service.
|
|
1933
|
+
</div>
|
|
1934
|
+
|
|
1935
|
+
|
|
1936
|
+
|
|
1937
|
+
|
|
1938
|
+
|
|
1939
|
+
|
|
1940
|
+
|
|
1941
|
+
|
|
1942
|
+
</div>
|
|
1943
|
+
</div>
|
|
1944
|
+
|
|
1945
|
+
|
|
1946
|
+
</div>
|
|
1947
|
+
</div>
|
|
1948
|
+
|
|
1949
|
+
<h3><a name="XMLRPCServices_scm">XMLRPCServices</a></h3>
|
|
1950
|
+
|
|
1951
|
+
|
|
1952
|
+
|
|
1953
|
+
<div class="item-body">
|
|
1954
|
+
<div class="definition-item">
|
|
1955
|
+
|
|
1956
|
+
|
|
1957
|
+
|
|
1958
|
+
|
|
1959
|
+
|
|
1960
|
+
|
|
1961
|
+
|
|
1962
|
+
<div class="schema-item">
|
|
1963
|
+
|
|
1964
|
+
<div class="subschema-name">
|
|
1965
|
+
prefix
|
|
1966
|
+
[string]
|
|
1967
|
+
<em>(required)</em>
|
|
1968
|
+
</div>
|
|
1969
|
+
<div class="subschema">
|
|
1970
|
+
|
|
1971
|
+
<div class="description">
|
|
1972
|
+
The name by which remote clients should request this service.
|
|
1973
|
+
</div>
|
|
1974
|
+
|
|
1975
|
+
|
|
1976
|
+
|
|
1977
|
+
|
|
1978
|
+
|
|
1979
|
+
|
|
1980
|
+
|
|
1981
|
+
|
|
1982
|
+
</div>
|
|
1983
|
+
<div class="subschema-name">
|
|
1984
|
+
service
|
|
1985
|
+
[service]
|
|
1986
|
+
<em>(required)</em>
|
|
1987
|
+
</div>
|
|
1988
|
+
<div class="subschema">
|
|
1989
|
+
|
|
1990
|
+
<div class="description">
|
|
1991
|
+
The service to export.
|
|
1992
|
+
</div>
|
|
1993
|
+
|
|
1994
|
+
|
|
1995
|
+
|
|
1996
|
+
|
|
1997
|
+
|
|
1998
|
+
|
|
1999
|
+
|
|
2000
|
+
|
|
2001
|
+
</div>
|
|
2002
|
+
<div class="subschema-name">
|
|
2003
|
+
interface
|
|
2004
|
+
[array]
|
|
2005
|
+
|
|
2006
|
+
</div>
|
|
2007
|
+
<div class="subschema">
|
|
2008
|
+
|
|
2009
|
+
<div class="description">
|
|
2010
|
+
An array of maps that describe the methods that this service should export.
|
|
2011
|
+
</div>
|
|
2012
|
+
|
|
2013
|
+
|
|
2014
|
+
|
|
2015
|
+
|
|
2016
|
+
|
|
2017
|
+
|
|
2018
|
+
|
|
2019
|
+
<div class="schema-item">
|
|
2020
|
+
|
|
2021
|
+
<div class="subschema-name">
|
|
2022
|
+
signature
|
|
2023
|
+
[string]
|
|
2024
|
+
<em>(required)</em>
|
|
2025
|
+
</div>
|
|
2026
|
+
<div class="subschema">
|
|
2027
|
+
|
|
2028
|
+
<div class="description">
|
|
2029
|
+
A valid XMLRPC signature for the method. This is the name by which the method will be invoked.
|
|
2030
|
+
</div>
|
|
2031
|
+
|
|
2032
|
+
|
|
2033
|
+
|
|
2034
|
+
|
|
2035
|
+
|
|
2036
|
+
|
|
2037
|
+
|
|
2038
|
+
|
|
2039
|
+
</div>
|
|
2040
|
+
<div class="subschema-name">
|
|
2041
|
+
help
|
|
2042
|
+
[string]
|
|
2043
|
+
|
|
2044
|
+
</div>
|
|
2045
|
+
<div class="subschema">
|
|
2046
|
+
|
|
2047
|
+
<div class="description">
|
|
2048
|
+
This is just arbitrary text that describes this method and what it does. It is useful for XMLRPC clients to query, to know what an interface is capable of.
|
|
2049
|
+
</div>
|
|
2050
|
+
|
|
2051
|
+
|
|
2052
|
+
|
|
2053
|
+
|
|
2054
|
+
|
|
2055
|
+
|
|
2056
|
+
|
|
2057
|
+
|
|
2058
|
+
</div>
|
|
2059
|
+
<div class="subschema-name">
|
|
2060
|
+
method
|
|
2061
|
+
[string]
|
|
2062
|
+
|
|
2063
|
+
</div>
|
|
2064
|
+
<div class="subschema">
|
|
2065
|
+
|
|
2066
|
+
<div class="description">
|
|
2067
|
+
This is the actual method name (as declared in the service), if it differs from the name given in the signature. This allows for aliasing of method names.
|
|
2068
|
+
</div>
|
|
2069
|
+
|
|
2070
|
+
|
|
2071
|
+
|
|
2072
|
+
|
|
2073
|
+
|
|
2074
|
+
|
|
2075
|
+
|
|
2076
|
+
|
|
2077
|
+
</div>
|
|
2078
|
+
</div>
|
|
2079
|
+
|
|
2080
|
+
|
|
2081
|
+
</div>
|
|
2082
|
+
</div>
|
|
2083
|
+
|
|
2084
|
+
|
|
2085
|
+
</div>
|
|
2086
|
+
</div>
|
|
2087
|
+
|
|
2088
|
+
|
|
2089
|
+
<div class="generated-by">
|
|
2090
|
+
Generated by
|
|
2091
|
+
<a href="http://copland.rubyforge.org">Copland</a>'s
|
|
2092
|
+
Packrat documentation extractor
|
|
2093
|
+
on Sun Sep 26 21:37:13 MDT 2004
|
|
2094
|
+
</div>
|
|
2095
|
+
</body>
|
|
2096
|
+
</html>
|