Package com.planet_ink.coffee_mud.Libraries

Class Sessions

java.lang.Object

com.planet_ink.coffee_mud.Libraries.StdLibrary

com.planet_ink.coffee_mud.Libraries.Sessions

All Implemented Interfaces:

CMObject, Tickable, CMLibrary, SessionsList, java.lang.Cloneable, java.lang.Comparable<CMObject>

public class Sessions
extends StdLibrary
implements SessionsList

Field Summary

Fields

Modifier and Type	Field	Description
SLinkedList<Session>	all

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

idConverter

Fields inherited from class com.planet_ink.coffee_mud.Libraries.StdLibrary

isDebugging, name, serviceClient, tickStatus

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
Sessions()

Method Summary

Modifier and Type	Method	Description
boolean	activate()	Activates the library.
void	add(Session s)	Adds the given session to this manager, to be managed
java.lang.Iterable<Session>	allIterable()	Returns the sessions for all the sessions currently managed, logging in or not, from all hosts running.
java.lang.Iterable<Session>	allIterableAllHosts()	Returns the sessions for all the sessions currently managed, logging in or not, from all hosts running.
MOB	findCharacterOnline(java.lang.String srchStr, boolean exactOnly)	Searches online characters whose sessions are managed by this library, and returns the character mobs.
Session	findCharacterSessionOnline(java.lang.String srchStr, boolean exactOnly)	Searches online characters whose sessions are managed by this library, and returns the session.
protected Session	getAllSessionAt(java.util.Iterator<Session> i, int index)
protected int	getCount(java.util.Iterator<Session> i)
java.lang.String	ID()	The CoffeeMud Java Class ID shared by all instances of this object.
boolean	isSession(Session s)	Returns whether the given session is still registered here.
java.util.Iterator<Session>	localOnline()	Returns the sessions for all the online game characters that are on the map and playing.
java.lang.Iterable<Session>	localOnlineIterable()	Returns the sessions for all the online game characters that are on the map and playing.
java.lang.Iterable<Session>	localOnlineIterableAllHosts()	Returns the sessions for all the online game characters that are on the map and playing on a host that uses the given map library.
void	moveSessionToCorrectThreadGroup(Session session, int theme)	Determines the correct thread group for the given theme, and marks the given session appropriately.
int	numLocalOnline()	The number of char sessions being managed here.
int	numSessions()	The number of sessions being managed here.
void	remove(Session s)	Removes the given session from this manager.
protected void	sessionCheck()
java.util.Iterator<Session>	sessions()	Returns the sessions for all the sessions currently managed, logging in or not, from all hosts running.
boolean	shutdown()	Shuts down the library.
void	stopSessionAtAllCosts(Session S)	Given a session, this will attempt to stop its running thread in every way imaginable and remove the session from the manager.
boolean	tick(Tickable ticking, int tickID)	this is the method which is called periodically by the threading engine.

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

getServiceClient, L, propertiesLoaded

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

copyOf, initializeClass, name, newInstance

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from class java.lang.Object

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

Methods inherited from class com.planet_ink.coffee_mud.Libraries.StdLibrary

checkDatabase, compareTo, copyOf, getServiceClient, getTickStatus, initializeClass, L, name, newInstance, propertiesLoaded, setThreadStatus

Field Detail

all

public final SLinkedList<Session> all

Constructor Detail

Sessions

public Sessions()

Method Detail

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

Overrides:

ID in class StdLibrary

Returns:

the name of this class

sessions

public java.util.Iterator<Session> sessions()

Description copied from interface: SessionsList

Returns the sessions for all the sessions currently managed, logging in or not, from all hosts running.

Specified by:

sessions in interface SessionsList

Returns:

the sessions for all the sessions

See Also:

SessionsList.allIterable(), SessionsList.allIterableAllHosts(), SessionsList.localOnline(), SessionsList.localOnlineIterable()

allIterable

public java.lang.Iterable<Session> allIterable()

Description copied from interface: SessionsList

Returns the sessions for all the sessions currently managed, logging in or not, from all hosts running.

Specified by:

allIterable in interface SessionsList

Returns:

the sessions for all the sessions

See Also:

SessionsList.sessions(), SessionsList.allIterableAllHosts(), SessionsList.localOnline(), SessionsList.localOnlineIterableAllHosts(), SessionsList.localOnlineIterable()

localOnline

public java.util.Iterator<Session> localOnline()

Description copied from interface: SessionsList

Returns the sessions for all the online game characters that are on the map and playing.

Specified by:

localOnline in interface SessionsList

Returns:

the sessions for all the online game chars

See Also:

SessionsList.sessions(), SessionsList.allIterable(), SessionsList.allIterableAllHosts(), SessionsList.localOnlineIterableAllHosts(), SessionsList.localOnlineIterable()

localOnlineIterable

public java.lang.Iterable<Session> localOnlineIterable()

Description copied from interface: SessionsList

Returns the sessions for all the online game characters that are on the map and playing.

Specified by:

localOnlineIterable in interface SessionsList

Returns:

the sessions for all the online game chars

See Also:

SessionsList.sessions(), SessionsList.allIterable(), SessionsList.allIterableAllHosts(), SessionsList.localOnlineIterableAllHosts(), SessionsList.localOnline()

localOnlineIterableAllHosts

public java.lang.Iterable<Session> localOnlineIterableAllHosts()

Description copied from interface: SessionsList

Returns the sessions for all the online game characters that are on the map and playing on a host that uses the given map library.

Specified by:

localOnlineIterableAllHosts in interface SessionsList

Returns:

the sessions for all the online game chars

See Also:

SessionsList.sessions(), SessionsList.allIterable(), SessionsList.allIterableAllHosts(), SessionsList.localOnline(), SessionsList.localOnlineIterable()

numSessions

public int numSessions()

Description copied from interface: SessionsList

The number of sessions being managed here. This includes being logging on, logging off, and in all other states.

Specified by:

numSessions in interface SessionsList

Returns:

the number of sessions

See Also:

SessionsList.isSession(Session), SessionsList.add(Session), SessionsList.remove(Session), SessionsList.numLocalOnline()

allIterableAllHosts

public java.lang.Iterable<Session> allIterableAllHosts()

Description copied from interface: SessionsList

Returns the sessions for all the sessions currently managed, logging in or not, from all hosts running.

Specified by:

allIterableAllHosts in interface SessionsList

Returns:

the sessions for all the sessions all hosts

See Also:

SessionsList.sessions(), SessionsList.allIterable(), SessionsList.localOnlineIterableAllHosts(), SessionsList.localOnline(), SessionsList.localOnlineIterable()

numLocalOnline

public int numLocalOnline()

Description copied from interface: SessionsList

The number of char sessions being managed here. This only includes actual player sessions for mobs in the game.

Specified by:

numLocalOnline in interface SessionsList

Returns:

the number of sessions

See Also:

SessionsList.isSession(Session), SessionsList.add(Session), SessionsList.remove(Session), SessionsList.numSessions()

getCount

protected int getCount(java.util.Iterator<Session> i)

getAllSessionAt

protected Session getAllSessionAt(java.util.Iterator<Session> i,
                                  int index)

add

public void add(Session s)

Description copied from interface: SessionsList

Adds the given session to this manager, to be managed

Specified by:

add in interface SessionsList

Parameters:

s - the session to add

See Also:

SessionsList.isSession(Session), SessionsList.add(Session), SessionsList.remove(Session), SessionsList.numSessions(), SessionsList.numLocalOnline()

remove

public void remove(Session s)

Description copied from interface: SessionsList

Removes the given session from this manager.

Specified by:

remove in interface SessionsList

Parameters:

s - the session to remove

See Also:

SessionsList.isSession(Session), SessionsList.add(Session), SessionsList.remove(Session), SessionsList.numSessions(), SessionsList.numLocalOnline()

isSession

public boolean isSession(Session s)

Description copied from interface: SessionsList

Returns whether the given session is still registered here.

Specified by:

isSession in interface SessionsList

Parameters:

s - the session to check for

Returns:

true if its still managed here, false otherwise

See Also:

SessionsList.add(Session), SessionsList.remove(Session), SessionsList.numSessions(), SessionsList.numLocalOnline()

stopSessionAtAllCosts

public void stopSessionAtAllCosts(Session S)

Description copied from interface: SessionsList

Given a session, this will attempt to stop its running thread in every way imaginable and remove the session from the manager.

Specified by:

stopSessionAtAllCosts in interface SessionsList

Parameters:

S - the session to stop and kill

sessionCheck

protected void sessionCheck()

activate

public boolean activate()

Description copied from interface: CMLibrary

Activates the library. This is called after the mud is booted, but before connections are accepted.

Specified by:

activate in interface CMLibrary

Overrides:

activate in class StdLibrary

Returns:

true if activation was successful, false if you're screwed

See Also:

CMLibrary.shutdown()

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

Overrides:

tick in class StdLibrary

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

shutdown

public boolean shutdown()

Description copied from interface: CMLibrary

Shuts down the library. Called at system shutdown time obviously, but is sometimes called just to reset the library.

Specified by:

shutdown in interface CMLibrary

Overrides:

shutdown in class StdLibrary

Returns:

true if shutdown was successful, false if there's nothing you can do about it

See Also:

CMLibrary.activate()

findCharacterOnline

public MOB findCharacterOnline(java.lang.String srchStr,
                               boolean exactOnly)

Description copied from interface: SessionsList

Searches online characters whose sessions are managed by this library, and returns the character mobs.

Specified by:

findCharacterOnline in interface SessionsList

Parameters:

srchStr - the whole or partial char name

exactOnly - true for whole, false for partial or whole

Returns:

null, or the character mob found

findCharacterSessionOnline

public Session findCharacterSessionOnline(java.lang.String srchStr,
                                          boolean exactOnly)

Description copied from interface: SessionsList

Searches online characters whose sessions are managed by this library, and returns the session.

Specified by:

findCharacterSessionOnline in interface SessionsList

Parameters:

srchStr - the whole or partial char name

exactOnly - true for whole, false for partial or whole

Returns:

null, or the character mob's session

moveSessionToCorrectThreadGroup

public void moveSessionToCorrectThreadGroup(Session session,
                                            int theme)

Description copied from interface: SessionsList

Determines the correct thread group for the given theme, and marks the given session appropriately.

Specified by:

moveSessionToCorrectThreadGroup in interface SessionsList

Parameters:

session - the session to move

theme - the theme of the group to assign it to