Enum ChannelPerformance

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      HIGH_THROUGHPUT
      Prefer to maximize messages throughput.
      LATENCY_CRITICAL
      Focus on minimizing latency even if this means heavy load on CPU.
      LOW_LATENCY
      Prefer to minimize latency at the expense of higher CPU usage (one CPU core per process)
      MIN_CPU_USAGE
      Prefer to minimize CPU usage.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean isLowLatency()  
      void toDetailedString()  
      static ChannelPerformance valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static ChannelPerformance[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Enum Constant Detail

      • MIN_CPU_USAGE

        public static final ChannelPerformance MIN_CPU_USAGE
        Prefer to minimize CPU usage. Don't do anything extra to minimize latency.
      • LOW_LATENCY

        public static final ChannelPerformance LOW_LATENCY
        Prefer to minimize latency at the expense of higher CPU usage (one CPU core per process)
      • LATENCY_CRITICAL

        public static final ChannelPerformance LATENCY_CRITICAL
        Focus on minimizing latency even if this means heavy load on CPU.

        Note: you must have free CPU cores both on client and server for that to be useful. Without that latency may be higher instead. Use LOW_LATENCY if not sure.

        • Each cursor and loader in this mode will fully consume (fully load) one CPU core on client and one CPU core on TimeBase server.
        • TimeBase server will limit number of clients that use LATENCY_CRITICAL mode. So TimeBase server may reject request for cursor (by throwing InsufficientCpuResourcesException ) if there are already too many LATENCY_CRITICAL cursors or loaders.
      • HIGH_THROUGHPUT

        public static final ChannelPerformance HIGH_THROUGHPUT
        Prefer to maximize messages throughput. For loopback connections IPC communication will be used.
    • Method Detail

      • values

        public static ChannelPerformance[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (ChannelPerformance c : ChannelPerformance.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static ChannelPerformance valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null
      • isLowLatency

        public boolean isLowLatency()
      • toDetailedString

        public void toDetailedString()