@zeroc/ice
    Preparing search index...

    Class LocatorRegistryAbstract

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

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Methods

    dispatch ice_id ice_ids ice_isA ice_ping setAdapterDirectProxy setReplicatedAdapterDirectProxy setServerProcessProxy ice_staticId

    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.

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

    • Registers or unregisters the endpoints of an object adapter.

      Parameters

      • id: string

        The adapter ID.

      • proxy: ObjectPrx

        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.

      • current: Current

        The Current object for the dispatch.

      Returns void | PromiseLike<void>

      A promise like object representing the result of the dispatch.

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

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

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

      Parameters

      • adapterId: string

        The adapter ID.

      • replicaGroupId: string

        The replica group ID.

      • proxy: ObjectPrx

        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.

      • current: Current

        The Current object for the dispatch.

      Returns void | PromiseLike<void>

      A promise like object representing the result of the dispatch.

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

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

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

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

      Parameters

      • id: string

        The server ID.

      • proxy: ProcessPrx

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

      • current: Current

        The Current object for the dispatch.

      Returns void | PromiseLike<void>

      A promise like object representing the result of the dispatch.

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

    • Obtains the Slice type ID of this type.

      Returns string

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

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods