Package com.planet_ink.coffee_mud.Common

Class DefaultSession.LoginLogoutThread

java.lang.Object

com.planet_ink.coffee_mud.Common.DefaultSession.LoginLogoutThread

All Implemented Interfaces:

CMObject, Tickable, CMRunnable, java.lang.Cloneable, java.lang.Comparable<CMObject>, java.lang.Runnable

Enclosing class:

DefaultSession

public static class DefaultSession.LoginLogoutThread
extends java.lang.Object
implements CMRunnable, Tickable

Field Summary

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

idConverter

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

STATUS_AFFECT, STATUS_ALIVE, STATUS_BEHAVIOR, STATUS_CLASS, STATUS_DEAD, STATUS_END, STATUS_FIGHT, STATUS_MISC, STATUS_MISC2, STATUS_MISC3, STATUS_MISC4, STATUS_MISC5, STATUS_MISC6, STATUS_MISC7, STATUS_NOT, STATUS_OTHER, STATUS_RACE, STATUS_REBIRTH, STATUS_SCRIPT, STATUS_START, STATUS_WEATHER, TICKID_AREA, TICKID_BALLISTICK, TICKID_CLAN, TICKID_CLANITEM, TICKID_DEADBODY_DECAY, TICKID_ELECTRONICS, TICKID_EMAIL, TICKID_EVENT, TICKID_EXIT_BEHAVIOR, TICKID_EXIT_REOPEN, TICKID_ITEM_BEHAVIOR, TICKID_ITEM_BOUNCEBACK, TICKID_LIGHT_FLICKERS, TICKID_LIVEAUCTION, TICKID_LONGERMASK, TICKID_MISCELLANEOUS, TICKID_MOB, TICKID_PROPERTY_SPECIAL, TICKID_QUEST, TICKID_READYTOSTOP, TICKID_ROOM_BEHAVIOR, TICKID_ROOM_ITEM_REJUV, TICKID_SHORTERMASK, TICKID_SOLITARYMASK, TICKID_SPECIALCOMBAT, TICKID_SPECIALMANEUVER, TICKID_SPELL_AFFECT, TICKID_SUPPORT, TICKID_TIMEAUCTION, TICKID_TRAP_DESTRUCTION, TICKID_TRAP_RESET

Constructor Summary

Constructors

Constructor	Description
LoginLogoutThread(MOB mob, int msgC)

Method Summary

Modifier and Type	Method	Description
long	activeTimeMillis()	Returns the number of milliseconds this runnable has been running.
int	compareTo(CMObject o)
CMObject	copyOf()	Similar to Cloneable.clone(), but does its best to make sure that any internal objects to this class are also copyOfed.
int	getGroupID()	The group identifier for this runnable, which may be used for executor selection
long	getStartTime()	Either the time this runnable did start running, or will start running, depending on whether it's scheduled
int	getTickStatus()	A coded status for this object during the period where its tick method is being called.
java.lang.String	ID()	The CoffeeMud Java Class ID shared by all instances of this object.
void	initialize()
void	initializeClass()	Called ONCE after all objects are loaded, but before the map is read in during initialization.
java.lang.String	name()	The nice displayable name of this instance of this object
CMObject	newInstance()	Returns a new instance of this class.
void	run()
boolean	tick(Tickable ticking, int tickID)	this is the method which is called periodically by the threading engine.

Methods inherited from class java.lang.Object

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

Constructor Detail

LoginLogoutThread

public LoginLogoutThread(MOB mob,
                         int msgC)

Method Detail

name

public java.lang.String name()

Description copied from interface: Tickable

The nice displayable name of this instance of this object

Specified by:

name in interface CMObject

Specified by:

name in interface Tickable

Returns:

the displayable name of this object instance

See Also:

Environmental.Name()

tick

public boolean tick(Tickable ticking,
                    int tickID)

Description copied from interface: Tickable

this is the method which is called periodically by the threading engine. How often it is called depends on the parameters passed to the threadding engine when it is submitted for thread access. Typically the period is once per TIME_TICK period, but that is determined when the object is submitted to the thread engine.

Specified by:

tick in interface Tickable

Parameters:

ticking - a reference to this Tickable object

tickID - the TICKID_ constant describing this periodic call, as defined in Tickable

Returns:

true always, unless this object no longer wishes to ever tick again, in which case false

See Also:

Tickable, ServiceEngine, TickableGroup

ID

public java.lang.String ID()

Description copied from interface: CMObject

The CoffeeMud Java Class ID shared by all instances of this object. Unlike the Java Class name, this method does not include package information. However, it must return a String value unique to its class category in the ClassLoader. Class categories include Libraries, Common, Areas, Abilities, Behaviors, CharClasses, Commands, Exits Locales, MOBS, Races, WebMacros, Basic Items, Armor, Weapons, ClanItems, Tech. The name is typically identical to the class name.

Specified by:

ID in interface CMObject

Returns:

the name of this class

newInstance

public CMObject newInstance()

Description copied from interface: CMObject

Returns a new instance of this class.

Specified by:

newInstance in interface CMObject

Returns:

a new instance of this class

initializeClass

public void initializeClass()

Description copied from interface: CMObject

Called ONCE after all objects are loaded, but before the map is read in during initialization.

Specified by:

initializeClass in interface CMObject

copyOf

public CMObject copyOf()

Description copied from interface: CMObject

Similar to Cloneable.clone(), but does its best to make sure that any internal objects to this class are also copyOfed.

Specified by:

copyOf in interface CMObject

Returns:

a clone of this object

compareTo

public int compareTo(CMObject o)

Specified by:

compareTo in interface java.lang.Comparable<CMObject>

getTickStatus

public int getTickStatus()

Description copied from interface: Tickable

A coded status for this object during the period where its tick method is being called. The statis is defined, at least in part, by constants in this interface STATUS_*. STATUS_NOT should be returned when the objects tick method is not currently in execution. It should never return STATUS_NOT when the objects tick method is in execution.

Specified by:

getTickStatus in interface Tickable

Returns:

the numeric status of this object

See Also:

Tickable.tick(Tickable, int)

getStartTime

public long getStartTime()

Description copied from interface: CMRunnable

Either the time this runnable did start running, or will start running, depending on whether it's scheduled

Specified by:

getStartTime in interface CMRunnable

Returns:

the time in millis

getGroupID

public int getGroupID()

Description copied from interface: CMRunnable

The group identifier for this runnable, which may be used for executor selection

Specified by:

getGroupID in interface CMRunnable

Returns:

the identifier for this runnable

initialize

public void initialize()

run

public void run()

Specified by:

run in interface java.lang.Runnable

activeTimeMillis

public long activeTimeMillis()

Description copied from interface: CMRunnable

Returns the number of milliseconds this runnable has been running.

Specified by:

activeTimeMillis in interface CMRunnable

Returns:

the time in millis