Ice._RouterOperations Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ice-compat Show documentation

Ice is a comprehensive RPC framework that helps you build distributed applications with minimal effort using familiar object-oriented idioms

There is a newer version: 3.7.10

Show newest version

// **********************************************************************
//
// Copyright (c) 2003-2018 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.
//
// **********************************************************************
//
// Ice version 3.7.1
//
// 
//
// Generated from file `Router.ice'
//
// Warning: do not edit this file.
//
// 
//

package Ice;

/**
 * The Ice router interface. Routers can be set either globally with
 * {@link Communicator#setDefaultRouter}, or with ice_router on specific
 * proxies.
 *
 **/
public interface _RouterOperations
{
    /**
     * 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.
     *
     * @param current The Current object for the invocation.
     * @return The router's client proxy.
     *
     **/
    Ice.ObjectPrx getClientProxy(Ice.BooleanHolder hasRoutingTable, Current current);

    /**
     * Get the router's server proxy, i.e., the proxy to use for
     * forwarding requests from the server to the router.
     *
     * @param current The Current object for the invocation.
     * @return The router's server proxy.
     *
     **/
    Ice.ObjectPrx getServerProxy(Current current);

    /**
     * Add new proxy information to the router's routing table.
     *
     * @param proxies The proxies to add.
     *
     * @param current The Current object for the invocation.
     * @return Proxies discarded by the router.
     *
     **/
    Ice.ObjectPrx[] addProxies(Ice.ObjectPrx[] proxies, Current current);
}