Package com.planet_ink.coffee_mud.Libraries.interfaces

Interface ThreadEngine

All Superinterfaces:

java.lang.Cloneable, CMLibrary, CMObject, java.lang.Comparable<CMObject>, java.lang.Runnable

All Known Implementing Classes:

ServiceEngine

public interface ThreadEngine
extends CMLibrary, java.lang.Runnable

Low level task and thread management system, which contains its own internal respect for the "thread group id" system used by CoffeeMud. This is where all repeating things are scheduled, and new tasks launched. A Tick is a global unit of time, usually 4 seconds. A Ticker or TickClient is an object that receives cpu time, usually every Tick, and gives that time to a Tickable. A Tickable is a normal common CoffeeMud object, such as a mob or item, that needs cpu time. A Tick Group is a collection of Tickers that, for efficiency, tick in a sequence, but at the same rate (usually once per Tick).

Field Summary

Fields inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject

idConverter

Method Summary

Modifier and Type	Method	Description
void	clearDebri(Room room, TickableGroup.LocalType typeCode)	Deletes the ticks of all the objects in the room of the given type.
boolean	deleteTick(Tickable E, int tickID)	Searches the TickGroups for the given Tickable, on the given tickID, and deletes it.
void	dumpDebugStack(java.lang.String ID, java.lang.Thread theThread)	Dumps a stack trace, logging with the given ID
void	executeRunnable(char threadGroupId, java.lang.Runnable R)	Execute a runnable in an available thread, right now, or as soon as humanly possible.
void	executeRunnable(java.lang.Runnable R)	Execute a runnable in an available thread, right now, or as soon as humanly possible.
void	executeRunnable(java.lang.String threadGroupName, java.lang.Runnable R)	Execute a runnable in an available thread, right now, or as soon as humanly possible.
java.lang.Runnable	findRunnableByThread(java.lang.Thread thread)	This is used for determining the runner on the given thread, which involves scanning thread pools for some reason?
java.util.List<TickClient>	findTickClient(java.lang.String name, boolean exactOnly)	Finds all the TickClients with tickers matching the given name.
java.util.List<Tickable>	getNamedTickingObjects(java.lang.String name)	Does an In-String search of all ticking objects and returns them.
java.lang.String	getSystemReport(java.lang.String itemCode)	Retreives special thread related information about map objects.
long	getTickGroupPeriod(Tickable E, int tickID)	Searches the TickGroups for the given Tickable, and returns the number of milliseconds that its tick group is using as a "tick".
java.lang.String	getTickInfoReport(java.lang.String which)	Retreives special internal information from the thread engine of the callers thread group, mostly for the web server.
java.lang.String	getTickStatusSummary(Tickable obj)	A bit out of date, this returns the status of the given ticking object as a descriptive string.
long	getTimeMsToNextTick(Tickable E, int tickID)	Searches the TickGroups for the given Tickable, and returns the number of miliseconds (roughly) before it will tick again.
boolean	isAllSuspended()	Returns whether all threads are currently in the global suspended thread.
boolean	isSuspended(Tickable E, int tickID)	Returns whether the given Tickable is currently suspended from receiving tick time, despite being assigned a tick group.
boolean	isTicking(Tickable E, int tickID)	Searches the TickGroups for the given Tickable, returning true if it was found still registered to a Tick Client.
void	rejuv(Room here, int tickID)	Given a map room, this will find all the rejuvable items and mobs associated with the room and force them to respawn.
void	resumeAll()	Resumes all thread ticking, assuming they were all previously suspended.
void	resumeTicking(Tickable E, int tickID)	Resumes the thread time for this tick, if it was previously suspended.
void	scheduleRunnable(java.lang.Runnable R, long ellapsedMs)	Schedule a runnable to be executed in the future.
boolean	setTickPending(Tickable E, int tickID)	If the given Tickable is waiting multiple ticks before they get time, this will set them to pending, meaning they will wake up on the very next opportunity.
TickClient	startTickDown(Tickable E, int tickID, int numTicks)	Starts a standard repeating "ticker", on standard Tick time.
TickClient	startTickDown(Tickable E, int tickID, long tickTimeMs, int numTicks)	Starts a standard repeating "ticker", but with a custom Tick time.
void	suspendAll(CMRunnable[] exceptRs)	Suspend all threads, preventing anything from getting official tick time, except for the given runnable, typically a Session.
void	suspendResumeRecurse(CMObject O, boolean skipEmbeddedAreas, boolean suspend)	Suspends or Resumes all embedded mobs, items, etc inside the given area, room, mob, etc.
void	suspendTicking(Tickable E, int tickID)	Suspends any actual thread time for this tick, without removing it from its tick group.
void	tickAllTickers(Room here)	Given a map room, this will find and force-tick every one of those objects, on the current tick group.
java.util.Iterator<TickableGroup>	tickGroups()	Returns an iterator over all the existing tick groups.
boolean	unTickAll(Tickable E)	A special method that deletes all known ticks of all tick ids from the given object, but also deletes all ticks of any objects dependent on it, such as item on mobs, effects on things, in rooms, etc.

Methods inherited from interface com.planet_ink.coffee_mud.Libraries.interfaces.CMLibrary

activate, getServiceClient, L, propertiesLoaded, shutdown

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject

copyOf, ID, initializeClass, name, newInstance

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface java.lang.Runnable

run

Method Detail

startTickDown

TickClient startTickDown(Tickable E,
                         int tickID,
                         long tickTimeMs,
                         int numTicks)

Starts a standard repeating "ticker", but with a custom Tick time.

Parameters:

E - The Ticking object

tickID - the tick id denoting the type of event

tickTimeMs - the time between ticks, usually global

numTicks - the number of given ticks between Tickable ticks

Returns:

the TickClient inside which the Tickable is placed

startTickDown

TickClient startTickDown(Tickable E,
                         int tickID,
                         int numTicks)

Starts a standard repeating "ticker", on standard Tick time.

Parameters:

E - The Ticking object

tickID - the tick id denoting the type of event

numTicks - the number of given ticks between Tickable ticks

Returns:

the TickClient inside which the Tickable is placed

isTicking

boolean isTicking(Tickable E,
                  int tickID)

Searches the TickGroups for the given Tickable, returning true if it was found still registered to a Tick Client. Call sparingly!

Parameters:

E - the Tickable to search for

tickID - the assigned tick id, or -1 for ANY

Returns:

true if the Tickable was found somewhere

getTimeMsToNextTick

long getTimeMsToNextTick(Tickable E,
                         int tickID)

Searches the TickGroups for the given Tickable, and returns the number of miliseconds (roughly) before it will tick again.

Parameters:

E - the Tickable to search for

tickID - the assigned tick id, or -1 for ANY

Returns:

the time in ms until next tick, or -1

tickGroups

java.util.Iterator<TickableGroup> tickGroups()

Returns an iterator over all the existing tick groups.

Returns:

an iterator over all the existing tick groups.

getTickGroupPeriod

long getTickGroupPeriod(Tickable E,
                        int tickID)

Searches the TickGroups for the given Tickable, and returns the number of milliseconds that its tick group is using as a "tick".

Parameters:

E - the Tickable to search for

tickID - the assigned tick id, or -1 for ANY

Returns:

the time in ms of its tick group, or -1

deleteTick

boolean deleteTick(Tickable E,
                   int tickID)

Searches the TickGroups for the given Tickable, on the given tickID, and deletes it.

Parameters:

E - the Tickable to search for

tickID - the assigned tick id, or -1 for ALL

Returns:

true if it was found and killed.

unTickAll

boolean unTickAll(Tickable E)

A special method that deletes all known ticks of all tick ids from the given object, but also deletes all ticks of any objects dependent on it, such as item on mobs, effects on things, in rooms, etc.

Parameters:

E - the object to go completely quiet

Returns:

true if something was done

setTickPending

boolean setTickPending(Tickable E,
                       int tickID)

If the given Tickable is waiting multiple ticks before they get time, this will set them to pending, meaning they will wake up on the very next opportunity.

Parameters:

E - the Tickable to search for

tickID - the assigned tick id, or -1 for ALL

Returns:

true if the object was found, false otherwise

suspendTicking

void suspendTicking(Tickable E,
                    int tickID)

Suspends any actual thread time for this tick, without removing it from its tick group.

Parameters:

E - the Tickable to search for

tickID - the assigned tick id, or -1 for ALL

See Also:

resumeTicking(Tickable, int), suspendResumeRecurse(CMObject, boolean, boolean), isSuspended(Tickable, int), suspendAll(CMRunnable[]), resumeAll(), isAllSuspended()

resumeTicking

void resumeTicking(Tickable E,
                   int tickID)

Resumes the thread time for this tick, if it was previously suspended.

Parameters:

E - the Tickable to search for

tickID - the assigned tick id, or -1 for ALL

See Also:

suspendTicking(Tickable, int), suspendResumeRecurse(CMObject, boolean, boolean), isSuspended(Tickable, int), suspendAll(CMRunnable[]), resumeAll(), isAllSuspended()

suspendResumeRecurse

void suspendResumeRecurse(CMObject O,
                          boolean skipEmbeddedAreas,
                          boolean suspend)

Suspends or Resumes all embedded mobs, items, etc inside the given area, room, mob, etc. It can even do the inside of ships, unless told otherwise.

Parameters:

O - the object to suspend ticks on and well inside

skipEmbeddedAreas - true to skip ships and the like

suspend - true to suspend, false to resume

See Also:

resumeTicking(Tickable, int), suspendTicking(Tickable, int), isSuspended(Tickable, int), suspendAll(CMRunnable[]), resumeAll(), isAllSuspended()

isSuspended

boolean isSuspended(Tickable E,
                    int tickID)

Returns whether the given Tickable is currently suspended from receiving tick time, despite being assigned a tick group.

Parameters:

E - the Tickable to search for

tickID - the assigned tick id, or -1 for ALL

Returns:

true if its suspended, false otherwise

See Also:

resumeTicking(Tickable, int), suspendTicking(Tickable, int), suspendResumeRecurse(CMObject, boolean, boolean), suspendAll(CMRunnable[]), resumeAll(), isAllSuspended()

suspendAll

void suspendAll(CMRunnable[] exceptRs)

Suspend all threads, preventing anything from getting official tick time, except for the given runnable, typically a Session.

Parameters:

exceptRs - null, or the runnables to NOT suspend

See Also:

resumeTicking(Tickable, int), suspendTicking(Tickable, int), suspendResumeRecurse(CMObject, boolean, boolean), isSuspended(Tickable, int), resumeAll(), isAllSuspended()

resumeAll

void resumeAll()

Resumes all thread ticking, assuming they were all previously suspended.

See Also:

resumeTicking(Tickable, int), suspendTicking(Tickable, int), suspendResumeRecurse(CMObject, boolean, boolean), isSuspended(Tickable, int), suspendAll(CMRunnable[]), isAllSuspended()

isAllSuspended

boolean isAllSuspended()

Returns whether all threads are currently in the global suspended thread.

Returns:

true if all are suspended, false otherwise

See Also:

resumeTicking(Tickable, int), suspendTicking(Tickable, int), suspendResumeRecurse(CMObject, boolean, boolean), isSuspended(Tickable, int), suspendAll(CMRunnable[]), resumeAll()

scheduleRunnable

void scheduleRunnable(java.lang.Runnable R,
                      long ellapsedMs)

Schedule a runnable to be executed in the future.

Parameters:

R - the runnable to execute

ellapsedMs - the number of milliseconds before executing

See Also:

scheduleRunnable(Runnable, long), executeRunnable(Runnable), executeRunnable(char, Runnable), executeRunnable(String, Runnable)

executeRunnable

void executeRunnable(java.lang.Runnable R)

Execute a runnable in an available thread, right now, or as soon as humanly possible.

Parameters:

R - the runnable to execute

See Also:

scheduleRunnable(Runnable, long), executeRunnable(Runnable), executeRunnable(char, Runnable), executeRunnable(String, Runnable)

executeRunnable

void executeRunnable(java.lang.String threadGroupName,
                     java.lang.Runnable R)

Execute a runnable in an available thread, right now, or as soon as humanly possible. Ensure that it is from the given thread group, given its name.

Parameters:

threadGroupName - the thread group to execute it in

R - the runnable to execute

See Also:

scheduleRunnable(Runnable, long), executeRunnable(Runnable), executeRunnable(char, Runnable), executeRunnable(String, Runnable)

executeRunnable

void executeRunnable(char threadGroupId,
                     java.lang.Runnable R)

Execute a runnable in an available thread, right now, or as soon as humanly possible. Ensure that it is from the given thread group, given its id.

Parameters:

threadGroupId - the thread group to execute it in

R - the runnable to execute

See Also:

scheduleRunnable(Runnable, long), executeRunnable(Runnable), executeRunnable(char, Runnable), executeRunnable(String, Runnable)

tickAllTickers

void tickAllTickers(Room here)

Given a map room, this will find and force-tick every one of those objects, on the current tick group. This is normally for speeding things up.

Parameters:

here - the room to tick objects in

rejuv

void rejuv(Room here,
           int tickID)

Given a map room, this will find all the rejuvable items and mobs associated with the room and force them to respawn.

Parameters:

here - the room to force rejuv items in

tickID - -1 for items and mobs, or TICKID_MOB or TICKID_ROOM_ITEM_REJUV

clearDebri

void clearDebri(Room room,
                TickableGroup.LocalType typeCode)

Deletes the ticks of all the objects in the room of the given type.

Parameters:

room - the mob to delete objects from

typeCode - the type of objects

See Also:

TickableGroup.LocalType

getTickInfoReport

java.lang.String getTickInfoReport(java.lang.String which)

Retreives special internal information from the thread engine of the callers thread group, mostly for the web server. Variables: tickgroupsize tickerssizeX tickernameX-Y tickeridX-Y tickerstatusstrX-Y tickerstatusX-Y tickercodewordX-Y tickertickdownX-Y tickerretickdownX-Y tickermillitotalX-Y tickermilliavgX-Y tickerlaststartmillisX-Y tickerlaststopmillisX-Y tickerlaststartdateX-Y tickerlaststopdateX-Y tickerlastdurationX-Y tickersuspendedX-Y X is group num, Y is client num

Parameters:

which - the special encoded variable to return

Returns:

"", or the value

getSystemReport

java.lang.String getSystemReport(java.lang.String itemCode)

Retreives special thread related information about map objects. Variables: totalMOBMillis totalMOBMillisTime totalMOBMillisTimePlusAverage totalMOBTicks topMOBMillis topMOBMillisTime topMOBMillisTimePlusAverage topMOBTicks topMOBClient tickerproblems-X (X is the number to return) tickerprob2-X (X is the number to return) freeMemory totalMemory totalTime startTime currentTime totalTickers totalMillis totalMillisTime totalMillisTimePlusAverage totalTicks tickgroupsize numthreads numactivethreads topGroupNumber topGroupMillis topGroupMillisTime topGroupMillisTimePlusAverage topGroupTicks topObjectMillis topObjectMillisTime topObjectMillisTimePlusAverage topObjectTicks topObjectGroup activeMiliTotalX milliTotalX statusX nameX MilliTotalTimeX MiliTotalTimeX MilliTotalTimePlusAverageX MiliTotalTimePlusAverageX TickTotalX X = thread number

Parameters:

itemCode - the special variable to get value of

Returns:

"". or the value

getTickStatusSummary

java.lang.String getTickStatusSummary(Tickable obj)

A bit out of date, this returns the status of the given ticking object as a descriptive string.

Parameters:

obj - the object that is maybe ticking

Returns:

a description, or ""

getNamedTickingObjects

java.util.List<Tickable> getNamedTickingObjects(java.lang.String name)

Does an In-String search of all ticking objects and returns them.

Parameters:

name - the partial name

Returns:

the list of named objects

findTickClient

java.util.List<TickClient> findTickClient(java.lang.String name,
                                          boolean exactOnly)

Finds all the TickClients with tickers matching the given name. This is a english parser format search.

Parameters:

name - the string name to match

exactOnly - true for exact only, false for partial

Returns:

the list of tickclients with matching hits

findRunnableByThread

java.lang.Runnable findRunnableByThread(java.lang.Thread thread)

This is used for determining the runner on the given thread, which involves scanning thread pools for some reason?

Parameters:

thread - the thread to get the runnable for

Returns:

the runnable, or null, presumably

dumpDebugStack

void dumpDebugStack(java.lang.String ID,
                    java.lang.Thread theThread)

Dumps a stack trace, logging with the given ID

Parameters:

ID - the log id, a string of your choice

theThread - the thread to dump