cufy.concurrent

Class Instructor

java.lang.Object

cufy.concurrent.Instructor

public class Instructor
extends java.lang.Object

Used to be the communication method between 2 (or more) threads (loops). Used as a tasks list for unknown count unknown state loops.

Since:

18 May 2019

Version:

0.1.3

Author:

lsafer

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<Loop<?,?>>	loops Loops that linked to this.
protected java.util.List<java.util.function.BiFunction<Instructor,Loop<?,?>,java.lang.Boolean>>	posts All undone posts of this group.
protected java.util.concurrent.atomic.AtomicReference<java.lang.String>	state The first position of any further loop get started by this.

Constructor Summary

Constructors

Constructor and Description
Instructor()

Method Summary

Modifier and Type	Method and Description
java.util.List<Loop<?,?>>	getLoops() Get the loops of this loop.
Instructor	getLoops(java.util.function.Consumer<java.util.List<Loop<?,?>>> action) Do the given action to the loops of this.
java.util.List<java.util.function.BiFunction<Instructor,Loop<?,?>,java.lang.Boolean>>	getPosts() Get the posts of this loop.
Instructor	getPosts(java.util.function.Consumer<java.util.List<java.util.function.BiFunction<Instructor,Loop<?,?>,java.lang.Boolean>>> action) Do the given action to the posts of this.
java.util.concurrent.atomic.AtomicReference<java.lang.String>	getState() Get the state of this loop.
Instructor	getState(java.util.function.Consumer<java.lang.String> action) Do the given action to the state of this.
boolean	isAlive() Get if this group is alive or not.
Instructor	join() Waits for all loops of this group to die.
Instructor	join(java.util.function.Consumer<Instructor> alter, long millis) Waits at most millis milliseconds for all loops of this group to die.
Instructor	notify(java.lang.String state) Update the state of every currently or further running loops in this group.
Instructor	pair() Wait until make sure that there is a running loop on this group.
Instructor	post(java.util.function.BiFunction<Instructor,Loop<?,?>,java.lang.Boolean> action) Make a loop of this group do the given action.
Instructor	post(java.util.function.BiFunction<Instructor,Loop<?,?>,java.lang.Boolean> action, java.util.function.Consumer<Instructor> alter) Make a loop of this group do the given action.
Instructor	post(java.util.function.BiFunction<Instructor,Loop<?,?>,java.lang.Boolean> action, java.util.function.Consumer<Instructor> alter, long timeout) Make a loop of this group do the given action.
Instructor	start(Loop<?,?> loop) Start a loop using this Instructor.
Instructor	synchronously(java.util.function.BiConsumer<Instructor,Loop<?,?>> action) Make a loop of this group do the given action.
Instructor	synchronously(java.util.function.BiConsumer<Instructor,Loop<?,?>> action, java.util.function.Consumer<Instructor> alter) Make a loop of this group do the given action.
Instructor	synchronously(java.util.function.BiConsumer<Instructor,Loop<?,?>> action, java.util.function.Consumer<Instructor> alter, long timeout) Make a loop of this group do the given action.
Instructor	thread(Loop<?,?> loop) Start the given loop with a new thread.
Instructor	tick() Do the posts posted on this group.
Instructor	tick(Loop<?,?> caller) Do the posts posted on this group.

Methods inherited from class java.lang.Object

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

Field Detail

loops

protected final java.util.List<Loop<?,?>> loops

Loops that linked to this.

Note: synchronized use only.

posts

protected final java.util.List<java.util.function.BiFunction<Instructor,Loop<?,?>,java.lang.Boolean>> posts

All undone posts of this group.

Note: synchronized use only.

state

protected final java.util.concurrent.atomic.AtomicReference<java.lang.String> state

The first position of any further loop get started by this.

Note: synchronized use only.

Constructor Detail

Instructor

public Instructor()

Method Detail

getLoops

public java.util.List<Loop<?,?>> getLoops()

Get the loops of this loop.

Returns:

the loops list of this group

See Also:

getLoops(Consumer)

getLoops

public Instructor getLoops(java.util.function.Consumer<java.util.List<Loop<?,?>>> action)

Do the given action to the loops of this. with a locked access.

Note: this may not be useful if this loop rapidly starts and finishes

Parameters:

action - to be done to the loops list of this

Returns:

this

Throws:

java.lang.NullPointerException - if the given 'action' is null

See Also:

getLoops()

getPosts

public java.util.List<java.util.function.BiFunction<Instructor,Loop<?,?>,java.lang.Boolean>> getPosts()

Get the posts of this loop.

Returns:

the posts list of this group

See Also:

getPosts(Consumer)

getPosts

public Instructor getPosts(java.util.function.Consumer<java.util.List<java.util.function.BiFunction<Instructor,Loop<?,?>,java.lang.Boolean>>> action)

Do the given action to the posts of this. with a locked access.

Parameters:

action - to be done to the posts list of this

Returns:

this

Throws:

java.lang.NullPointerException - if the given 'action' is null

See Also:

getPosts()

getState

public java.util.concurrent.atomic.AtomicReference<java.lang.String> getState()

Get the state of this loop.

Returns:

the state instance of this group

See Also:

getState(Consumer)

getState

public Instructor getState(java.util.function.Consumer<java.lang.String> action)

Do the given action to the state of this. with a locked access.

Parameters:

action - to be done to the state instance of this

Returns:

this

Throws:

java.lang.NullPointerException - if the given 'action' is null

See Also:

getState()

isAlive

public boolean isAlive()

Get if this group is alive or not.

Note: this may not be useful if this loop rapidly starts and finishes

Returns:

whether this group is alive or not.

See Also:

Loop.isAlive()

join

public Instructor join()

Waits for all loops of this group to die.

Note: this may not be useful if this loop rapidly starts and finishes

Returns:

this

See Also:

Loop.join()

join

public Instructor join(java.util.function.Consumer<Instructor> alter,
                       long millis)

Waits at most millis milliseconds for all loops of this group to die.

Note: this may not be useful if this loop rapidly starts and finishes

Parameters:

alter - what to do when the timeout is done

millis - the time to wait in milliseconds

Returns:

this

Throws:

java.lang.IllegalArgumentException - if the value of millis is negative

java.lang.NullPointerException - if the given alter is null

See Also:

Loop.join(Consumer, long)

notify

public Instructor notify(java.lang.String state)

Update the state of every currently or further running loops in this group.

Parameters:

state - the new state

Returns:

this

Throws:

java.lang.NullPointerException - if the given state is null

See Also:

Loop.notify(String)

pair

public Instructor pair()

Wait until make sure that there is a running loop on this group. By adding a new post and wait until get executed. Useful when starting a new loop on a new thread. To make sure that that loop started running.

Returns:

this

See Also:

Loop.pair()

post

public Instructor post(java.util.function.BiFunction<Instructor,Loop<?,?>,java.lang.Boolean> action)

Make a loop of this group do the given action. Then remove that action if the action returns false.

Parameters:

action - to be done by a loop of this group (return false to remove the action)

Returns:

this

Throws:

java.lang.NullPointerException - if the given action is null

See Also:

Loop.post(Function)

post

public Instructor post(java.util.function.BiFunction<Instructor,Loop<?,?>,java.lang.Boolean> action,
                       java.util.function.Consumer<Instructor> alter)

Make a loop of this group do the given action. hen remove that action if the action returns false. Or if this group don't have a running loop.

Note: no matter what. One (AND JUST ONE) of the given actions should be invoked.

Parameters:

action - to be done by a loop of this (return false to remove the action)

alter - the action to be done if this group don't have a running loop

Returns:

this

Throws:

java.lang.NullPointerException - if ether the given 'action' or the given 'alter' is null

See Also:

Loop.post(Function, Consumer)

post

public Instructor post(java.util.function.BiFunction<Instructor,Loop<?,?>,java.lang.Boolean> action,
                       java.util.function.Consumer<Instructor> alter,
                       long timeout)

Make a loop of this group do the given action. Then remove that action if the action returns false. Or the given timeout ended.

Note: no matter what. One (AND JUST ONE) of the given actions should be invoked.

Parameters:

action - to be done by a loop of this group

alter - to do when timeout and the action has not been done

timeout - the timeout (in milli seconds)

Returns:

this

Throws:

java.lang.NullPointerException - if ether the given 'action' or 'alter' is null

java.lang.IllegalArgumentException - if ether the given 'timeout' is negative

See Also:

Loop.post(Function, Consumer, long)

start

public Instructor start(Loop<?,?> loop)

Start a loop using this Instructor.

Parameters:

loop - to be started

Returns:

this

Throws:

java.lang.NullPointerException - if the given loop is null

See Also:

Loop.start()

synchronously

public Instructor synchronously(java.util.function.BiConsumer<Instructor,Loop<?,?>> action)

Make a loop of this group do the given action. And WAIT for that loop to do it; If the CALLER thread get interrupted while it's waiting on this method. Then the action will be canceled.

Parameters:

action - to be done by a loop of this group

Returns:

this

Throws:

java.lang.NullPointerException - if the given 'action' is null

See Also:

Loop.synchronously(Consumer)

synchronously

public Instructor synchronously(java.util.function.BiConsumer<Instructor,Loop<?,?>> action,
                                java.util.function.Consumer<Instructor> alter)

Make a loop of this group do the given action. And WAIT for that loop to do. Or if this group don't have a running loop (currently).

Note: this may not be useful if this group rapidly starts and finishes loops

Note: no matter what. One (AND JUST ONE) of the given actions should be invoked once (also, JUST ONCE).

Note: action SHOULDN'T be synchronously invoked on ANY non-local object

Parameters:

action - to be done by a loop of this group

alter - to be done if there is no loop on this group (currently)

Returns:

this

Throws:

java.lang.NullPointerException - if ether the given 'action' or 'alter' is null

See Also:

Loop.synchronously(Consumer, Consumer)

synchronously

public Instructor synchronously(java.util.function.BiConsumer<Instructor,Loop<?,?>> action,
                                java.util.function.Consumer<Instructor> alter,
                                long timeout)

Make a loop of this group do the given action. And WAIT until that loop invokes it. Or the given timeout ended.

Note: no matter what. One (AND JUST ONE) of the given actions should be invoked once (also, JUST ONCE).

Parameters:

action - to be done by a loop of this group

alter - to be done if the timeout ended

timeout - to wait for the action to be invoked (milli seconds)

Returns:

this

Throws:

java.lang.NullPointerException - if ether the given 'action' or 'alter' is null

java.lang.IllegalArgumentException - if the given 'timeout' is negative

See Also:

Loop.synchronously(Consumer, Consumer, long)

thread

public Instructor thread(Loop<?,?> loop)

Start the given loop with a new thread.

Parameters:

loop - to be started

Returns:

the new started thread

Throws:

java.lang.NullPointerException - if the given loop is null

See Also:

Loop.thread()

tick

public Instructor tick()

Do the posts posted on this group. With no caller.

Note: this designed to be called by a loop of this instructor

Returns:

this

Throws:

java.lang.NullPointerException - when a post tris doing anything to the caller without doing a null check

tick

public Instructor tick(Loop<?,?> caller)

Do the posts posted on this group. With the caller param of the given loop.

Parameters:

caller - the caller loop

Returns:

this

Throws:

java.lang.NullPointerException - when the 'caller' is null and a post tris doing anything to the caller without doing a null check

IllegalThreadException - if the 'caller' isn't null and the caller thread ins't the thread of the given loop