@zeroc/ice
    Preparing search index...

    Class LocatorAbstract

    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.

    Hierarchy (View Summary)

    Index

    Constructors

    Methods

    • Dispatches an incoming request to one of the methods of this generated class, based on the operation name carried by the request.

      Parameters

      Returns OutgoingResponse | PromiseLike<OutgoingResponse>

      The outgoing response (when the selected method returns a value), or a promise with the outgoing response (when the selected method returns a promise).

      Ice marshals any exception thrown by this method into the response.

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

      Parameters

      • id: string

        The adapter ID.

      • current: Current

        The Current object for the dispatch.

      Returns ObjectPrx | PromiseLike<ObjectPrx>

      A promise like object representing the result of the dispatch, which resolves to:

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

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

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

      Parameters

      • id: Identity

        The identity.

      • current: Current

        The Current object for the dispatch.

      Returns ObjectPrx | PromiseLike<ObjectPrx>

      A promise like object representing the result of the dispatch, which resolves to:

      • Ice.ObjectPrx | null : A dummy proxy, or null if an object with the requested identity was not found.

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

    • Gets a proxy to the locator registry.

      Parameters

      • current: Current

        The Current object for the dispatch.

      Returns LocatorRegistryPrx | PromiseLike<LocatorRegistryPrx>

      A promise like object representing the result of the dispatch, which resolves to:

      • Ice.LocatorRegistryPrx | null : A proxy to the locator registry, or null if this locator has no associated registry.
    • Returns the Slice type ID of the most-derived interface supported by this object.

      Parameters

      • current: Current

        The Current object for the invocation.

      Returns string | PromiseLike<string>

      The Slice type ID of the most-derived interface.

    • Returns the Slice type IDs of the interfaces supported by this object.

      Parameters

      • current: Current

        The Current object for the invocation.

      Returns string[] | PromiseLike<string[]>

      The Slice type IDs of the interfaces supported by this object, in alphabetical order.

    • Tests whether this object supports a specific Slice interface.

      Parameters

      • typeID: string

        The type ID of the Slice interface to test against.

      • current: Current

        The Current object for the invocation.

      Returns boolean | PromiseLike<boolean>

      True if this object has the interface specified by typeID or derives from the interface specified by typeID.

    • Tests whether this object can be reached.

      Parameters

      • current: Current

        The Current object for the invocation.

      Returns void | PromiseLike<void>

    • Obtains the Slice type ID of this type.

      Returns string

      The return value is always "::Ice::Locator".