Package com.planet_ink.coffee_mud.Libraries.interfaces

Interface SessionsList

All Superinterfaces:

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

All Known Implementing Classes:

Sessions

public interface SessionsList
extends CMLibrary

Sessions are managed connections to a host telnet port through which the players interact. Each session is attached to a single player/character. The sessions are managed in this library.

Field Summary

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

idConverter

Method Summary

Modifier and Type	Method	Description
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.
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.
java.util.Iterator<Session>	sessions()	Returns the sessions for all the sessions currently managed, logging in or not, from all hosts running.
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.

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

Method Detail

stopSessionAtAllCosts

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.

Parameters:

S - the session to stop and kill

findCharacterSessionOnline

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

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

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

findCharacterOnline

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

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

Parameters:

srchStr - the whole or partial char name

exactOnly - true for whole, false for partial or whole

Returns:

null, or the character mob found

sessions

java.util.Iterator<Session> sessions()

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

Returns:

the sessions for all the sessions

See Also:

allIterable(), allIterableAllHosts(), localOnline(), localOnlineIterable()

allIterable

java.lang.Iterable<Session> allIterable()

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

Returns:

the sessions for all the sessions

See Also:

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

allIterableAllHosts

java.lang.Iterable<Session> allIterableAllHosts()

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

Returns:

the sessions for all the sessions all hosts

See Also:

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

localOnline

java.util.Iterator<Session> localOnline()

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

Returns:

the sessions for all the online game chars

See Also:

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

localOnlineIterable

java.lang.Iterable<Session> localOnlineIterable()

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

Returns:

the sessions for all the online game chars

See Also:

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

localOnlineIterableAllHosts

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.

Returns:

the sessions for all the online game chars

See Also:

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

numLocalOnline

int numLocalOnline()

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

Returns:

the number of sessions

See Also:

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

numSessions

int numSessions()

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

Returns:

the number of sessions

See Also:

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

add

void add(Session s)

Adds the given session to this manager, to be managed

Parameters:

s - the session to add

See Also:

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

remove

void remove(Session s)

Removes the given session from this manager.

Parameters:

s - the session to remove

See Also:

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

isSession

boolean isSession(Session s)

Returns whether the given session is still registered here.

Parameters:

s - the session to check for

Returns:

true if its still managed here, false otherwise

See Also:

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

moveSessionToCorrectThreadGroup

void moveSessionToCorrectThreadGroup(Session session,
                                     int theme)

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

Parameters:

session - the session to move

theme - the theme of the group to assign it to