com.madara.threads

Class Threader

java.lang.Object

com.madara.MadaraJNI

com.madara.threads.Threader

public class Threader
extends MadaraJNI

A manager of user threads

Constructor Summary

Constructors

Constructor and Description
Threader() Default constructor
Threader(KnowledgeBase dataPlane) Constructor with data plane

Method Summary

Modifier and Type	Method and Description
protected void	finalize() Cleans up underlying C resources
void	free() Deletes the C++ instantiation.
void	pause() Requests all threads to pause
void	pause(java.lang.String name) Requests for the specified thread to pause
void	resume() Requests all threads to resume if paused
void	resume(java.lang.String name) Requests for the specified thread to resume if paused
void	run(double hertz, java.lang.String name, BaseThread thread) Runs a thread.
void	run(java.lang.String name, BaseThread thread) Runs a thread.
void	startPaused(double hertz, java.lang.String name, BaseThread thread) Starts a thread in a paused state.
void	startPaused(java.lang.String name, BaseThread thread) Starts a thread in a paused state.
void	terminate() Requests all threads to terminate
void	terminate(java.lang.String name) Requests for the specified thread to terminate
void	waitForThread(java.lang.String name) Waits for a specific thread to finish
void	waitForThreads() Waits for all threads to finish

Methods inherited from class com.madara.MadaraJNI

getCPtr, setCPtr, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

Threader

public Threader()

Default constructor

Threader

public Threader(KnowledgeBase dataPlane)

Constructor with data plane

Parameters:

dataPlane - the knowledge base for threads to use for data

Method Detail

free

public void free()

Deletes the C++ instantiation. To prevent memory leaks, this must be called before an instance of Threader gets garbage collected

finalize

protected void finalize()
                 throws java.lang.Throwable

Cleans up underlying C resources

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable - necessary for override but unused

run

public void run(java.lang.String name,
                BaseThread thread)

Runs a thread. The thread's run method will only be called once.

Parameters:

name - the unique name of the thread

thread - the thread to run

run

public void run(double hertz,
                java.lang.String name,
                BaseThread thread)

Runs a thread. The thread's run method will be called at the specified hertz (executions of run per second)

Parameters:

hertz - the intended frequency of executions per second

name - the unique name of the thread

thread - the thread to run

startPaused

public void startPaused(java.lang.String name,
                        BaseThread thread)

Starts a thread in a paused state. Once resumed, the run method will only be called once.

Parameters:

name - the unique name of the thread

thread - the thread to start in a paused state

startPaused

public void startPaused(double hertz,
                        java.lang.String name,
                        BaseThread thread)

Starts a thread in a paused state. Once resumed, the run method will be called at the specified hertz.

Parameters:

hertz - the intended frequency of executions per second

name - the unique name of the thread

thread - the thread to start in a paused state

pause

public void pause(java.lang.String name)

Requests for the specified thread to pause

Parameters:

name - the unique name of the thread requested to pause

pause

public void pause()

Requests all threads to pause

waitForThread

public void waitForThread(java.lang.String name)

Waits for a specific thread to finish

Parameters:

name - the unique name of the thread

waitForThreads

public void waitForThreads()

Waits for all threads to finish

terminate

public void terminate(java.lang.String name)

Requests for the specified thread to terminate

Parameters:

name - the unique name of the thread

terminate

public void terminate()

Requests all threads to terminate

resume

public void resume(java.lang.String name)

Requests for the specified thread to resume if paused

Parameters:

name - the unique name of the thread

resume

public void resume()

Requests all threads to resume if paused