mirror of
https://github.com/SquidDev-CC/CC-Tweaked
synced 2024-06-25 22:53:22 +00:00
173ea72001
OK, so let's get this out of the way, there's some actual changes mixed in here too. I'm really sorry: - Turtles can now not be renamed with unnamed item tags (previously it would clear the name, this seemed a little unideal). - commands.getBlock(s)Data will also include NBT. Now, onto the horror story which is these inspection changes: - Make a lot of methods static - Typo fixes - Make utility classes final + private constructor - Lots of reformatting (ifs -> ternary, invert control flow, etc...) - ??? - Profit! I'm so going to regret this - can pretty much guarantee this is going to break something.
79 lines
2.6 KiB
Java
79 lines
2.6 KiB
Java
/*
|
|
* This file is part of ComputerCraft - http://www.computercraft.info
|
|
* Copyright Daniel Ratcliffe, 2011-2019. Do not distribute without permission.
|
|
* Send enquiries to dratcliffe@gmail.com
|
|
*/
|
|
|
|
package dan200.computercraft.api.peripheral;
|
|
|
|
import javax.annotation.Nonnull;
|
|
import java.util.Objects;
|
|
import java.util.concurrent.TimeUnit;
|
|
|
|
/**
|
|
* Monitors "work" associated with a computer, keeping track of how much a computer has done, and ensuring every
|
|
* computer receives a fair share of any processing time.
|
|
*
|
|
* This is primarily intended for work done by peripherals on the main thread (such as on a tile entity's tick), but
|
|
* could be used for other purposes (such as complex computations done on another thread).
|
|
*
|
|
* Before running a task, one should call {@link #canWork()} to determine if the computer is currently allowed to
|
|
* execute work. If that returns true, you should execute the task and use {@link #trackWork(long, TimeUnit)} to inform
|
|
* the monitor how long that task took.
|
|
*
|
|
* Alternatively, use {@link #runWork(Runnable)} to run and keep track of work.
|
|
*
|
|
* @see IComputerAccess#getMainThreadMonitor()
|
|
*/
|
|
public interface IWorkMonitor
|
|
{
|
|
/**
|
|
* If the owning computer is currently allowed to execute work.
|
|
*
|
|
* @return If we can execute work right now.
|
|
*/
|
|
boolean canWork();
|
|
|
|
/**
|
|
* If the owning computer is currently allowed to execute work, and has ample time to do so.
|
|
*
|
|
* This is effectively a more restrictive form of {@link #canWork()}. One should use that in order to determine if
|
|
* you may do an initial piece of work, and shouldWork to determine if any additional task may be performed.
|
|
*
|
|
* @return If we should execute work right now.
|
|
*/
|
|
boolean shouldWork();
|
|
|
|
/**
|
|
* Inform the monitor how long some piece of work took to execute.
|
|
*
|
|
* @param time The time some task took to run
|
|
* @param unit The unit that {@code time} was measured in.
|
|
*/
|
|
void trackWork( long time, @Nonnull TimeUnit unit );
|
|
|
|
/**
|
|
* Run a task if possible, and inform the monitor of how long it took.
|
|
*
|
|
* @param runnable The task to run.
|
|
* @return If the task was actually run (namely, {@link #canWork()} returned {@code true}).
|
|
*/
|
|
default boolean runWork( @Nonnull Runnable runnable )
|
|
{
|
|
Objects.requireNonNull( runnable, "runnable should not be null" );
|
|
if( !canWork() ) return false;
|
|
|
|
long start = System.nanoTime();
|
|
try
|
|
{
|
|
runnable.run();
|
|
}
|
|
finally
|
|
{
|
|
trackWork( System.nanoTime() - start, TimeUnit.NANOSECONDS );
|
|
}
|
|
|
|
return true;
|
|
}
|
|
}
|