Interface TopicDependencies


  • public interface TopicDependencies
    The dependencies for a topic.
    Since:
    23.03
    Author:
    Jonathan Knight 2002.09.10
    • Method Summary

      All Methods Static Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      static int computeChannelCount​(int cPartitions)
      Compute the channel count based on the supplied partition count.
      int getConfiguredChannelCount()
      Returns the number of channels configured for the topic, or PagedTopic.DEFAULT_CHANNEL_COUNT to indicate that the topic uses the default number of channels.
      NamedTopic.ElementCalculator getElementCalculator()
      Return the calculator used to calculate element sizes.
      long getElementExpiryMillis()
      Obtain the expiry delay to apply to elements in ths topic.
      long getMaxBatchSizeBytes()
      Return the maximum size of a batch.
      long getNotificationTimeout()
      Returns the timeout that a subscriber will use when waiting for its first allocation of channels.
      long getReconnectRetryMillis()
      Return the amount of time publishers and subscribers will wait between attempts to reconnect after being disconnected.
      long getReconnectTimeoutMillis()
      Returns the maximum amount of time publishers and subscribers will attempt to reconnect after being disconnected.
      long getReconnectWaitMillis()
      Return the amount of time publishers and subscribers will wait before attempting to reconnect after being disconnected.
      long getSubscriberTimeoutMillis()
      Returns number of milliseconds within which a subscriber must issue a heartbeat or be forcefully considered closed.
      boolean isAllowUnownedCommits()
      Returns true if the topic allows commits of a position in a channel to be made by subscribers that do not own the channel.
      boolean isOnlyOwnedCommits()
      Returns true if the topic only allows commits of a position in a channel to be made by subscribers that own the channel.
      boolean isRetainConsumed()
      Returns true if this topic retains messages after they have been committed or false if messages are removed after all known subscribers have committed them.
    • Method Detail

      • getConfiguredChannelCount

        int getConfiguredChannelCount()
        Returns the number of channels configured for the topic, or PagedTopic.DEFAULT_CHANNEL_COUNT to indicate that the topic uses the default number of channels.

        This number may be less than the actual number of channels, which is controlled by the TopicService, if another cluster member has configured a higher number of channels.

        The actual number of channels in use for a topic can be obtained by calling the TopicService.getChannelCount(String) method.

        Returns:
        the number of channels configured for the topic
      • computeChannelCount

        static int computeChannelCount​(int cPartitions)
        Compute the channel count based on the supplied partition count.
        Parameters:
        cPartitions - the partition count
        Returns:
        the channel count based on the supplied partition count
      • getElementExpiryMillis

        long getElementExpiryMillis()
        Obtain the expiry delay to apply to elements in ths topic.
        Returns:
        the expiry delay to apply to elements in ths topic
      • getMaxBatchSizeBytes

        long getMaxBatchSizeBytes()
        Return the maximum size of a batch.
        Returns:
        the max batch size
      • isRetainConsumed

        boolean isRetainConsumed()
        Returns true if this topic retains messages after they have been committed or false if messages are removed after all known subscribers have committed them.
        Returns:
        true if this topic retains messages after they have been committed or false if messages are removed after all known subscribers have committed them
      • getSubscriberTimeoutMillis

        long getSubscriberTimeoutMillis()
        Returns number of milliseconds within which a subscriber must issue a heartbeat or be forcefully considered closed.
        Returns:
        number of milliseconds within which a subscriber must issue a heartbeat
      • getNotificationTimeout

        long getNotificationTimeout()
        Returns the timeout that a subscriber will use when waiting for its first allocation of channels.
        Returns:
        the timeout that a subscriber will use when waiting for its first allocation of channels
      • isAllowUnownedCommits

        boolean isAllowUnownedCommits()
        Returns true if the topic allows commits of a position in a channel to be made by subscribers that do not own the channel.
        Returns:
        true if the topic allows commits of a position in a channel to be made by subscribers that do not own the channel
      • isOnlyOwnedCommits

        boolean isOnlyOwnedCommits()
        Returns true if the topic only allows commits of a position in a channel to be made by subscribers that own the channel.
        Returns:
        true if the topic only allows commits of a position in a channel to be made by subscribers that own the channel
      • getElementCalculator

        NamedTopic.ElementCalculator getElementCalculator()
        Return the calculator used to calculate element sizes.
        Returns:
        the calculator used to calculate element sizes
      • getReconnectTimeoutMillis

        long getReconnectTimeoutMillis()
        Returns the maximum amount of time publishers and subscribers will attempt to reconnect after being disconnected.
        Returns:
        the maximum amount of time publishers and subscribers will attempt to reconnect after being disconnected
      • getReconnectRetryMillis

        long getReconnectRetryMillis()
        Return the amount of time publishers and subscribers will wait between attempts to reconnect after being disconnected.
        Returns:
        the maximum amount of time publishers and subscribers will wait between attempts to reconnect after being disconnected
      • getReconnectWaitMillis

        long getReconnectWaitMillis()
        Return the amount of time publishers and subscribers will wait before attempting to reconnect after being disconnected.
        Returns:
        the maximum amount of time publishers and subscribers will wait before attempting to reconnect after being disconnected