com.sun.sgs.example.hack.server

Class Lobby

java.lang.Object

com.sun.sgs.example.hack.server.Lobby

All Implemented Interfaces:

com.sun.sgs.app.ManagedObject, Game, GameChangeListener, Serializable

public class Lobby
extends Object
implements Game, GameChangeListener, Serializable

The lobby is where all players go to join a game, and it manages players while they're deciding which game to join. The lobby maintains a list of current players, as well as player counts for each of the games, and is notified when those counts change. The lobby is responsible for telling players this information when they join, and broadcasting any changes in membership counts or available games. It also provides the interface for managing Player's characters. There is a single Lobby instance for each game app.

While in the lobby all players are on the same channel, which is used for chatting. Once moved into another game, players are removed from the lobby channel.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	IDENTIFIER The identifier for the lobby

Fields inherited from interface com.sun.sgs.example.hack.server.Game

NAME_PREFIX

Method Summary

Methods

Modifier and Type	Method and Description
void	gameAdded(Collection<String> added) Notifies the listener that some games were added to the app.
void	gameRemoved(Collection<String> removed) Notifies the listener that some games were removed from the app.
static Lobby	getInstance(GameChangeManager gcm) Provides access to the single instance of Lobby.
String	getName() Returns the name of the lobby.
MessageHandler	join(Player player) Joins a player to the lobby.
void	leave(Player player) Removes the player from the lobby.
void	membershipChanged(Collection<GameMembershipDetail> details) Called when it's time to send out membership change messages.
int	numPlayers() Returns the number of players currently in the lobby.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

IDENTIFIER

public static final String IDENTIFIER

The identifier for the lobby

See Also:

Constant Field Values

Method Detail

getInstance

public static Lobby getInstance(GameChangeManager gcm)

Provides access to the single instance of Lobby. If the lobby hasn't already been created, then a new instance is created and added as a registered ManagedObject. If the lobby already exists then nothing new is created.

This method implements the pattern described in the programmer's notes document, so that it's safe against multiple simultaneous accesses when the lobby doesn't already exist. In practice, this isn't actually a concern in this app, because this method is never called by more than once party. Still, it's good defensive programming to protect against future models that may change our current access assumptions.

Parameters:

gcm - the manager we'll notify when lobby membership counts change

Returns:

the single Lobby

join

public MessageHandler join(Player player)

Joins a player to the lobby. This is done when a player first connects, and whenever they leave an active game.

Specified by:

join in interface Game

Parameters:

player - the Player joining the lobby

Returns:

the MessageHandler that will process the provided player's messages

leave

public void leave(Player player)

Removes the player from the lobby.

Specified by:

leave in interface Game

Parameters:

player - the Player leaving the lobby

getName

public String getName()

Returns the name of the lobby. This is also specified by the local field IDENTIFIER.

Specified by:

getName in interface Game

Returns:

the name

numPlayers

public int numPlayers()

Returns the number of players currently in the lobby.

Specified by:

numPlayers in interface Game

Returns:

the number of players in the lobby

gameAdded

public void gameAdded(Collection<String> added)

Notifies the listener that some games were added to the app.

Specified by:

gameAdded in interface GameChangeListener

Parameters:

games - the games that were added

gameRemoved

public void gameRemoved(Collection<String> removed)

Notifies the listener that some games were removed from the app.

Specified by:

gameRemoved in interface GameChangeListener

Parameters:

games - the games that were removed

membershipChanged

public void membershipChanged(Collection<GameMembershipDetail> details)

Called when it's time to send out membership change messages. This method will broadcast changes to all current members of the lobby.

Specified by:

membershipChanged in interface GameChangeListener

Parameters:

details - the membership details

toString

public String toString()

Overrides:

toString in class Object