@zeroc/ice
    Preparing search index...

    Class TopicManagerAbstract

    Represents an object that manages topics.

    IceStorm.TopicPrx

    The Slice compiler generated this skeleton class from Slice interface ::IceStorm::TopicManager.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Methods

    create createOrRetrieve dispatch ice_id ice_ids ice_isA ice_ping retrieve retrieveAll ice_staticId

    Constructors

    Methods

    • Creates a new topic.

      Parameters

      • name: string

        The name of the topic.

      • current: Current

        The Current object for the dispatch.

      Returns TopicPrx | PromiseLike<TopicPrx>

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

      • IceStorm.TopicPrx | null : A proxy to the new topic object. The returned proxy is never null.

      IceStorm.TopicExists Thrown when a topic with the same name already exists.

    • Creates a new topic with the given name, or retrieves the existing topic with this name if it already exists.

      Parameters

      • name: string

        The name of the topic.

      • current: Current

        The Current object for the dispatch.

      Returns TopicPrx | PromiseLike<TopicPrx>

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

      • IceStorm.TopicPrx | null : A proxy to the topic object. The returned proxy is never null.

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

    • Retrieves a topic by name.

      Parameters

      • name: string

        The name of the topic.

      • current: Current

        The Current object for the dispatch.

      Returns TopicPrx | PromiseLike<TopicPrx>

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

      • IceStorm.TopicPrx | null : A proxy to the topic object. The returned proxy is never null.

      IceStorm.NoSuchTopic Thrown when there is no topic named name.

    • Retrieves all topics managed by this topic manager.

      Parameters

      • current: Current

        The Current object for the dispatch.

      Returns Map<string, TopicPrx> | PromiseLike<Map<string, TopicPrx>>

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

      • Map<string, IceStorm.TopicPrx | null> : A dictionary of string, topic proxy pairs.

    • Obtains the Slice type ID of this type.

      Returns string

      The return value is always "::IceStorm::TopicManager".

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods