Module com.zeroc.icestorm
Package com.zeroc.IceStorm

Interface TopicPrx

All Superinterfaces:
ObjectPrx
public interface TopicPrx extends ObjectPrx
Represents an IceStorm topic. Publishers publish data to a topic (via the topic's publisher object), and subscribers subscribe to a topic.
See Also:

  • Method Details

    • getName

      default String getName()
      Gets the name of this topic.
      Returns:
      The name of the topic.
      See Also:

    • getName

      default String getName(Map<String,String> context)
      Gets the name of this topic.
      Parameters:
      context - The Context map to send with the invocation.
      Returns:
      The name of the topic.
      See Also:

    • getNameAsync

      default CompletableFuture<String> getNameAsync()
      Gets the name of this topic.
      Returns:
      The name of the topic.
      See Also:

    • getNameAsync

      default CompletableFuture<String> getNameAsync(Map<String,String> context)
      Gets the name of this topic.
      Parameters:
      context - The Context map to send with the invocation.
      Returns:
      The name of the topic.
      See Also:

    • getPublisher

      default ObjectPrx getPublisher()
      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.
      Returns:
      A proxy to publish data on this topic. This proxy is never null.

    • getPublisher

      default ObjectPrx getPublisher(Map<String,String> context)
      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:
      context - The Context map to send with the invocation.
      Returns:
      A proxy to publish data on this topic. This proxy is never null.

    • getPublisherAsync

      default CompletableFuture<ObjectPrx> getPublisherAsync()
      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.
      Returns:
      A proxy to publish data on this topic. This proxy is never null.

    • getPublisherAsync

      default CompletableFuture<ObjectPrx> getPublisherAsync(Map<String,String> context)
      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:
      context - The Context map to send with the invocation.
      Returns:
      A proxy to publish data on this topic. This proxy is never null.

    • getNonReplicatedPublisher

      default ObjectPrx getNonReplicatedPublisher()
      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.
      Returns:
      A proxy to publish data on this topic. This proxy is never null.

    • getNonReplicatedPublisher

      default ObjectPrx getNonReplicatedPublisher(Map<String,String> context)
      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:
      context - The Context map to send with the invocation.
      Returns:
      A proxy to publish data on this topic. This proxy is never null.

    • getNonReplicatedPublisherAsync

      default CompletableFuture<ObjectPrx> getNonReplicatedPublisherAsync()
      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.
      Returns:
      A proxy to publish data on this topic. This proxy is never null.

    • getNonReplicatedPublisherAsync

      default CompletableFuture<ObjectPrx> getNonReplicatedPublisherAsync(Map<String,String> context)
      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:
      context - The Context map to send with the invocation.
      Returns:
      A proxy to publish data on this topic. This proxy is never null.

    • subscribeAndGetPublisher

      default ObjectPrx subscribeAndGetPublisher(Map<String,String> theQoS, ObjectPrx subscriber) throws AlreadySubscribed, BadQoS
      Subscribes to this topic.
      Parameters:
      theQoS - The quality of service parameters for this subscription.
      subscriber - The subscriber's proxy. This proxy cannot be null.
      Returns:
      The per-subscriber publisher proxy. This proxy is never null.
      Throws:
      AlreadySubscribed - Thrown when subscriber is already subscribed.
      BadQoS - Thrown when theQoS is unavailable or invalid.
      See Also:

    • subscribeAndGetPublisher

      default ObjectPrx subscribeAndGetPublisher(Map<String,String> theQoS, ObjectPrx subscriber, Map<String,String> context) throws AlreadySubscribed, BadQoS
      Subscribes to this topic.
      Parameters:
      theQoS - The quality of service parameters for this subscription.
      subscriber - The subscriber's proxy. This proxy cannot be null.
      context - The Context map to send with the invocation.
      Returns:
      The per-subscriber publisher proxy. This proxy is never null.
      Throws:
      AlreadySubscribed - Thrown when subscriber is already subscribed.
      BadQoS - Thrown when theQoS is unavailable or invalid.
      See Also:

    • subscribeAndGetPublisherAsync

      default CompletableFuture<ObjectPrx> subscribeAndGetPublisherAsync(Map<String,String> theQoS, ObjectPrx subscriber)
      Subscribes to this topic.
      Parameters:
      theQoS - The quality of service parameters for this subscription.
      subscriber - The subscriber's proxy. This proxy cannot be null.
      Returns:
      The per-subscriber publisher proxy. This proxy is never null.
      See Also:

    • subscribeAndGetPublisherAsync

      default CompletableFuture<ObjectPrx> subscribeAndGetPublisherAsync(Map<String,String> theQoS, ObjectPrx subscriber, Map<String,String> context)
      Subscribes to this topic.
      Parameters:
      theQoS - The quality of service parameters for this subscription.
      subscriber - The subscriber's proxy. This proxy cannot be null.
      context - The Context map to send with the invocation.
      Returns:
      The per-subscriber publisher proxy. This proxy is never null.
      See Also:

    • unsubscribe

      default void unsubscribe(ObjectPrx subscriber)
      Unsubscribes the provided subscriber from this topic.
      Parameters:
      subscriber - A proxy to an existing subscriber. This proxy is never null.
      See Also:

    • unsubscribe

      default void unsubscribe(ObjectPrx subscriber, Map<String,String> context)
      Unsubscribes the provided subscriber from this topic.
      Parameters:
      subscriber - A proxy to an existing subscriber. This proxy is never null.
      context - The Context map to send with the invocation.
      See Also:

    • unsubscribeAsync

      default CompletableFuture<Void> unsubscribeAsync(ObjectPrx subscriber)
      Unsubscribes the provided subscriber from this topic.
      Parameters:
      subscriber - A proxy to an existing subscriber. This proxy is never null.
      Returns:
      A future that will be completed when the invocation completes.
      See Also:

    • unsubscribeAsync

      default CompletableFuture<Void> unsubscribeAsync(ObjectPrx subscriber, Map<String,String> context)
      Unsubscribes the provided subscriber from this topic.
      Parameters:
      subscriber - A proxy to an existing subscriber. This proxy is never null.
      context - The Context map to send with the invocation.
      Returns:
      A future that will be completed when the invocation completes.
      See Also:

    • link

      default void link(TopicPrx linkTo, int cost) throws LinkExists
      Creates a link to another topic. All events originating on this topic will also be sent to the other topic.
      Parameters:
      linkTo - The topic to link to. This proxy cannot be null.
      cost - The cost of the link.
      Throws:
      LinkExists - Thrown when a link to linkTo already exists.

    • link

      default void link(TopicPrx linkTo, int cost, Map<String,String> context) throws LinkExists
      Creates a link to another topic. All events originating on this topic will also be sent to the other topic.
      Parameters:
      linkTo - The topic to link to. This proxy cannot be null.
      cost - The cost of the link.
      context - The Context map to send with the invocation.
      Throws:
      LinkExists - Thrown when a link to linkTo already exists.

    • linkAsync

      default CompletableFuture<Void> linkAsync(TopicPrx linkTo, int cost)
      Creates a link to another topic. All events originating on this topic will also be sent to the other topic.
      Parameters:
      linkTo - The topic to link to. This proxy cannot be null.
      cost - The cost of the link.
      Returns:
      A future that will be completed when the invocation completes.

    • linkAsync

      default CompletableFuture<Void> linkAsync(TopicPrx linkTo, int cost, Map<String,String> context)
      Creates a link to another topic. All events originating on this topic will also be sent to the other topic.
      Parameters:
      linkTo - The topic to link to. This proxy cannot be null.
      cost - The cost of the link.
      context - The Context map to send with the invocation.
      Returns:
      A future that will be completed when the invocation completes.

    • unlink

      default void unlink(TopicPrx linkTo) throws NoSuchLink
      Destroys a link from this topic to the provided topic.
      Parameters:
      linkTo - The topic to destroy the link to. This proxy cannot be null.
      Throws:
      NoSuchLink - Thrown when a link to linkTo does not exist.

    • unlink

      default void unlink(TopicPrx linkTo, Map<String,String> context) throws NoSuchLink
      Destroys a link from this topic to the provided topic.
      Parameters:
      linkTo - The topic to destroy the link to. This proxy cannot be null.
      context - The Context map to send with the invocation.
      Throws:
      NoSuchLink - Thrown when a link to linkTo does not exist.

    • unlinkAsync

      default CompletableFuture<Void> unlinkAsync(TopicPrx linkTo)
      Destroys a link from this topic to the provided topic.
      Parameters:
      linkTo - The topic to destroy the link to. This proxy cannot be null.
      Returns:
      A future that will be completed when the invocation completes.

    • unlinkAsync

      default CompletableFuture<Void> unlinkAsync(TopicPrx linkTo, Map<String,String> context)
      Destroys a link from this topic to the provided topic.
      Parameters:
      linkTo - The topic to destroy the link to. This proxy cannot be null.
      context - The Context map to send with the invocation.
      Returns:
      A future that will be completed when the invocation completes.

    • getLinkInfoSeq

      default LinkInfo[] getLinkInfoSeq()
      Gets information on the current links.
      Returns:
      A sequence of LinkInfo objects.

    • getLinkInfoSeq

      default LinkInfo[] getLinkInfoSeq(Map<String,String> context)
      Gets information on the current links.
      Parameters:
      context - The Context map to send with the invocation.
      Returns:
      A sequence of LinkInfo objects.

    • getLinkInfoSeqAsync

      default CompletableFuture<LinkInfo[]> getLinkInfoSeqAsync()
      Gets information on the current links.
      Returns:
      A sequence of LinkInfo objects.

    • getLinkInfoSeqAsync

      default CompletableFuture<LinkInfo[]> getLinkInfoSeqAsync(Map<String,String> context)
      Gets information on the current links.
      Parameters:
      context - The Context map to send with the invocation.
      Returns:
      A sequence of LinkInfo objects.

    • getSubscribers

      default Identity[] getSubscribers()
      Gets the list of subscribers for this topic.
      Returns:
      The sequence of Ice identities for the subscriber objects.

    • getSubscribers

      default Identity[] getSubscribers(Map<String,String> context)
      Gets the list of subscribers for this topic.
      Parameters:
      context - The Context map to send with the invocation.
      Returns:
      The sequence of Ice identities for the subscriber objects.

    • getSubscribersAsync

      default CompletableFuture<Identity[]> getSubscribersAsync()
      Gets the list of subscribers for this topic.
      Returns:
      The sequence of Ice identities for the subscriber objects.

    • getSubscribersAsync

      default CompletableFuture<Identity[]> getSubscribersAsync(Map<String,String> context)
      Gets the list of subscribers for this topic.
      Parameters:
      context - The Context map to send with the invocation.
      Returns:
      The sequence of Ice identities for the subscriber objects.

    • destroy

      default void destroy()
      Destroys this topic.

    • destroy

      default void destroy(Map<String,String> context)
      Destroys this topic.
      Parameters:
      context - The Context map to send with the invocation.

    • destroyAsync

      default CompletableFuture<Void> destroyAsync()
      Destroys this topic.
      Returns:
      A future that will be completed when the invocation completes.

    • destroyAsync

      default CompletableFuture<Void> destroyAsync(Map<String,String> context)
      Destroys this topic.
      Parameters:
      context - The Context map to send with the invocation.
      Returns:
      A future that will be completed when the invocation completes.

    • createProxy

      static TopicPrx createProxy(Communicator communicator, String proxyString)
      Creates a new proxy that implements TopicPrx.
      Parameters:
      communicator - The communicator of the new proxy.
      proxyString - The string representation of the proxy.
      Returns:
      The new proxy.

    • checkedCast

      static TopicPrx checkedCast(ObjectPrx obj)
      Creates a new proxy from an existing proxy after confirming the target object's type via a remote invocation. Throws a local exception if a communication error occurs.
      Parameters:
      obj - The source proxy.
      Returns:
      A proxy for this type, or null if the object does not support this type.

    • checkedCast

      static TopicPrx checkedCast(ObjectPrx obj, Map<String,String> context)
      Creates a new proxy from an existing proxy after confirming the target object's type via a remote invocation. Throws a local exception if a communication error occurs.
      Parameters:
      obj - The source proxy.
      context - The Context map to send with the invocation.
      Returns:
      A new proxy for this type, or null if the object does not support this type.

    • checkedCast

      static TopicPrx checkedCast(ObjectPrx obj, String facet)
      Creates a new proxy from an existing proxy after confirming the target object's type via a remote invocation. Throws a local exception if a communication error occurs.
      Parameters:
      obj - The source proxy.
      facet - The name of the desired facet.
      Returns:
      A new proxy for this type, or null if the facet does not support this type.

    • checkedCast

      static TopicPrx checkedCast(ObjectPrx obj, String facet, Map<String,String> context)
      Creates a new proxy from an existing proxy after confirming the target object's type via a remote invocation. Throws a local exception if a communication error occurs.
      Parameters:
      obj - The source proxy.
      facet - The name of the desired facet.
      context - The Context map to send with the invocation.
      Returns:
      A new proxy for this type, or null if the object does not support this type.

    • uncheckedCast

      static TopicPrx uncheckedCast(ObjectPrx obj)
      Creates a new proxy from an existing proxy.
      Parameters:
      obj - The untyped proxy.
      Returns:
      A new proxy for this type.

    • uncheckedCast

      static TopicPrx uncheckedCast(ObjectPrx obj, String facet)
      Creates a new proxy from an existing proxy.
      Parameters:
      obj - The untyped proxy.
      facet - The name of the desired facet.
      Returns:
      A new proxy for this type.

    • ice_context

      TopicPrx ice_context(Map<String,String> newContext)
      Description copied from interface: ObjectPrx
      Creates a new proxy that is identical to this proxy, except for the per-proxy context.
      Specified by:
      ice_context in interface ObjectPrx
      Parameters:
      newContext - The context for the new proxy.
      Returns:
      A proxy with the new per-proxy context.

    • ice_adapterId

      TopicPrx ice_adapterId(String newAdapterId)
      Description copied from interface: ObjectPrx
      Creates a new proxy that is identical to this proxy, except for the adapter ID.
      Specified by:
      ice_adapterId in interface ObjectPrx
      Parameters:
      newAdapterId - The adapter ID for the new proxy.
      Returns:
      A proxy with the new adapter ID.

    • ice_endpoints

      TopicPrx ice_endpoints(Endpoint[] newEndpoints)
      Description copied from interface: ObjectPrx
      Creates a new proxy that is identical to this proxy, except for the endpoints.
      Specified by:
      ice_endpoints in interface ObjectPrx
      Parameters:
      newEndpoints - The endpoints for the new proxy.
      Returns:
      A proxy with the new endpoints.

    • ice_locatorCacheTimeout

      TopicPrx ice_locatorCacheTimeout(int newTimeout)
      Description copied from interface: ObjectPrx
      Creates a new proxy that is identical to this proxy, except for the locator cache timeout.
      Specified by:
      ice_locatorCacheTimeout in interface ObjectPrx
      Parameters:
      newTimeout - The new locator cache timeout (in seconds).
      Returns:
      A proxy with the new timeout.
      See Also:

    • ice_invocationTimeout

      TopicPrx ice_invocationTimeout(int newTimeout)
      Description copied from interface: ObjectPrx
      Returns a proxy that is identical to this proxy, except for the invocation timeout.
      Specified by:
      ice_invocationTimeout in interface ObjectPrx
      Parameters:
      newTimeout - The new invocation timeout (in milliseconds).
      Returns:
      The proxy with the new timeout.

    • ice_invocationTimeout

      TopicPrx ice_invocationTimeout(Duration newTimeout)
      Description copied from interface: ObjectPrx
      Returns a proxy that is identical to this proxy, except for the invocation timeout.
      Specified by:
      ice_invocationTimeout in interface ObjectPrx
      Parameters:
      newTimeout - The new invocation timeout.
      Returns:
      The proxy with the new timeout.

    • ice_connectionCached

      TopicPrx ice_connectionCached(boolean newCache)
      Description copied from interface: ObjectPrx
      Returns a proxy that is identical to this proxy, except for connection caching.
      Specified by:
      ice_connectionCached in interface ObjectPrx
      Parameters:
      newCache - true if the new proxy should cache connections; false otherwise.
      Returns:
      The proxy with the specified caching policy.

    • ice_endpointSelection

      TopicPrx ice_endpointSelection(EndpointSelectionType newType)
      Description copied from interface: ObjectPrx
      Returns a proxy that is identical to this proxy, except for the endpoint selection policy.
      Specified by:
      ice_endpointSelection in interface ObjectPrx
      Parameters:
      newType - The new endpoint selection policy.
      Returns:
      The proxy with the specified endpoint selection policy.
      See Also:

    • ice_encodingVersion

      TopicPrx ice_encodingVersion(EncodingVersion e)
      Description copied from interface: ObjectPrx
      Returns a proxy that is identical to this proxy, except for the encoding used to marshal parameters.
      Specified by:
      ice_encodingVersion in interface ObjectPrx
      Parameters:
      e - The encoding version to use to marshal request parameters.
      Returns:
      The proxy with the specified encoding version.

    • ice_router

      TopicPrx ice_router(RouterPrx router)
      Description copied from interface: ObjectPrx
      Returns a proxy that is identical to this proxy, except for the router.
      Specified by:
      ice_router in interface ObjectPrx
      Parameters:
      router - The router for the new proxy.
      Returns:
      The proxy with the specified router.

    • ice_locator

      TopicPrx ice_locator(LocatorPrx locator)
      Description copied from interface: ObjectPrx
      Returns a proxy that is identical to this proxy, except for the locator.
      Specified by:
      ice_locator in interface ObjectPrx
      Parameters:
      locator - The locator for the new proxy.
      Returns:
      The proxy with the specified locator.

    • ice_collocationOptimized

      TopicPrx ice_collocationOptimized(boolean b)
      Description copied from interface: ObjectPrx
      Returns a proxy that is identical to this proxy, except for collocation optimization.
      Specified by:
      ice_collocationOptimized in interface ObjectPrx
      Parameters:
      b - true if the new proxy enables collocation optimization; false otherwise.
      Returns:
      The proxy with the specified collocation optimization.

    • ice_twoway

      TopicPrx ice_twoway()
      Description copied from interface: ObjectPrx
      Creates a new proxy that is identical to this proxy, but uses twoway invocations.
      Specified by:
      ice_twoway in interface ObjectPrx
      Returns:
      A proxy that uses twoway invocations.

    • ice_oneway

      TopicPrx ice_oneway()
      Description copied from interface: ObjectPrx
      Creates a new proxy that is identical to this proxy, but uses oneway invocations.
      Specified by:
      ice_oneway in interface ObjectPrx
      Returns:
      A proxy that uses oneway invocations.

    • ice_batchOneway

      TopicPrx ice_batchOneway()
      Description copied from interface: ObjectPrx
      Creates a new proxy that is identical to this proxy, but uses batch oneway invocations.
      Specified by:
      ice_batchOneway in interface ObjectPrx
      Returns:
      A proxy that uses batch oneway invocations.

    • ice_datagram

      TopicPrx ice_datagram()
      Description copied from interface: ObjectPrx
      Creates a new proxy that is identical to this proxy, but uses datagram invocations.
      Specified by:
      ice_datagram in interface ObjectPrx
      Returns:
      A proxy that uses datagram invocations.

    • ice_batchDatagram

      TopicPrx ice_batchDatagram()
      Description copied from interface: ObjectPrx
      Creates a new proxy that is identical to this proxy, but uses batch datagram invocations.
      Specified by:
      ice_batchDatagram in interface ObjectPrx
      Returns:
      A proxy that uses batch datagram invocations.

    • ice_compress

      TopicPrx ice_compress(boolean co)
      Description copied from interface: ObjectPrx
      Returns a proxy that is identical to this proxy, except for its compression setting which overrides the compression setting from the proxy endpoints.
      Specified by:
      ice_compress in interface ObjectPrx
      Parameters:
      co - true enables compression for the new proxy; false disables compression.
      Returns:
      A proxy with the specified compression setting.

    • ice_connectionId

      TopicPrx ice_connectionId(String connectionId)
      Description copied from interface: ObjectPrx
      Returns a proxy that is identical to this proxy, except for its connection ID.
      Specified by:
      ice_connectionId in interface ObjectPrx
      Parameters:
      connectionId - The connection ID for the new proxy. An empty string removes the connection ID.
      Returns:
      A proxy with the specified connection ID.

    • ice_fixed

      TopicPrx ice_fixed(Connection connection)
      Description copied from interface: ObjectPrx
      Creates a new proxy that is identical to this proxy, except it's a fixed proxy bound to the given connection.
      Specified by:
      ice_fixed in interface ObjectPrx
      Parameters:
      connection - The fixed proxy connection.
      Returns:
      A fixed proxy bound to the given connection.

    • ice_staticId

      static String ice_staticId()
      Gets the type ID of the associated Slice interface.
      Returns:
      the string "::IceStorm::Topic"