@zeroc/ice
    Preparing search index...

    Class QueryAbstract

    Finds well-known Ice objects registered with the IceGrid registry.

    The Slice compiler generated this skeleton class from Slice interface ::IceGrid::Query.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Methods

    dispatch findAllObjectsByType findAllReplicas findObjectById findObjectByType findObjectByTypeOnLeastLoadedNode ice_id ice_ids ice_isA ice_ping 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.

    • Finds all the well-known objects with the given type.

      Parameters

      • type: string

        The object type.

      • 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 list of proxies to the well-known objects with the specified type. Can be empty.

    • Finds all the replicas of a well-known object.

      Parameters

      • proxy: ObjectPrx

        A proxy that identifies the well-known object.

      • 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 list of proxies to the replicas of the well-known object specified by proxy. Can be empty.

    • Finds a well-known object by identity.

      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 proxy to the well-known object, or null if no such object is registered.

    • Finds a well-known object by type. If there are several objects registered for the given type, the object is randomly selected.

      Parameters

      • type: string

        The object type.

      • 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 proxy to a well-known object with the specified type, or null if no such object is registered.

    • Finds a well-known object by type on the least-loaded node. If the registry does not know which node hosts the object (for example, because the object was registered with a direct proxy), the registry assumes the object is hosted on a node that has a load average of 1.0.

      Parameters

      • type: string

        The object type.

      • sample: LoadSample

        The sampling interval.

      • 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 proxy to the well-known object, or null if no such object is registered.

    • 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 "::IceGrid::Query".

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods