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
|
// **********************************************************************
//
// Copyright (c) 2003-2017 ZeroC, Inc. All rights reserved.
//
// This copy of Ice is licensed to you under the terms described in the
// ICE_LICENSE file included in this distribution.
//
// **********************************************************************
#pragma once
[["ice-prefix", "cpp:header-ext:h", "cpp:dll-export:ICE_API", "objc:header-dir:objc", "objc:dll-export:ICE_API", "js:ice-build", "python:pkgdir:Ice"]]
#include <Ice/BuiltinSequences.ice>
#ifndef __SLICE2JAVA_COMPAT__
[["java:package:com.zeroc"]]
#endif
["objc:prefix:ICE"]
module Ice
{
/**
*
* The Ice router interface. Routers can be set either globally with
* {@link Communicator#setDefaultRouter}, or with <tt>ice_router</tt> on specific
* proxies.
*
**/
interface Router
{
/**
*
* Get the router's client proxy, i.e., the proxy to use for
* forwarding requests from the client to the router.
*
* If a null proxy is returned, the client will forward requests
* to the router's endpoints.
*
* @param hasRoutingTable Indicates whether or not the router supports a routing
* table. If it is supported, the Ice runtime will call addProxies to populate the
* routing table. This out parameter is only supported starting with Ice 3.7.
* The Ice runtime assumes the router has a routing table if the optional is not
* set.
*
* @return The router's client proxy.
*
**/
["nonmutating", "cpp:const"] idempotent Object* getClientProxy(out optional(1) bool hasRoutingTable);
/**
*
* Get the router's server proxy, i.e., the proxy to use for
* forwarding requests from the server to the router.
*
* @return The router's server proxy.
*
**/
["nonmutating", "cpp:const"] idempotent Object* getServerProxy();
/**
*
* Add new proxy information to the router's routing table.
*
* @param proxies The proxies to add.
*
* @return Proxies discarded by the router.
*
**/
idempotent ObjectProxySeq addProxies(ObjectProxySeq proxies);
}
/**
*
* This inferface should be implemented by services implementing the
* Ice::Router interface. It should be advertised through an Ice
* object with the identity `Ice/RouterFinder'. This allows clients to
* retrieve the router proxy with just the endpoint information of the
* service.
*
**/
interface RouterFinder
{
/**
*
* Get the router proxy implemented by the process hosting this
* finder object. The proxy might point to several replicas.
*
* @return The router proxy.
*
**/
Router* getRouter();
}
}
|
