Package com.pushtechnology.diffusion.api.config

Interface ClientStatisticsConfig

All Superinterfaces:
Config
public interface ClientStatisticsConfig extends Config
Client Statistics Configuration.

This specifies configuration relating to client session statistics.

If client session statistics are enabled, a summary of the session statistics will regularly be written to the server log. These reports are published on a schedule controlled by the setOutputFrequency(long) and setResetFrequency(long).

These properties may only be set before a Diffusion Server is started.

Since:
4.4

  • Method Summary

    Modifier and Type
    Method
    Description
    long
    getOutputFrequency()
    Gets the output frequency for statistics reports to the log.
    long
    getResetFrequency()
    Gets the reset frequency.
    void
    setOutputFrequency(long frequency)
    Sets the output frequency for statistics reports to the log.
    void
    setResetFrequency(long frequency)
    Sets the reset frequency

    Methods inherited from interface com.pushtechnology.diffusion.api.config.Config

    isLocked

  • Method Details

    • getOutputFrequency

      long getOutputFrequency()
      Gets the output frequency for statistics reports to the log.
      Returns:
      output frequency in milliseconds.

    • setOutputFrequency

      void setOutputFrequency(long frequency) throws ConfigException
      Sets the output frequency for statistics reports to the log. There will be one entry written to the log every interval.

      If this is not explicitly specified, a log entry will be written every hour.

      Parameters:
      frequency - the output frequency in milliseconds.
      Throws:
      ConfigException - if unable to set frequency.

    • getResetFrequency

      long getResetFrequency()
      Gets the reset frequency.
      Returns:
      reset frequency

    • setResetFrequency

      void setResetFrequency(long frequency) throws ConfigException
      Sets the reset frequency

      Specifies when the counters are reset. Zero means that the counters are never reset.

      If this is not explicitly set, the counters are reset every hour.

      Parameters:
      frequency - the frequency in milliseconds
      Throws:
      ConfigException - if unable to set frequency