@zeroc/ice
    Preparing search index...

    Class TopicAbstract

    Represents an IceStorm topic. Publishers publish data to a topic (via the topic's publisher object), and subscribers subscribe to a topic.

    TopicManager

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Methods

    destroy dispatch getLinkInfoSeq getName getNonReplicatedPublisher getPublisher getSubscribers ice_id ice_ids ice_isA ice_ping link subscribeAndGetPublisher unlink unsubscribe ice_staticId

    Constructors

    Methods

    • Destroys this topic.

      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 information on the current links.

      Parameters

      • current: Current

        The Current object for the dispatch.

      Returns LinkInfo[] | PromiseLike<LinkInfo[]>

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

      • IceStorm.LinkInfo[] : A sequence of LinkInfo objects.

    • Gets the name of this topic.

      Parameters

      • current: Current

        The Current object for the dispatch.

      Returns string | PromiseLike<string>

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

      • string : The name of the topic.

      TopicManager#create

    • Gets a non-replicated proxy to a publisher object for this topic. To publish data to a topic, a publisher calls this operation and then creates a proxy with the publisher type from this proxy.

      Parameters

      • 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 publish data on this topic. This proxy is never null.

    • Gets a proxy to a publisher object for this topic. To publish data to a topic, a publisher calls this operation and then creates a proxy with the publisher type from this proxy. If a replicated IceStorm deployment is used, this call may return a replicated proxy.

      Parameters

      • 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 publish data on this topic. This proxy is never null.

    • Gets the list of subscribers for this topic.

      Parameters

      • current: Current

        The Current object for the dispatch.

      Returns Identity[] | PromiseLike<Identity[]>

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

      • Ice.Identity[] : The sequence of Ice identities for the subscriber objects.

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

    • Creates a link to another topic. All events originating on this topic will also be sent to the other topic.

      Parameters

      • linkTo: TopicPrx

        The topic to link to. This proxy cannot be null.

      • cost: number

        The cost of the link.

      • current: Current

        The Current object for the dispatch.

      Returns void | PromiseLike<void>

      A promise like object representing the result of the dispatch.

      IceStorm.LinkExists Thrown when a link to linkTo already exists.

    • Subscribes to this topic.

      Parameters

      • theQoS: Map<string, string>

        The quality of service parameters for this subscription.

      • subscriber: ObjectPrx

        The subscriber's proxy. This proxy cannot be null.

      • 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 : The per-subscriber publisher proxy. This proxy is never null.

      IceStorm.AlreadySubscribed Thrown when subscriber is already subscribed.

      IceStorm.BadQoS Thrown when theQoS is unavailable or invalid.

      #unsubscribe

    • Destroys a link from this topic to the provided topic.

      Parameters

      • linkTo: TopicPrx

        The topic to destroy the link to. This proxy cannot be null.

      • current: Current

        The Current object for the dispatch.

      Returns void | PromiseLike<void>

      A promise like object representing the result of the dispatch.

      IceStorm.NoSuchLink Thrown when a link to linkTo does not exist.

    • Unsubscribes the provided subscriber from this topic.

      Parameters

      • subscriber: ObjectPrx

        A proxy to an existing subscriber. 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.

      #subscribeAndGetPublisher

    • Obtains the Slice type ID of this type.

      Returns string

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

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods