Package co.aikar.timings

Interface Timing

All Superinterfaces:
AutoCloseable
All Known Implementing Classes:
FullServerTickHandler, NullTimingHandler
@Deprecated(forRemoval=true) public interface Timing extends AutoCloseable
Deprecated, for removal: This API element is subject to removal in a future version.
Timings will likely be replaced with Spark in the future
Provides an ability to time sections of code within the Minecraft Server

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    abort()
    Deprecated.
    Doesn't do anything - Removed
    void
    close()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    @Nullable co.aikar.timings.TimingHandler
    getTimingHandler()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Used internally to get the actual backing Handler in the case of delegated Handlers
    @NotNull Timing
    startTiming()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Starts timing the execution until stopTiming() is called.
    @NotNull Timing
    startTimingIfSync()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Starts timing the execution until stopTiming() is called.
    void
    stopTiming()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Stops timing and records the data.
    void
    stopTimingIfSync()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Stops timing and records the data.

  • Method Details

    • startTiming

      @NotNull @NotNull Timing startTiming()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Starts timing the execution until stopTiming() is called.
      Returns:
      Timing

    • stopTiming

      void stopTiming()
      Deprecated, for removal: This API element is subject to removal in a future version.

      Stops timing and records the data. Propagates the data up to group handlers.

      Will automatically be called when this Timing is used with try-with-resources

    • startTimingIfSync

      @NotNull @NotNull Timing startTimingIfSync()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Starts timing the execution until stopTiming() is called. But only if we are on the primary thread.
      Returns:
      Timing

    • stopTimingIfSync

      void stopTimingIfSync()
      Deprecated, for removal: This API element is subject to removal in a future version.

      Stops timing and records the data. Propagates the data up to group handlers.

      Will automatically be called when this Timing is used with try-with-resources

      But only if we are on the primary thread.

    • abort

      @Deprecated void abort()
      Deprecated.
      Doesn't do anything - Removed

    • getTimingHandler

      @Nullable @Nullable co.aikar.timings.TimingHandler getTimingHandler()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Used internally to get the actual backing Handler in the case of delegated Handlers
      Returns:
      TimingHandler

    • close

      void close()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Specified by:
      close in interface AutoCloseable