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
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/loose.dtd">
<HTML
><HEAD
><TITLE
>Proxies and Endpoints</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
REL="HOME"
TITLE="Ice Reference Documentation"
HREF="index.html"><LINK
REL="PREVIOUS"
TITLE="IcePatch2 Properties"
HREF="x21286.html"><LINK
REL="NEXT"
TITLE="Endpoints"
HREF="x21526.html"></HEAD
><BODY
CLASS="CHAPTER"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="NAVHEADER"
><TABLE
SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>Ice Reference Documentation</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="x21286.html"
ACCESSKEY="P"
><<< Previous</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="x21526.html"
ACCESSKEY="N"
>Next >>></A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><DIV
CLASS="CHAPTER"
><H1
><A
NAME="AEN21415"
></A
>Proxies and Endpoints</H1
><DIV
CLASS="SECTION"
><H1
CLASS="SECTION"
><A
NAME="AEN21417"
>Proxies</A
></H1
><DIV
CLASS="SECTION"
><H2
CLASS="SECTION"
><A
NAME="AEN21419"
>Synopsis</A
></H2
><P
> <TT
CLASS="REPLACEABLE"
><I
>identity</I
></TT
> [-f <TT
CLASS="REPLACEABLE"
><I
>facet</I
></TT
> | -t | -o | -O | -d | -D | -s] [ @ <TT
CLASS="REPLACEABLE"
><I
>adapter_id</I
></TT
> | : <TT
CLASS="REPLACEABLE"
><I
>endpoints</I
></TT
>]</P
></DIV
><DIV
CLASS="SECTION"
><H2
CLASS="SECTION"
><A
NAME="AEN21438"
>Description</A
></H2
><P
>A stringified proxy consists of an identity, proxy options, and an
optional object adapter identifier or endpoint list. White space
(the space, tab (<TT
CLASS="LITERAL"
>\t</TT
>), line feed (<TT
CLASS="LITERAL"
>\n</TT
>),
and carriage return (<TT
CLASS="LITERAL"
>\r</TT
>) characters) act as token
delimiters; if a white space character appears as part of a component
of a stringified proxy (such as the identity), it must be quoted or
escaped as described below.</P
><P
>A proxy containing
an identity with no endpoints, or an identity with an object adapter
identifier, represents an indirect proxy that will be resolved using the
<SPAN
CLASS="phrase"
><SPAN
CLASS="PHRASE"
>Ice</SPAN
></SPAN
> locator (see the <TT
CLASS="LITERAL"
>Ice.Default.Locator</TT
> property).</P
><P
>Proxy options configure the invocation mode:</P
><DIV
CLASS="INFORMALTABLE"
><P
></P
><A
NAME="AEN21448"
></A
><TABLE
BORDER="1"
BGCOLOR="#E0E0E0"
CELLSPACING="0"
CELLPADDING="4"
CLASS="CALSTABLE"
><TBODY
><TR
><TD
>-f <TT
CLASS="REPLACEABLE"
><I
>facet</I
></TT
></TD
><TD
>Select a facet of the Ice object.</TD
></TR
><TR
><TD
>-t</TD
><TD
>Configures the proxy for twoway invocations. (default)</TD
></TR
><TR
><TD
>-o</TD
><TD
>Configures the proxy for oneway invocations.</TD
></TR
><TR
><TD
>-O</TD
><TD
>Configures the proxy for batch oneway invocations.</TD
></TR
><TR
><TD
>-d</TD
><TD
>Configures the proxy for datagram invocations.</TD
></TR
><TR
><TD
>-D</TD
><TD
>Configures the proxy for batch datagram invocations.</TD
></TR
><TR
><TD
>-s</TD
><TD
>Configures the proxy for secure invocations.</TD
></TR
></TBODY
></TABLE
><P
></P
></DIV
><P
>The proxy options <TT
CLASS="LITERAL"
>-t</TT
>, <TT
CLASS="LITERAL"
>-o</TT
>,
<TT
CLASS="LITERAL"
>-O</TT
>, <TT
CLASS="LITERAL"
>-d</TT
>, and <TT
CLASS="LITERAL"
>-D</TT
>
are mutually exclusive.</P
><P
>The object identity <TT
CLASS="REPLACEABLE"
><I
>identity</I
></TT
> is structured
as <TT
CLASS="LITERAL"
>[<TT
CLASS="REPLACEABLE"
><I
>category</I
></TT
>/]<TT
CLASS="REPLACEABLE"
><I
>name</I
></TT
></TT
>, where the <TT
CLASS="REPLACEABLE"
><I
>category</I
></TT
>
component and slash separator are optional. If
<TT
CLASS="REPLACEABLE"
><I
>identity</I
></TT
> contains white space or either of the
characters <TT
CLASS="LITERAL"
>:</TT
> or <TT
CLASS="LITERAL"
>@</TT
>, it must be enclosed
in single or double quotes. The <TT
CLASS="REPLACEABLE"
><I
>category</I
></TT
> and
<TT
CLASS="REPLACEABLE"
><I
>name</I
></TT
> components are UTF-8 strings that use the
encoding described below. Any occurrence of a slash (<TT
CLASS="LITERAL"
>/</TT
>)
in <TT
CLASS="REPLACEABLE"
><I
>category</I
></TT
> or <TT
CLASS="REPLACEABLE"
><I
>name</I
></TT
>
must be escaped with a backslash (i.e., <TT
CLASS="LITERAL"
>\/</TT
>).</P
><P
>The <TT
CLASS="REPLACEABLE"
><I
>facet</I
></TT
> argument of the <TT
CLASS="LITERAL"
>-f</TT
>
option represents a facet name. If <TT
CLASS="REPLACEABLE"
><I
>facet</I
></TT
>
contains white space, it must be enclosed in single or double quotes. A
facet name is a UTF-8 string that uses the encoding described
below.</P
><P
>The object adapter identifier <TT
CLASS="REPLACEABLE"
><I
>adapter_id</I
></TT
>
is a UTF-8 string that uses the encoding described below. If
<TT
CLASS="REPLACEABLE"
><I
>adapter_id</I
></TT
> contains white space, it must
be enclosed in single or double quotes.</P
><P
>Single quotes can be used to prevent white space characters from being interpreted
as delimiters, and to escape the special meaning of the backslash (<TT
CLASS="LITERAL"
>\</TT
>)
character. Within single quotes, the only character that retains its special
meaning is the single quote itself; a backslash can be used to prevent interpretation
of a single quote as a closing quote, for example: <TT
CLASS="LITERAL"
>'a string with a \' quote'</TT
>.</P
><P
>Double quotes prevent interpretation of white space characters as delimiters and prevent
interpretation of a single quote as an opening or closing quote. For example:
<TT
CLASS="LITERAL"
>"a string with a ' quote"</TT
>. However, escape sequences such as <TT
CLASS="LITERAL"
>\b</TT
>
are interpreted within double quotes.</P
><P
>UTF-8 strings are encoded using ASCII characters for the ordinal
range 32-126 (inclusive). Characters outside this range must be encoded
using escape sequences (<TT
CLASS="LITERAL"
>\b</TT
>,
<TT
CLASS="LITERAL"
>\f</TT
>, <TT
CLASS="LITERAL"
>\n</TT
>, <TT
CLASS="LITERAL"
>\r</TT
>,
<TT
CLASS="LITERAL"
>\t</TT
>) or octal notation (e.g., <TT
CLASS="LITERAL"
>\007</TT
>).
A double quote can be escaped using a backslash, as can the backslash itself (<TT
CLASS="LITERAL"
>\\</TT
>).</P
><P
>If endpoints are specified, they must be separated with a colon
(<TT
CLASS="LITERAL"
>:</TT
>) and formatted as described in
<A
HREF="x21526.html"
><I
>Endpoints</I
></A
>. The order of
endpoints in the stringified proxy is not necessarily the order in
which connections are attempted during binding: when a stringified proxy is
converted into a proxy instance, the endpoint list is randomized as a form
of load balancing.</P
><P
>If the <TT
CLASS="LITERAL"
>-s</TT
> option is specified, only those endpoints that
support secure invocations are considered during binding. If no valid
endpoints are found, the application receives
<TT
CLASS="LITERAL"
>Ice::NoEndpointException</TT
>.</P
><P
>Otherwise, if the <TT
CLASS="LITERAL"
>-s</TT
> option is not specified, the endpoint
list is ordered so that non-secure endpoints have priority over secure
endpoints during binding. In other words, connections are attempted on all
non-secure endpoints before any secure endpoints are attempted.</P
><P
>If an unknown option is specified, or the stringified proxy is malformed,
the application receives <TT
CLASS="LITERAL"
>Ice::ProxyParseException</TT
>. If
an endpoint is malformed, the application receives
<TT
CLASS="LITERAL"
>Ice::EndpointParseException</TT
>.</P
></DIV
></DIV
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="x21286.html"
ACCESSKEY="P"
><<< Previous</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="index.html"
ACCESSKEY="H"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="x21526.html"
ACCESSKEY="N"
>Next >>></A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><SPAN
CLASS="phrase"
><SPAN
CLASS="PHRASE"
>IcePatch2</SPAN
></SPAN
> Properties</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
> </TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>Endpoints</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>
|
