Module com.zeroc.ice

Package com.zeroc.Ice

Interface RouterPrx

All Superinterfaces:

ObjectPrx

All Known Subinterfaces:

RouterPrx

public interface RouterPrx
extends ObjectPrx

Represents an intermediary object that routes requests and replies between clients and Ice objects that are not directly reachable from these clients.

Remarks: The Slice compiler generated this proxy interface from Slice interface ::Ice::Router.

Field Summary

Fields inherited from interface com.zeroc.Ice.ObjectPrx

ice_staticId, noExplicitContext

Method Summary

Modifier and Type	Method	Description
default ObjectPrx[]	addProxies(ObjectPrx[] proxies)	Adds new proxy information to the router's routing table.
default ObjectPrx[]	addProxies(ObjectPrx[] proxies, Map<String,String> context)	Adds new proxy information to the router's routing table.
default CompletableFuture<ObjectPrx[]>	addProxiesAsync(ObjectPrx[] proxies)	Adds new proxy information to the router's routing table.
default CompletableFuture<ObjectPrx[]>	addProxiesAsync(ObjectPrx[] proxies, Map<String,String> context)	Adds new proxy information to the router's routing table.
static RouterPrx	checkedCast(ObjectPrx obj)	Creates a new proxy from an existing proxy after confirming the target object's type via a remote invocation.
static RouterPrx	checkedCast(ObjectPrx obj, String facet)	Creates a new proxy from an existing proxy after confirming the target object's type via a remote invocation.
static RouterPrx	checkedCast(ObjectPrx obj, String facet, Map<String,String> context)	Creates a new proxy from an existing proxy after confirming the target object's type via a remote invocation.
static RouterPrx	checkedCast(ObjectPrx obj, Map<String,String> context)	Creates a new proxy from an existing proxy after confirming the target object's type via a remote invocation.
static RouterPrx	createProxy(Communicator communicator, String proxyString)	Creates a new proxy that implements RouterPrx.
default Router.GetClientProxyResult	getClientProxy()	Gets the router's client proxy, i.e.
default Router.GetClientProxyResult	getClientProxy(Map<String,String> context)	Gets the router's client proxy, i.e.
default CompletableFuture<Router.GetClientProxyResult>	getClientProxyAsync()	Gets the router's client proxy, i.e.
default CompletableFuture<Router.GetClientProxyResult>	getClientProxyAsync(Map<String,String> context)	Gets the router's client proxy, i.e.
default ObjectPrx	getServerProxy()	Gets the router's server proxy, i.e.
default ObjectPrx	getServerProxy(Map<String,String> context)	Gets the router's server proxy, i.e.
default CompletableFuture<ObjectPrx>	getServerProxyAsync()	Gets the router's server proxy, i.e.
default CompletableFuture<ObjectPrx>	getServerProxyAsync(Map<String,String> context)	Gets the router's server proxy, i.e.
RouterPrx	ice_adapterId(String newAdapterId)	Creates a proxy that is identical to this proxy, except for the adapter ID.
RouterPrx	ice_batchDatagram()	Creates a proxy that is identical to this proxy, but uses batch datagram invocations.
RouterPrx	ice_batchOneway()	Creates a proxy that is identical to this proxy, but uses batch oneway invocations.
RouterPrx	ice_collocationOptimized(boolean b)	Creates a proxy that is identical to this proxy, except for collocation optimization.
RouterPrx	ice_compress(boolean co)	Creates a proxy that is identical to this proxy, except for its compression setting which overrides the compression setting from the proxy endpoints.
RouterPrx	ice_connectionCached(boolean newCache)	Creates a proxy that is identical to this proxy, except for connection caching.
RouterPrx	ice_connectionId(String connectionId)	Creates a proxy that is identical to this proxy, except for its connection ID.
RouterPrx	ice_context(Map<String,String> newContext)	Creates a proxy that is identical to this proxy, except for the per-proxy context.
RouterPrx	ice_datagram()	Creates a proxy that is identical to this proxy, but uses datagram invocations.
RouterPrx	ice_encodingVersion(EncodingVersion e)	Creates a proxy that is identical to this proxy, except for the encoding used to marshal parameters.
RouterPrx	ice_endpoints(Endpoint[] newEndpoints)	Creates a proxy that is identical to this proxy, except for the endpoints.
RouterPrx	ice_endpointSelection(EndpointSelectionType newType)	Creates a proxy that is identical to this proxy, except for the endpoint selection policy.
RouterPrx	ice_fixed(Connection connection)	Creates a proxy that is identical to this proxy, except it's a fixed proxy bound to the given connection.
RouterPrx	ice_invocationTimeout(int newTimeout)	Creates a proxy that is identical to this proxy, except for the invocation timeout.
RouterPrx	ice_invocationTimeout(Duration newTimeout)	Creates a proxy that is identical to this proxy, except for the invocation timeout.
RouterPrx	ice_locator(LocatorPrx locator)	Creates a proxy that is identical to this proxy, except for the locator.
RouterPrx	ice_locatorCacheTimeout(int newTimeout)	Creates a proxy that is identical to this proxy, except for the locator cache timeout.
RouterPrx	ice_oneway()	Creates a proxy that is identical to this proxy, but uses oneway invocations.
RouterPrx	ice_router(RouterPrx router)	Creates a proxy that is identical to this proxy, except for the router.
static String	ice_staticId()	Gets the type ID of the associated Slice interface.
RouterPrx	ice_twoway()	Creates a proxy that is identical to this proxy, but uses twoway invocations.
static RouterPrx	uncheckedCast(ObjectPrx obj)	Creates a new proxy from an existing proxy.
static RouterPrx	uncheckedCast(ObjectPrx obj, String facet)	Creates a new proxy from an existing proxy.

Methods inherited from interface com.zeroc.Ice.ObjectPrx

equals, ice_executor, ice_facet, ice_flushBatchRequests, ice_flushBatchRequestsAsync, ice_getAdapterId, ice_getCachedConnection, ice_getCommunicator, ice_getCompress, ice_getConnection, ice_getConnectionAsync, ice_getConnectionId, ice_getContext, ice_getEncodingVersion, ice_getEndpoints, ice_getEndpointSelection, ice_getFacet, ice_getIdentity, ice_getInvocationTimeout, ice_getLocator, ice_getLocatorCacheTimeout, ice_getRouter, ice_id, ice_id, ice_idAsync, ice_idAsync, ice_identity, ice_ids, ice_ids, ice_idsAsync, ice_idsAsync, ice_invoke, ice_invoke, ice_invokeAsync, ice_invokeAsync, ice_isA, ice_isA, ice_isAAsync, ice_isAAsync, ice_isBatchDatagram, ice_isBatchOneway, ice_isCollocationOptimized, ice_isConnectionCached, ice_isDatagram, ice_isFixed, ice_isOneway, ice_isTwoway, ice_locatorCacheTimeout, ice_ping, ice_ping, ice_pingAsync, ice_pingAsync

Method Details

getClientProxy

default Router.GetClientProxyResult getClientProxy()

Gets 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.

Remarks: Introduced in Ice 3.7.

Returns:

an instance of Router.GetClientProxyResult

getClientProxy

default Router.GetClientProxyResult getClientProxy(Map<String,String> context)

Gets 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.

Remarks: Introduced in Ice 3.7.

Parameters:

context - the Context map to send with the invocation

Returns:

an instance of Router.GetClientProxyResult

getClientProxyAsync

default CompletableFuture<Router.GetClientProxyResult> getClientProxyAsync()

Gets 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.

Remarks: Introduced in Ice 3.7.

Returns:

a future that will be completed with an instance of Router.GetClientProxyResult

getClientProxyAsync

default CompletableFuture<Router.GetClientProxyResult> getClientProxyAsync(Map<String,String> context)

Gets 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.

Remarks: Introduced in Ice 3.7.

Parameters:

context - the Context map to send with the invocation

Returns:

a future that will be completed with an instance of Router.GetClientProxyResult

getServerProxy

default ObjectPrx getServerProxy()

Gets the router's server proxy, i.e. the proxy to use for forwarding requests from the server to the router. The Ice runtime uses the endpoints of this proxy as the published endpoints of bi-dir object adapters.

Returns:

The router's server proxy.

getServerProxy

default ObjectPrx getServerProxy(Map<String,String> context)

Gets the router's server proxy, i.e. the proxy to use for forwarding requests from the server to the router. The Ice runtime uses the endpoints of this proxy as the published endpoints of bi-dir object adapters.

Parameters:

context - the Context map to send with the invocation

Returns:

The router's server proxy.

getServerProxyAsync

default CompletableFuture<ObjectPrx> getServerProxyAsync()

Gets the router's server proxy, i.e. the proxy to use for forwarding requests from the server to the router. The Ice runtime uses the endpoints of this proxy as the published endpoints of bi-dir object adapters.

Returns:

The router's server proxy.

getServerProxyAsync

default CompletableFuture<ObjectPrx> getServerProxyAsync(Map<String,String> context)

Gets the router's server proxy, i.e. the proxy to use for forwarding requests from the server to the router. The Ice runtime uses the endpoints of this proxy as the published endpoints of bi-dir object adapters.

Parameters:

context - the Context map to send with the invocation

Returns:

The router's server proxy.

addProxies

default ObjectPrx[] addProxies(ObjectPrx[] proxies)

Adds new proxy information to the router's routing table.

Parameters:

proxies - The proxies to add. Adding a null proxy is an error.

Returns:

Proxies discarded by the router. These proxies are all non-null.

addProxies

default ObjectPrx[] addProxies(ObjectPrx[] proxies,
 Map<String,String> context)

Adds new proxy information to the router's routing table.

Parameters:

proxies - The proxies to add. Adding a null proxy is an error.

context - the Context map to send with the invocation

Returns:

Proxies discarded by the router. These proxies are all non-null.

addProxiesAsync

default CompletableFuture<ObjectPrx[]> addProxiesAsync(ObjectPrx[] proxies)

Adds new proxy information to the router's routing table.

Parameters:

proxies - The proxies to add. Adding a null proxy is an error.

Returns:

Proxies discarded by the router. These proxies are all non-null.

addProxiesAsync

default CompletableFuture<ObjectPrx[]> addProxiesAsync(ObjectPrx[] proxies,
 Map<String,String> context)

Adds new proxy information to the router's routing table.

Parameters:

proxies - The proxies to add. Adding a null proxy is an error.

context - the Context map to send with the invocation

Returns:

Proxies discarded by the router. These proxies are all non-null.

createProxy

static RouterPrx createProxy(Communicator communicator,
 String proxyString)

Creates a new proxy that implements RouterPrx.

Parameters:

communicator - the communicator of the new proxy

proxyString - the string representation of the proxy

Returns:

the new proxy

checkedCast

static RouterPrx checkedCast(ObjectPrx obj)

Creates a new proxy from an existing proxy after confirming the target object's type via a remote invocation.

Parameters:

obj - the source proxy

Returns:

a proxy for this type, or null if the target object does not support this type

checkedCast

static RouterPrx checkedCast(ObjectPrx obj,
 Map<String,String> context)

Creates a new proxy from an existing proxy after confirming the target object's type via a remote invocation.

Parameters:

obj - the source proxy

context - the Context map to send with the invocation

Returns:

a new proxy for this type, or null if the target object does not support this type

checkedCast

static RouterPrx checkedCast(ObjectPrx obj,
 String facet)

Creates a new proxy from an existing proxy after confirming the target object's type via a remote invocation.

Parameters:

obj - the source proxy

facet - the name of the desired facet

Returns:

a new proxy for this type, or null if the facet does not support this type.

checkedCast

static RouterPrx checkedCast(ObjectPrx obj,
 String facet,
 Map<String,String> context)

Creates a new proxy from an existing proxy after confirming the target object's type via a remote invocation.

Parameters:

obj - the source proxy

facet - the name of the desired facet

context - the Context map to send with the invocation

Returns:

a new proxy for this type, or null if the target object does not support this type.

uncheckedCast

static RouterPrx uncheckedCast(ObjectPrx obj)

Creates a new proxy from an existing proxy.

Parameters:

obj - the source proxy

Returns:

a new proxy with this type or null if obj is null

uncheckedCast

static RouterPrx uncheckedCast(ObjectPrx obj,
 String facet)

Creates a new proxy from an existing proxy.

Parameters:

obj - the source proxy

facet - the name of the desired facet

Returns:

a new proxy with this type or null if obj is null

ice_context

RouterPrx ice_context(Map<String,String> newContext)

Description copied from interface: ObjectPrx

Creates a proxy that is identical to this proxy, except for the per-proxy context.

Specified by:

ice_context in interface ObjectPrx

Parameters:

newContext - the context for the new proxy

Returns:

a proxy with the new per-proxy context

ice_adapterId

RouterPrx ice_adapterId(String newAdapterId)

Description copied from interface: ObjectPrx

Creates a proxy that is identical to this proxy, except for the adapter ID.

Specified by:

ice_adapterId in interface ObjectPrx

Parameters:

newAdapterId - the adapter ID for the new proxy

Returns:

a proxy with the new adapter ID

ice_endpoints

RouterPrx ice_endpoints(Endpoint[] newEndpoints)

Description copied from interface: ObjectPrx

Creates a proxy that is identical to this proxy, except for the endpoints.

Specified by:

ice_endpoints in interface ObjectPrx

Parameters:

newEndpoints - the endpoints for the new proxy

Returns:

a proxy with the new endpoints

ice_locatorCacheTimeout

RouterPrx ice_locatorCacheTimeout(int newTimeout)

Description copied from interface: ObjectPrx

Creates a proxy that is identical to this proxy, except for the locator cache timeout.

Specified by:

ice_locatorCacheTimeout in interface ObjectPrx

Parameters:

newTimeout - the new locator cache timeout (in seconds)

Returns:

a proxy with the new timeout

See Also:

• Locator

ice_invocationTimeout

RouterPrx ice_invocationTimeout(int newTimeout)

Description copied from interface: ObjectPrx

Creates a proxy that is identical to this proxy, except for the invocation timeout.

Specified by:

ice_invocationTimeout in interface ObjectPrx

Parameters:

newTimeout - the new invocation timeout (in milliseconds)

Returns:

a proxy with the new timeout

ice_invocationTimeout

RouterPrx ice_invocationTimeout(Duration newTimeout)

Description copied from interface: ObjectPrx

Creates a proxy that is identical to this proxy, except for the invocation timeout.

Specified by:

ice_invocationTimeout in interface ObjectPrx

Parameters:

newTimeout - the new invocation timeout

Returns:

a proxy with the new timeout

ice_connectionCached

RouterPrx ice_connectionCached(boolean newCache)

Description copied from interface: ObjectPrx

Creates a proxy that is identical to this proxy, except for connection caching.

Specified by:

ice_connectionCached in interface ObjectPrx

Parameters:

newCache - true if the new proxy should cache connections, false otherwise

Returns:

a proxy with the specified caching policy

ice_endpointSelection

RouterPrx ice_endpointSelection(EndpointSelectionType newType)

Description copied from interface: ObjectPrx

Creates a proxy that is identical to this proxy, except for the endpoint selection policy.

Specified by:

ice_endpointSelection in interface ObjectPrx

Parameters:

newType - the new endpoint selection policy

Returns:

a proxy with the specified endpoint selection policy

ice_encodingVersion

RouterPrx ice_encodingVersion(EncodingVersion e)

Description copied from interface: ObjectPrx

Creates a proxy that is identical to this proxy, except for the encoding used to marshal parameters.

Specified by:

ice_encodingVersion in interface ObjectPrx

Parameters:

e - the encoding version to use to marshal request parameters

Returns:

a proxy with the specified encoding version

ice_router

RouterPrx ice_router(RouterPrx router)

Description copied from interface: ObjectPrx

Creates a proxy that is identical to this proxy, except for the router.

Specified by:

ice_router in interface ObjectPrx

Parameters:

router - the router for the new proxy

Returns:

a proxy with the specified router

ice_locator

RouterPrx ice_locator(LocatorPrx locator)

Description copied from interface: ObjectPrx

Creates a proxy that is identical to this proxy, except for the locator.

Specified by:

ice_locator in interface ObjectPrx

Parameters:

locator - the locator for the new proxy

Returns:

a proxy with the specified locator

ice_collocationOptimized

RouterPrx ice_collocationOptimized(boolean b)

Description copied from interface: ObjectPrx

Creates a proxy that is identical to this proxy, except for collocation optimization.

Specified by:

ice_collocationOptimized in interface ObjectPrx

Parameters:

b - true if the new proxy enables collocation optimization, false otherwise

Returns:

a proxy with the specified collocation optimization

ice_twoway

RouterPrx ice_twoway()

Description copied from interface: ObjectPrx

Creates a proxy that is identical to this proxy, but uses twoway invocations.

Specified by:

ice_twoway in interface ObjectPrx

Returns:

a proxy that uses twoway invocations

ice_oneway

RouterPrx ice_oneway()

Description copied from interface: ObjectPrx

Creates a proxy that is identical to this proxy, but uses oneway invocations.

Specified by:

ice_oneway in interface ObjectPrx

Returns:

a proxy that uses oneway invocations

ice_batchOneway

RouterPrx ice_batchOneway()

Description copied from interface: ObjectPrx

Creates a proxy that is identical to this proxy, but uses batch oneway invocations.

Specified by:

ice_batchOneway in interface ObjectPrx

Returns:

a proxy that uses batch oneway invocations

ice_datagram

RouterPrx ice_datagram()

Description copied from interface: ObjectPrx

Creates a proxy that is identical to this proxy, but uses datagram invocations.

Specified by:

ice_datagram in interface ObjectPrx

Returns:

a proxy that uses datagram invocations

ice_batchDatagram

RouterPrx ice_batchDatagram()

Description copied from interface: ObjectPrx

Creates a proxy that is identical to this proxy, but uses batch datagram invocations.

Specified by:

ice_batchDatagram in interface ObjectPrx

Returns:

a proxy that uses batch datagram invocations

ice_compress

RouterPrx ice_compress(boolean co)

Description copied from interface: ObjectPrx

Creates a proxy that is identical to this proxy, except for its compression setting which overrides the compression setting from the proxy endpoints.

Specified by:

ice_compress in interface ObjectPrx

Parameters:

co - true enables compression for the new proxy, false disables compression.

Returns:

a proxy with the specified compression override setting

ice_connectionId

RouterPrx ice_connectionId(String connectionId)

Description copied from interface: ObjectPrx

Creates a proxy that is identical to this proxy, except for its connection ID.

Specified by:

ice_connectionId in interface ObjectPrx

Parameters:

connectionId - the connection ID for the new proxy. An empty string removes the connection ID.

Returns:

a proxy with the specified connection ID

ice_fixed

RouterPrx ice_fixed(Connection connection)

Description copied from interface: ObjectPrx

Creates a proxy that is identical to this proxy, except it's a fixed proxy bound to the given connection.

Specified by:

ice_fixed in interface ObjectPrx

Parameters:

connection - the fixed proxy connection

Returns:

a fixed proxy bound to the given connection

ice_staticId

static String ice_staticId()

Gets the type ID of the associated Slice interface.

Returns:

the string "::Ice::Router"