@zeroc/ice
    Preparing search index...

    Class RegistryAbstract

    Represents the main entry point into the IceGrid registry service. It provides operations to create sessions with the registry.

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

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Methods

    createAdminSession createAdminSessionFromSecureConnection createSession createSessionFromSecureConnection dispatch getSessionTimeout ice_id ice_ids ice_isA ice_ping ice_staticId

    Constructors

    Methods

    • Creates an administrative session.

      Parameters

      • userId: string

        The user ID.

      • password: string

        The password for the given user.

      • current: Current

        The Current object for the dispatch.

      Returns AdminSessionPrx | PromiseLike<AdminSessionPrx>

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

      • IceGrid.AdminSessionPrx | null : A proxy to the newly created session. This proxy is never null.

      IceGrid.PermissionDeniedException Thrown when authentication or authorization fails.

    • Creates an administrative session from a secure connection.

      Parameters

      • current: Current

        The Current object for the dispatch.

      Returns AdminSessionPrx | PromiseLike<AdminSessionPrx>

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

      • IceGrid.AdminSessionPrx | null : A proxy to the newly created session. This proxy is never null.

      IceGrid.PermissionDeniedException Thrown when authentication or authorization fails.

    • Creates a client session.

      Parameters

      • userId: string

        The user ID.

      • password: string

        The password for the given user.

      • current: Current

        The Current object for the dispatch.

      Returns IceGrid.SessionPrx | PromiseLike<IceGrid.SessionPrx>

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

      • IceGrid.SessionPrx | null : A proxy to the newly created session. This proxy is never null.

      IceGrid.PermissionDeniedException Thrown when authentication or authorization fails.

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

    • Gets the session timeout. An Ice 3.7 or earlier client can use this value to determine how often it needs to send heartbeats (using ACM) or call IceGrid.SessionPrx.keepAlive (resp. IceGrid.AdminSessionPrx.keepAlive) to keep a session alive in the IceGrid registry.

      Parameters

      • current: Current

        The Current object for the dispatch.

      Returns number | PromiseLike<number>

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

      • number : The session timeout (in seconds).

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

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods