Interface IIceObject

Namespace

IceRpc.Ice

Assembly

IceRpc.Ice.dll

Base interface with common operations.

public interface IIceObject

Remarks

Use the methods of this interface to invoke operations on a remote Ice service that implements Object. The Ice compiler generated this client-side interface from Ice interface ::Ice::Object.

Methods

IceIdsAsync(IFeatureCollection?, CancellationToken)

Gets the Ice type IDs of all the interfaces implemented by the target service.

Task<string[]> IceIdsAsync(IFeatureCollection? features = null, CancellationToken cancellationToken = default)

Parameters

features IFeatureCollection

The features of this invocation.

cancellationToken CancellationToken

A cancellation token that receives the cancellation requests.

Returns

Task<string[]>

The Ice type IDs of all these interfaces, sorted alphabetically.

Exceptions

DispatchException

Thrown when the dispatch of the operation failed. This exception is provided through the returned task; it's never thrown synchronously.

IceIsAAsync(string, IFeatureCollection?, CancellationToken)

Tests whether the target service implements the specified interface.

Task<bool> IceIsAAsync(string id, IFeatureCollection? features = null, CancellationToken cancellationToken = default)

Parameters

id string

The Ice type ID of the interface to test against.

features IFeatureCollection

The features of this invocation.

cancellationToken CancellationToken

A cancellation token that receives the cancellation requests.

Returns

Task<bool>

True when the target service implements this interface; otherwise, false.

Exceptions

DispatchException

Thrown when the dispatch of the operation failed. This exception is provided through the returned task; it's never thrown synchronously.

IcePingAsync(IFeatureCollection?, CancellationToken)

Pings the service.

Task IcePingAsync(IFeatureCollection? features = null, CancellationToken cancellationToken = default)

Parameters

features IFeatureCollection

The features of this invocation.

cancellationToken CancellationToken

A cancellation token that receives the cancellation requests.

Returns

Task

A task that completes when the response is received.

Exceptions

DispatchException

Thrown when the dispatch of the operation failed. This exception is provided through the returned task; it's never thrown synchronously.