The Ice router interface. More...
defined in <Ice/Router.ice>
interface Router { ... }
Inheritance diagram for Ice::Router:
Operations | |
| idempotent ObjectProxySeq | addProxies (ObjectProxySeq proxies) |
| Add new proxy information to the router's routing table. More... | |
| idempotent Object * | getClientProxy (out optional(1) bool hasRoutingTable) |
| Get the router's client proxy, i.e., the proxy to use for forwarding requests from the client to the router. More... | |
| idempotent Object * | getServerProxy () |
| Get the router's server proxy, i.e., the proxy to use for forwarding requests from the server to the router. More... | |
Detailed Description
The Ice router interface.
Routers can be set either globally with Communicator#setDefaultRouter, or with ice_router on specific proxies.
Operation Documentation
◆ addProxies()
| idempotent ObjectProxySeq addProxies | ( | ObjectProxySeq | proxies | ) |
Add new proxy information to the router's routing table.
- Parameters
-
proxies The proxies to add.
- Returns
- Proxies discarded by the router.
◆ getClientProxy()
["nonmutating","cpp:const"]
| idempotent Object* getClientProxy | ( | out optional(1) bool | hasRoutingTable | ) |
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.
- Parameters
-
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.
- Returns
- The router's client proxy.
◆ getServerProxy()
["nonmutating","cpp:const"]
| idempotent Object* getServerProxy | ( | ) |
Get the router's server proxy, i.e., the proxy to use for forwarding requests from the server to the router.
- Returns
- The router's server proxy.
The documentation for this interface was generated from the following file:
- Ice/Router.ice
