Ice.LocatorRegistryPrx

class Ice.LocatorRegistryPrx

Bases: ObjectPrx

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

Notes

The Slice compiler generated this proxy class from Slice interface ::Ice::LocatorRegistry.

static checkedCast(proxy: ObjectPrx | None, facet: str | None = None, context: dict[str, str] | None = None) → LocatorRegistryPrx | None

Creates a new proxy from an existing proxy after confirming the target object’s type via a remote invocation.

Parameters:

  • proxy (ObjectPrx | None) – The source proxy.

  • facet (str, optional) – A facet name.

  • context (dict[str, str], optional) – The request context.

Returns:

A new proxy with the requested type, or None if the source proxy is None or if the target object does not support the requested type.

Return type:

ObjectPrx | None

static checkedCastAsync(proxy: ObjectPrx | None, facet: str | None = None, context: dict[str, str] | None = None) → Awaitable[LocatorRegistryPrx | None]

Creates a new proxy from an existing proxy after confirming the target object’s type via a remote invocation.

Parameters:

  • proxy (ObjectPrx | None) – The source proxy.

  • facet (str, optional) – A facet name.

  • context (dict[str, str], optional) – The request context.

Returns:

A new proxy with the requested type, or None if the source proxy is None or if the target object does not support the requested type.

Return type:

ObjectPrx | None

static ice_staticId() → str

Gets the Slice type ID of the interface associated with this proxy.

Returns:

The type ID, “::Ice::Object”.

Return type:

str

setAdapterDirectProxy(id: str, proxy: ObjectPrx | None, context: dict[str, str] | None = None) → None

Registers or unregisters the endpoints of an object adapter.

Parameters:

  • id (str) – The adapter ID.

  • proxy (ObjectPrx | None) – 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.

  • context (dict[str, str]) – The request context for the invocation.

Raises:

  • 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.

Return type:

None

setAdapterDirectProxyAsync(id: str, proxy: ObjectPrx | None, context: dict[str, str] | None = None) → Awaitable[None]

Registers or unregisters the endpoints of an object adapter.

Parameters:

  • id (str) – The adapter ID.

  • proxy (ObjectPrx | None) – 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.

  • context (dict[str, str]) – The request context for the invocation.

Returns:

An awaitable that is completed when the invocation completes.

Return type:

Awaitable[None]

setReplicatedAdapterDirectProxy(adapterId: str, replicaGroupId: str, proxy: ObjectPrx | None, context: dict[str, str] | None = None) → None

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

Parameters:

  • adapterId (str) – The adapter ID.

  • replicaGroupId (str) – The replica group ID.

  • proxy (ObjectPrx | None) – 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.

  • context (dict[str, str]) – The request context for the invocation.

Raises:

  • 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.

Return type:

None

setReplicatedAdapterDirectProxyAsync(adapterId: str, replicaGroupId: str, proxy: ObjectPrx | None, context: dict[str, str] | None = None) → Awaitable[None]

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

Parameters:

  • adapterId (str) – The adapter ID.

  • replicaGroupId (str) – The replica group ID.

  • proxy (ObjectPrx | None) – 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.

  • context (dict[str, str]) – The request context for the invocation.

Returns:

An awaitable that is completed when the invocation completes.

Return type:

Awaitable[None]

setServerProcessProxy(id: str, proxy: ProcessPrx | None, context: dict[str, str] | None = None) → None

Registers a proxy to the Ice.ProcessPrx object of a server application.

Parameters:

  • id (str) – The server ID.

  • proxy (ProcessPrx | None) – A proxy to the Ice.ProcessPrx object of the server. This proxy is never null.

  • context (dict[str, str]) – The request context for the invocation.

Raises:

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

Return type:

None

setServerProcessProxyAsync(id: str, proxy: ProcessPrx | None, context: dict[str, str] | None = None) → Awaitable[None]

Registers a proxy to the Ice.ProcessPrx object of a server application.

Parameters:

  • id (str) – The server ID.

  • proxy (ProcessPrx | None) – A proxy to the Ice.ProcessPrx object of the server. This proxy is never null.

  • context (dict[str, str]) – The request context for the invocation.

Returns:

An awaitable that is completed when the invocation completes.

Return type:

Awaitable[None]

static uncheckedCast(proxy: ObjectPrx, facet: str | None = None) → LocatorRegistryPrx
static uncheckedCast(proxy: None, facet: str | None = None) → None

Creates a new proxy from an existing proxy.

Parameters:

  • proxy (ObjectPrx | None) – The source proxy.

  • facet (str, optional) – A facet name.

Returns:

A new proxy with the requested type, or None if the source proxy is None.

Return type:

ObjectPrx | None