Interface ILocatorService

Namespace

IceRpc.Ice

Assembly

IceRpc.Locator.dll

Client applications use the Locator object to resolve Ice indirect proxies. This object also allows server applications to retrieve a proxy to the associated LocatorRegistryProxy object where they can register their object adapters.

[IceTypeId("::Ice::Locator")]
[DefaultServicePath("/Ice.Locator")]
public interface ILocatorService

Remarks

Apply ServiceAttribute to the partial class that implements this interface. The Ice compiler generated this server-side interface from Ice interface ::Ice::Locator.

Methods

FindAdapterByIdAsync(string, IFeatureCollection, CancellationToken)

Finds an object adapter by adapter ID and returns a dummy proxy with the object adapter's endpoint(s).

[IceOperation("findAdapterById", Idempotent = true, ExceptionSpecification = new Type[] { typeof(AdapterNotFoundException) })]
ValueTask<IceObjectProxy?> FindAdapterByIdAsync(string id, IFeatureCollection features, CancellationToken cancellationToken)

Parameters

id string

The adapter ID.

features IFeatureCollection

The features of this dispatch.

cancellationToken CancellationToken

A cancellation token that receives the cancellation requests.

Returns

ValueTask<IceObjectProxy?>

A dummy proxy with the adapter's endpoints, or null if an object adapter with id was not found.

Exceptions

AdapterNotFoundException

Thrown when an object adapter with this adapter ID was not found. The caller should treat this exception like a null return value.

FindObjectByIdAsync(Identity, IFeatureCollection, CancellationToken)

Finds an object by identity and returns a dummy proxy with endpoint(s) that can be used to reach this object. This dummy proxy may be an indirect proxy that requires further resolution using FindAdapterByIdAsync(string, IFeatureCollection?, CancellationToken).

[IceOperation("findObjectById", Idempotent = true, ExceptionSpecification = new Type[] { typeof(ObjectNotFoundException) })]
ValueTask<IceObjectProxy?> FindObjectByIdAsync(Identity id, IFeatureCollection features, CancellationToken cancellationToken)

Parameters

id Identity

The identity.

features IFeatureCollection

The features of this dispatch.

cancellationToken CancellationToken

A cancellation token that receives the cancellation requests.

Returns

ValueTask<IceObjectProxy?>

A dummy proxy, or null if an object with the requested identity was not found.

Exceptions

ObjectNotFoundException

Thrown when an object with the requested identity was not found. The caller should treat this exception like a null return value.

GetRegistryAsync(IFeatureCollection, CancellationToken)

Gets a proxy to the locator registry.

[IceOperation("getRegistry", Idempotent = true)]
ValueTask<LocatorRegistryProxy?> GetRegistryAsync(IFeatureCollection features, CancellationToken cancellationToken)

Parameters

features IFeatureCollection

The features of this dispatch.

cancellationToken CancellationToken

A cancellation token that receives the cancellation requests.

Returns

ValueTask<LocatorRegistryProxy?>

A proxy to the locator registry, or null if this locator has no associated registry.