Package cdc.perfs.api

Interface RuntimeProbe


  • public interface RuntimeProbe
    Used to create RuntimeMeasures at a certain level.

    A RuntimeProbe can be created from the RuntimeEnvironment.

    Author:
    Damien Carbonne
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      MeasureLevel getLevel()  
      Source getSource()  
      boolean isEnabled()
      Returns whether this probe is enabled or not.
      void restart()
      Stops the current measure, if any, and start a new one with no detail.
      void restart​(String details)
      Stops the current measure, if any, and start a new one with a given detail.
      void start()
      Starts a new measure with no (null) detail.
      void start​(String details)
      Starts a new measure corresponding to a detail.
      void stop()
      Stops the current measure, if any.
    • Method Detail

      • getSource

        Source getSource()
        Returns:
        The associated source.
      • getLevel

        MeasureLevel getLevel()
        Returns:
        The level of generated measures.
      • isEnabled

        boolean isEnabled()
        Returns whether this probe is enabled or not.

        A measure will be effectively done only when enabled.

        Returns:
        Whether this probe is enabled or not.
      • start

        void start​(String details)
        Starts a new measure corresponding to a detail.
        Parameters:
        details - Details associated to the measure.
      • start

        void start()
        Starts a new measure with no (null) detail.
      • restart

        void restart​(String details)
        Stops the current measure, if any, and start a new one with a given detail.

        If no current measure is running, an error measure will be generated.

        Parameters:
        details - Details associated to the new measure.
      • restart

        void restart()
        Stops the current measure, if any, and start a new one with no detail.
      • stop

        void stop()
        Stops the current measure, if any.

        Otherwise, creates a measure indicating the error.