Class RealtimeThread

java.lang.Object

com.codename1.realtime.RealtimeThread

public final class RealtimeThread
extends Object

A thread that runs a RealtimeTask once per period. Created and started by Realtime.start(String, RealtimeParameters, RealtimeTask).

The thread applies its scheduling, runs the task's setup(), freezes allocation and then loops: wait for the next release, run cycle(). stop() ends the loop after the cycle in progress.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	STATE_FAILED	getState(): ended by a failure, see getFailure().
static final int	STATE_RUNNING	getState(): running cycles.
static final int	STATE_STARTING	getState(): created, not yet running cycles.
static final int	STATE_STOPPED	getState(): ended by stop().

Method Summary

Modifier and Type	Method	Description
Throwable	getFailure()	What ended the task when getState() is STATE_FAILED, otherwise null.
String	getName()	The name given at start.
int	getState()	One of the STATE_ constants.
RealtimeStatistics	getStatistics()	A snapshot of the thread's statistics, as of the last completed cycle.
boolean	isCpuPinned()	true when the thread was pinned to the CPU its parameters named.
boolean	isSchedulingApplied()	true when the operating system granted real-time scheduling.
void	join(long millis)	Waits for the thread to exit.
void	stop()	Ends the loop after the cycle in progress.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

STATE_STARTING

public static final int STATE_STARTING

getState(): created, not yet running cycles.

See Also:

• Constant Field Values

STATE_RUNNING

public static final int STATE_RUNNING

getState(): running cycles.

See Also:

• Constant Field Values

STATE_STOPPED

public static final int STATE_STOPPED

getState(): ended by stop().

See Also:

• Constant Field Values

STATE_FAILED

public static final int STATE_FAILED

getState(): ended by a failure, see getFailure().

See Also:

• Constant Field Values

Method Details

getName

public String getName()

The name given at start.

getState

public int getState()

One of the STATE_ constants.

getFailure

public Throwable getFailure()

What ended the task when getState() is STATE_FAILED, otherwise null.

isSchedulingApplied

public boolean isSchedulingApplied()

true when the operating system granted real-time scheduling. false on a platform without it, or a process without the privilege, where the task runs at normal priority.

isCpuPinned

public boolean isCpuPinned()

true when the thread was pinned to the CPU its parameters named.

getStatistics

public RealtimeStatistics getStatistics()

A snapshot of the thread's statistics, as of the last completed cycle.

stop

public void stop()

Ends the loop after the cycle in progress. The thread then calls the task's stopped() and exits. Returns at once; use join(long) to wait.

join

public void join(long millis)
          throws InterruptedException

Waits for the thread to exit.

Parameters

• millis: the longest to wait, 0 for no limit

Throws:

InterruptedException