Ice.Locator

class Ice.Locator

Bases: Object, ABC

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

Notes

The Slice compiler generated this skeleton class from Slice interface ::Ice::Locator.

abstractmethod findAdapterById(id: str, current: Current) → ObjectPrx | None | Awaitable[ObjectPrx | None]

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

Parameters:

  • id (str) – The adapter ID.

  • current (Ice.Current) – The Current object for the dispatch.

Returns:

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

Return type:

ObjectPrx | None | Awaitable[ObjectPrx | None]

Raises:

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

abstractmethod findObjectById(id: Identity, current: Current) → ObjectPrx | None | Awaitable[ObjectPrx | None]

Finds an object by identity and returns a dummy proxy with the endpoint(s) that can be used to reach this object. This dummy proxy may be an indirect proxy that requires further resolution using Ice.LocatorPrx.findAdapterByIdAsync().

Parameters:

  • id (Identity) – The identity.

  • current (Ice.Current) – The Current object for the dispatch.

Returns:

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

Return type:

ObjectPrx | None | Awaitable[ObjectPrx | None]

Raises:

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

abstractmethod getRegistry(current: Current) → LocatorRegistryPrx | None | Awaitable[LocatorRegistryPrx | None]

Gets a proxy to the locator registry.

Parameters:

current (Ice.Current) – The Current object for the dispatch.

Returns:

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

Return type:

LocatorRegistryPrx | None | Awaitable[LocatorRegistryPrx | None]

static ice_staticId() → str

Obtain the type ID of the Slice interface.

Returns:

The type ID.

Return type:

str