Interface RouterPrx

Namespace

Ice

Assembly

Ice.dll

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

public interface RouterPrx : ObjectPrx, IEquatable<ObjectPrx>

Inherited Members

ObjectPrx.ice_getCommunicator()

ObjectPrx.ice_isA(string, Dictionary<string, string>)

ObjectPrx.ice_isAAsync(string, Dictionary<string, string>, IProgress<bool>, CancellationToken)

ObjectPrx.ice_ping(Dictionary<string, string>)

ObjectPrx.ice_pingAsync(Dictionary<string, string>, IProgress<bool>, CancellationToken)

ObjectPrx.ice_ids(Dictionary<string, string>)

ObjectPrx.ice_idsAsync(Dictionary<string, string>, IProgress<bool>, CancellationToken)

ObjectPrx.ice_id(Dictionary<string, string>)

ObjectPrx.ice_idAsync(Dictionary<string, string>, IProgress<bool>, CancellationToken)

ObjectPrx.ice_invoke(string, OperationMode, byte[], out byte[], Dictionary<string, string>)

ObjectPrx.ice_invokeAsync(string, OperationMode, byte[], Dictionary<string, string>, IProgress<bool>, CancellationToken)

ObjectPrx.ice_getIdentity()

ObjectPrx.ice_identity(Identity)

ObjectPrx.ice_getContext()

ObjectPrx.ice_context(Dictionary<string, string>)

ObjectPrx.ice_getFacet()

ObjectPrx.ice_facet(string)

ObjectPrx.ice_getAdapterId()

ObjectPrx.ice_adapterId(string)

ObjectPrx.ice_getEndpoints()

ObjectPrx.ice_endpoints(Endpoint[])

ObjectPrx.ice_getLocatorCacheTimeout()

ObjectPrx.ice_locatorCacheTimeout(int)

ObjectPrx.ice_locatorCacheTimeout(TimeSpan)

ObjectPrx.ice_invocationTimeout(int)

ObjectPrx.ice_invocationTimeout(TimeSpan)

ObjectPrx.ice_getInvocationTimeout()

ObjectPrx.ice_isConnectionCached()

ObjectPrx.ice_connectionCached(bool)

ObjectPrx.ice_getEndpointSelection()

ObjectPrx.ice_endpointSelection(EndpointSelectionType)

ObjectPrx.ice_encodingVersion(EncodingVersion)

ObjectPrx.ice_getEncodingVersion()

ObjectPrx.ice_getRouter()

ObjectPrx.ice_router(RouterPrx)

ObjectPrx.ice_getLocator()

ObjectPrx.ice_locator(LocatorPrx)

ObjectPrx.ice_isCollocationOptimized()

ObjectPrx.ice_collocationOptimized(bool)

ObjectPrx.ice_twoway()

ObjectPrx.ice_isTwoway()

ObjectPrx.ice_oneway()

ObjectPrx.ice_isOneway()

ObjectPrx.ice_batchOneway()

ObjectPrx.ice_isBatchOneway()

ObjectPrx.ice_datagram()

ObjectPrx.ice_isDatagram()

ObjectPrx.ice_batchDatagram()

ObjectPrx.ice_isBatchDatagram()

ObjectPrx.ice_compress(bool)

ObjectPrx.ice_getCompress()

ObjectPrx.ice_connectionId(string)

ObjectPrx.ice_getConnectionId()

ObjectPrx.ice_fixed(Connection)

ObjectPrx.ice_isFixed()

ObjectPrx.ice_getConnection()

ObjectPrx.ice_getConnectionAsync(IProgress<bool>, CancellationToken)

ObjectPrx.ice_getCachedConnection()

ObjectPrx.ice_flushBatchRequests()

ObjectPrx.ice_flushBatchRequestsAsync(IProgress<bool>, CancellationToken)

ObjectPrx.ice_scheduler()

ObjectPrx.checkNotNull(ObjectPrx, Current)

IEquatable<ObjectPrx>.Equals(ObjectPrx)

Remarks

Use the methods of this interface to invoke operations on a remote Ice object that implements Router. The Slice compiler generated this proxy interface from Slice interface ::Ice::Router.

Methods

addProxies(ObjectPrx?[], Dictionary<string, string>?)

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

ObjectPrx?[] addProxies(ObjectPrx?[] proxies, Dictionary<string, string>? context = null)

Parameters

proxies ObjectPrx[]

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

context Dictionary<string, string>

The request context.

Returns

ObjectPrx[]

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

addProxiesAsync(ObjectPrx?[], Dictionary<string, string>?, IProgress<bool>?, CancellationToken)

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

Task<ObjectPrx?[]> addProxiesAsync(ObjectPrx?[] proxies, Dictionary<string, string>? context = null, IProgress<bool>? progress = null, CancellationToken cancel = default)

Parameters

proxies ObjectPrx[]

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

context Dictionary<string, string>

The request context.

progress IProgress<bool>

The sent progress provider.

cancel CancellationToken

A cancellation token that receives the cancellation requests.

Returns

Task<ObjectPrx[]>

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

getClientProxy(out bool?, Dictionary<string, string>?)

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.

ObjectPrx? getClientProxy(out bool? hasRoutingTable, Dictionary<string, string>? context = null)

Parameters

hasRoutingTable bool?

Indicates whether or not the router supports a routing table. If true, the Ice runtime will call addProxiesAsync(ObjectPrx?[], Dictionary<string, string>?, IProgress<bool>?, CancellationToken) to populate the routing table. The Ice runtime assumes the router has a routing table when hasRoutingTable is not set.

context Dictionary<string, string>

The request context.

Returns

ObjectPrx

The router's client proxy.

Remarks

Introduced in Ice 3.7.

getClientProxyAsync(Dictionary<string, string>?, IProgress<bool>?, CancellationToken)

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.

Task<Router_GetClientProxyResult> getClientProxyAsync(Dictionary<string, string>? context = null, IProgress<bool>? progress = null, CancellationToken cancel = default)

Parameters

context Dictionary<string, string>

The request context.

progress IProgress<bool>

The sent progress provider.

cancel CancellationToken

A cancellation token that receives the cancellation requests.

Returns

Task<Router_GetClientProxyResult>

A task that completes when the response is received.

Remarks

Introduced in Ice 3.7.

getServerProxy(Dictionary<string, string>?)

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.

ObjectPrx? getServerProxy(Dictionary<string, string>? context = null)

Parameters

context Dictionary<string, string>

The request context.

Returns

ObjectPrx

The router's server proxy.

getServerProxyAsync(Dictionary<string, string>?, IProgress<bool>?, CancellationToken)

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.

Task<ObjectPrx?> getServerProxyAsync(Dictionary<string, string>? context = null, IProgress<bool>? progress = null, CancellationToken cancel = default)

Parameters

context Dictionary<string, string>

The request context.

progress IProgress<bool>

The sent progress provider.

cancel CancellationToken

A cancellation token that receives the cancellation requests.

Returns

Task<ObjectPrx>

The router's server proxy.