co.aikar.timings

Interface Timing

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

FullServerTickHandler, NullTimingHandler

public interface Timing
extends AutoCloseable

Provides an ability to time sections of code within the Minecraft Server

Method Summary

Modifier and Type	Method and Description
void	abort() Stops timing and disregards current timing data.
void	close()
default double	getAverage() Get Average tick time of the timing
default int	getCurrentCount() Get Current Tick total time of the timing
default int	getCurrentTotal() Get Current Tick total time of the timing
default String	getName() Get the name of the handler
co.aikar.timings.TimingHandler	getTimingHandler() Used internally to get the actual backing Handler in the case of delegated Handlers
void	startTiming() Starts timing the execution until stopTiming() is called.
void	startTimingIfSync() Starts timing the execution until stopTiming() is called.
void	stopTiming() Stops timing and records the data.
void	stopTimingIfSync() Stops timing and records the data.

Method Detail

startTiming

void startTiming()

Starts timing the execution until stopTiming() is called.

stopTiming

void stopTiming()

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

void startTimingIfSync()

Starts timing the execution until stopTiming() is called. But only if we are on the primary thread.

stopTimingIfSync

void stopTimingIfSync()

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

void abort()

Stops timing and disregards current timing data.

getTimingHandler

co.aikar.timings.TimingHandler getTimingHandler()

Used internally to get the actual backing Handler in the case of delegated Handlers

Returns:

TimingHandler

close

void close()

Specified by:

close in interface AutoCloseable

getAverage

default double getAverage()

Get Average tick time of the timing

Returns:

Average tick time

getCurrentTotal

default int getCurrentTotal()

Get Current Tick total time of the timing

Returns:

Current tick time

getCurrentCount

default int getCurrentCount()

Get Current Tick total time of the timing

Returns:

Current tick time

getName

default String getName()

Get the name of the handler

Returns:

name