@zeroc/ice
    Preparing search index...

    Class SessionControlAbstract

    Represents a router-provided object that allows an application-provided session manager to configure the routing constraints for a session.

    SessionManager

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Methods

    adapterIds categories destroy dispatch getSessionTimeout ice_id ice_ids ice_isA ice_ping identities ice_staticId

    Constructors

    Methods

    • Gets a proxy to the object that manages the allowable adapter identities for objects for this session.

      Parameters

      • current: Current

        The Current object for the dispatch.

      Returns StringSetPrx | PromiseLike<StringSetPrx>

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

    • Gets a proxy to the object that manages the allowable categories for object identities for this session.

      Parameters

      • current: Current

        The Current object for the dispatch.

      Returns StringSetPrx | PromiseLike<StringSetPrx>

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

    • Destroys the associated session.

      Parameters

      • current: Current

        The Current object for the dispatch.

      Returns void | PromiseLike<void>

      A promise like object representing the result of the dispatch.

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

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

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

    • Gets a proxy to the object that manages the allowable object identities for this session.

      Parameters

      • current: Current

        The Current object for the dispatch.

      Returns IdentitySetPrx | PromiseLike<IdentitySetPrx>

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

    • Obtains the Slice type ID of this type.

      Returns string

      The return value is always "::Glacier2::SessionControl".

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods