Interface ILocatorRegistryService

Namespace

IceRpc.Ice

Assembly

IceRpc.Locator.dll

A server application registers the endpoints of its indirect object adapters with the LocatorRegistry object.

[IceTypeId("::Ice::LocatorRegistry")]
[DefaultServicePath("/Ice.LocatorRegistry")]
public interface ILocatorRegistryService

Remarks

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

Methods

SetAdapterDirectProxyAsync(string, IceObjectProxy?, IFeatureCollection, CancellationToken)

Registers or unregisters the endpoints of an object adapter.

[IceOperation("setAdapterDirectProxy", Idempotent = true, ExceptionSpecification = new Type[] { typeof(AdapterNotFoundException), typeof(AdapterAlreadyActiveException) })]
ValueTask SetAdapterDirectProxyAsync(string id, IceObjectProxy? proxy, IFeatureCollection features, CancellationToken cancellationToken)

Parameters

id string

The adapter ID.

proxy IceObjectProxy?

A dummy proxy created by the object adapter. proxy carries the object adapter's endpoints. The locator considers an object adapter to be active after it has registered its endpoints. When proxy is null, the endpoints are unregistered and the locator considers the object adapter inactive.

features IFeatureCollection

The features of this dispatch.

cancellationToken CancellationToken

A cancellation token that receives the cancellation requests.

Returns

ValueTask

A value task that completes when the dispatch completes.

Exceptions

AdapterAlreadyActiveException

Thrown when an object adapter with the same adapter ID has already registered its endpoints. Since this operation is marked idempotent, this exception may be thrown when the Ice client runtime retries an invocation with a non-null proxy.

AdapterNotFoundException

Thrown when the locator only allows registered object adapters to register their endpoints and no object adapter with this adapter ID was registered with the locator.

SetReplicatedAdapterDirectProxyAsync(string, string, IceObjectProxy?, IFeatureCollection, CancellationToken)

Registers or unregisters the endpoints of an object adapter. This object adapter is a member of a replica group.

[IceOperation("setReplicatedAdapterDirectProxy", Idempotent = true, ExceptionSpecification = new Type[] { typeof(AdapterNotFoundException), typeof(AdapterAlreadyActiveException), typeof(InvalidReplicaGroupIdException) })]
ValueTask SetReplicatedAdapterDirectProxyAsync(string adapterId, string replicaGroupId, IceObjectProxy? proxy, IFeatureCollection features, CancellationToken cancellationToken)

Parameters

adapterId string

The adapter ID.

replicaGroupId string

The replica group ID.

proxy IceObjectProxy?

A dummy proxy created by the object adapter. proxy carries the object adapter's endpoints. The locator considers an object adapter to be active after it has registered its endpoints. When proxy is null, the endpoints are unregistered and the locator considers the object adapter inactive.

features IFeatureCollection

The features of this dispatch.

cancellationToken CancellationToken

A cancellation token that receives the cancellation requests.

Returns

ValueTask

A value task that completes when the dispatch completes.

Exceptions

AdapterAlreadyActiveException

Thrown when an object adapter with the same adapter ID has already registered its endpoints. Since this operation is marked idempotent, this exception may be thrown when the Ice client runtime retries an invocation with a non-null proxy.

AdapterNotFoundException

Thrown when the locator only allows registered object adapters to register their endpoints and no object adapter with this adapter ID was registered with the locator.

InvalidReplicaGroupIdException

Thrown when the given replica group does not match the replica group associated with the adapter ID in the locator's database.

SetServerProcessProxyAsync(string, ProcessProxy?, IFeatureCollection, CancellationToken)

Registers a proxy to the ProcessProxy object of a server application.

[IceOperation("setServerProcessProxy", Idempotent = true, ExceptionSpecification = new Type[] { typeof(ServerNotFoundException) })]
ValueTask SetServerProcessProxyAsync(string id, ProcessProxy? proxy, IFeatureCollection features, CancellationToken cancellationToken)

Parameters

id string

The server ID.

proxy ProcessProxy?

A proxy to the ProcessProxy object of the server. This proxy is never null.

features IFeatureCollection

The features of this dispatch.

cancellationToken CancellationToken

A cancellation token that receives the cancellation requests.

Returns

ValueTask

A value task that completes when the dispatch completes.

Exceptions

ServerNotFoundException

Thrown when the locator does not know a server application with a server ID of id.