Interface IIceObjectService

Namespace

IceRpc.Ice

Assembly

IceRpc.Ice.dll

Base interface with common operations.

[IceTypeId("::Ice::Object")]
[DefaultServicePath("/Ice.Object")]
[SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1605:PartialElementDocumentationMustHaveSummary", Justification = "Use generated summary.")]
public interface IIceObjectService

Remarks

Apply ServiceAttribute to the partial class that implements this interface. The Ice compiler generated this server-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.

[IceOperation("ice_ids", Idempotent = true)]
ValueTask<IEnumerable<string>> IceIdsAsync(IFeatureCollection features, CancellationToken cancellationToken)

Parameters

features IFeatureCollection

The dispatch features.

cancellationToken CancellationToken

A cancellation token that receives the cancellation requests.

Returns

ValueTask<IEnumerable<string>>

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

IceIsAAsync(string, IFeatureCollection, CancellationToken)

Tests whether the target service implements the specified interface.

[IceOperation("ice_isA", Idempotent = true)]
ValueTask<bool> IceIsAAsync(string id, IFeatureCollection features, CancellationToken cancellationToken)

Parameters

id string

The Ice type ID of the interface to test against.

features IFeatureCollection

The dispatch features.

cancellationToken CancellationToken

A cancellation token that receives the cancellation requests.

Returns

ValueTask<bool>

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

IcePingAsync(IFeatureCollection, CancellationToken)

Pings the service.

[IceOperation("ice_ping", Idempotent = true)]
ValueTask IcePingAsync(IFeatureCollection features, CancellationToken cancellationToken)

Parameters

features IFeatureCollection

The dispatch features.

cancellationToken CancellationToken

A cancellation token that receives the cancellation requests.

Returns

ValueTask

A value task that completes when this implementation completes.