Timings (SpongeAPI 7.3.0 API)

java.lang.Object
- co.aikar.timings.Timings

```
public final class Timings
extends Object
```
Utility class for creating and configuring timings.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`generateReport(CommandSource source)` Generates a report and sends it to the specified command source.
`static void`	`generateReport(MessageChannel channel)` Generates a report and sends it to the specified `MessageChannel`.
`static int`	`getHistoryInterval()` Gets the interval between timing history report generation.
`static int`	`getHistoryLength()` Gets how long in ticks timings history is kept for the server.
`static boolean`	`isTimingsEnabled()` Gets whether or not the timings system is enabled.
`static boolean`	`isVerboseTimingsEnabled()` Gets whether or not the verbose level of timings is enabled.
`static Timing`	`of(Object plugin, String name)` Gets a `Timing` for a plugin corresponding to a name.
`static Timing`	`of(Object plugin, String name, Timing groupHandler)` Gets a handler that has a groupHandler timer handler.
`static Timing`	`ofStart(Object plugin, String name)` Returns a `Timing` object after starting it, useful for try-with-resources.
`static Timing`	`ofStart(Object plugin, String name, Timing groupHandler)` Returns a `Timing` object after starting it, useful for try-with-resources.
`static void`	`reset()` Resets all timing data.
`static void`	`setHistoryInterval(int interval)` Sets the interval between timing history report generations.
`static void`	`setHistoryLength(int length)` Sets how long timing history reports are kept for the server.
`static void`	`setTimingsEnabled(boolean enabled)` Sets whether or not the timings system should be enabled.
`static void`	`setVerboseTimingsEnabled(boolean enabled)` Sets whether or not the timings should monitor at verbose level.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - of
```
public static Timing of(Object plugin,
                        String name)
```
    Gets a Timing for a plugin corresponding to a name.
    
    Parameters:
    
    plugin - The plugin instance to own the timing
    
    name - Name of the timing
    
    Returns:
    
    A Timing instance
  - of
```
public static Timing of(Object plugin,
                        String name,
                        Timing groupHandler)
```
    Gets a handler that has a groupHandler timer handler. Parent timers should not have their start/stop methods called directly, as the children will call it for you.
    Parent timers are used to group multiple subsections together and get a summary of them combined parent handler can not be changed after first call.
    
    Parameters:
    
    plugin - The plugin instance to own the timing
    
    name - Name of the timing
    
    groupHandler - Parent handler to mirror .start/stop calls to
    
    Returns:
    
    A Timing instance
  - ofStart
```
public static Timing ofStart(Object plugin,
                             String name)
```
    Returns a Timing object after starting it, useful for try-with-resources.
```
 try (Timing ignored = Timings.ofStart(plugin, someName)) {
     // timed section
 }
 
```
    Parameters:
    
    plugin - Plugin to own the timing
    
    name - Name of timing
    
    Returns:
    
    A Timing instance
  - ofStart
```
public static Timing ofStart(Object plugin,
                             String name,
                             Timing groupHandler)
```
    Returns a Timing object after starting it, useful for try-with-resources.
```
 try (Timing ignored = Timings.ofStart(plugin, someName,
         groupHandler)) {
     // timed section
 }
 
```
    Parameters:
    
    plugin - Plugin to own the timing
    
    name - Name of timing
    
    groupHandler - Parent handler to mirror start/stop calls to
    
    Returns:
    
    A Timing instance
  - isTimingsEnabled
```
public static boolean isTimingsEnabled()
```
    Gets whether or not the timings system is enabled.
    
    Returns:
    
    Enabled or not
  - setTimingsEnabled
```
public static void setTimingsEnabled(boolean enabled)
```
    Sets whether or not the timings system should be enabled.
    Calling this will reset timing data.
    
    Parameters:
    
    enabled - Should timings be reported
  - isVerboseTimingsEnabled
```
public static boolean isVerboseTimingsEnabled()
```
    Gets whether or not the verbose level of timings is enabled.
    When verbose is disabled, high-frequency timings will not be available.
    
    Returns:
    
    Enabled or not
  - setVerboseTimingsEnabled
```
public static void setVerboseTimingsEnabled(boolean enabled)
```
    Sets whether or not the timings should monitor at verbose level.
    When verbose is disabled, high-frequency timings will not be available. Calling this will reset timing data.
    
    Parameters:
    
    enabled - Should high-frequency timings be reported
  - getHistoryInterval
```
public static int getHistoryInterval()
```
    Gets the interval between timing history report generation.
    
    Returns:
    
    Interval in ticks
  - setHistoryInterval
```
public static void setHistoryInterval(int interval)
```
    Sets the interval between timing history report generations.
    This will re-check your history length, so lowering this value will lower your history length if you need more than 60 history windows.
    
    Parameters:
    
    interval - Interval in ticks
  - getHistoryLength
```
public static int getHistoryLength()
```
    Gets how long in ticks timings history is kept for the server.
    
    Returns:
    
    Duration in ticks
  - setHistoryLength
```
public static void setHistoryLength(int length)
```
    Sets how long timing history reports are kept for the server.
    This value is capped at a maximum of getHistoryInterval() * MAX_HISTORY_FRAMES (12).
    
    Will not reset timing data but may truncate old history if the new length is less than old length.
    
    Parameters:
    
    length - Duration in ticks
  - reset
```
public static void reset()
```
    Resets all timing data.
  - generateReport
```
public static void generateReport(@Nullable
                                  CommandSource source)
```
    Generates a report and sends it to the specified command source.
    If source is null, the ConsoleSource will be used.
    
    Parameters:
    
    source - The source to show the report to
  - generateReport
```
public static void generateReport(MessageChannel channel)
```
    Generates a report and sends it to the specified MessageChannel.
    
    Parameters:
    
    channel - The channel to send report to

Class Timings

Method Summary

Methods inherited from class java.lang.Object

Method Detail

of

of

ofStart

ofStart

isTimingsEnabled

setTimingsEnabled

isVerboseTimingsEnabled

setVerboseTimingsEnabled

getHistoryInterval

setHistoryInterval

getHistoryLength

setHistoryLength

reset

generateReport

generateReport