com.sun.sgs.example.hack.server

Class Messages

java.lang.Object

com.sun.sgs.example.hack.server.Messages

public final class Messages
extends Object

This class provides a single point for static methods that send messages the client. This is provided both as a convenience, and also as a way to keep all message formatting in one place. All message formatting and message code definition is done here.

Method Summary

Methods

Modifier and Type	Method and Description
static void	broadcastBoardUpdate(com.sun.sgs.app.Channel channel, Collection<BoardSpace> spaces) Sends updates about a Collection of spaces.
static void	broadcastGameAdded(com.sun.sgs.app.Channel channel, String name) Sends notice to a set of clients that a game has been added.
static void	broadcastGameCountChanged(com.sun.sgs.app.Channel channel, int count, String name) Sends notice to a set of clients that the membership of a given game has changed.
static void	broadcastGameRemoved(com.sun.sgs.app.Channel channel, String name) Sends notice to a set of clients that a game has been removed.
static void	broadcastPlayerID(com.sun.sgs.app.Channel channel, String playerName, BigInteger playerID) Sends the command to add the mapping from player ID to player name to all the clients on the provided channel.
static void	broadcastPlayerJoined(com.sun.sgs.app.Channel channel, BigInteger playerID) Notifies all the sessons on the channel that the provided ClientSession has joined.
static void	broadcastPlayerLeft(com.sun.sgs.app.Channel channel, BigInteger playerID) Notifies all the sessons on the channel that the provided ClientSession has left.
static void	sendBoard(com.sun.sgs.app.ClientSession session, Board board) Sends a complete Board to a client.
static void	sendBulkPlayerIDs(com.sun.sgs.app.ClientSession session, Map<com.sun.sgs.app.ManagedReference<com.sun.sgs.app.ClientSession>,String> playerToName) Sends the command to add the all of the provided mappings from player ID to player name to the specified client.
static void	sendCharacter(com.sun.sgs.app.ClientSession session, int id, CharacterStats stats) Sends detail about a single character.
static void	sendGameListing(com.sun.sgs.app.ClientSession session, Collection<GameMembershipDetail> games) Sends the initial welcome message when a client enters the lobby.
static void	sendNotificationOfUnhandledCommand(com.sun.sgs.app.ClientSession session, String channelName, Commands.Command command)
static void	sendPlayableCharacters(com.sun.sgs.app.ClientSession session, Collection<CharacterStats> stats) Sends a Collection of player statistics.
static void	sendServerMessage(com.sun.sgs.app.ClientSession session, String message) Sends a text message to the client.
static void	sendSpriteMap(com.sun.sgs.app.ClientSession session, SpriteMap spriteMap) Sends a new mapping from identifiers to sprite images.

Methods inherited from class java.lang.Object

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

Method Detail

sendNotificationOfUnhandledCommand

public static void sendNotificationOfUnhandledCommand(com.sun.sgs.app.ClientSession session,
                                      String channelName,
                                      Commands.Command command)

broadcastPlayerJoined

public static void broadcastPlayerJoined(com.sun.sgs.app.Channel channel,
                         BigInteger playerID)

Notifies all the sessons on the channel that the provided ClientSession has joined.

broadcastPlayerLeft

public static void broadcastPlayerLeft(com.sun.sgs.app.Channel channel,
                       BigInteger playerID)

Notifies all the sessons on the channel that the provided ClientSession has left.

broadcastPlayerID

public static void broadcastPlayerID(com.sun.sgs.app.Channel channel,
                     String playerName,
                     BigInteger playerID)

Sends the command to add the mapping from player ID to player name to all the clients on the provided channel.

sendBulkPlayerIDs

public static void sendBulkPlayerIDs(com.sun.sgs.app.ClientSession session,
                     Map<com.sun.sgs.app.ManagedReference<com.sun.sgs.app.ClientSession>,String> playerToName)

Sends the command to add the all of the provided mappings from player ID to player name to the specified client. If the provided map is too large, it will be sent in parts through mutliple messages.

sendGameListing

public static void sendGameListing(com.sun.sgs.app.ClientSession session,
                   Collection<GameMembershipDetail> games)

Sends the initial welcome message when a client enters the lobby. This just sends the set of game names to the client. The correct lobby and game counts come from other messages.

Parameters:

games - the Collection of games and their detail

broadcastGameCountChanged

public static void broadcastGameCountChanged(com.sun.sgs.app.Channel channel,
                             int count,
                             String name)

Sends notice to a set of clients that the membership of a given game has changed.

Parameters:

name - the name of the game that changed

count - the updated membership count

broadcastGameAdded

public static void broadcastGameAdded(com.sun.sgs.app.Channel channel,
                      String name)

Sends notice to a set of clients that a game has been added.

Parameters:

name - the name of the game that was added

broadcastGameRemoved

public static void broadcastGameRemoved(com.sun.sgs.app.Channel channel,
                        String name)

Sends notice to a set of clients that a game has been removed.

Parameters:

name - the name of the game that was added

sendPlayableCharacters

public static void sendPlayableCharacters(com.sun.sgs.app.ClientSession session,
                          Collection<CharacterStats> stats)

Sends a Collection of player statistics.

Parameters:

stats - the collection of character statistics

sendSpriteMap

public static void sendSpriteMap(com.sun.sgs.app.ClientSession session,
                 SpriteMap spriteMap)

Sends a new mapping from identifiers to sprite images. This is typically done with each level.

Parameters:

spriteMap - the mapping from identifier to sprite

sendBoard

public static void sendBoard(com.sun.sgs.app.ClientSession session,
             Board board)

Sends a complete Board to a client.

Parameters:

board - the Board to send

broadcastBoardUpdate

public static void broadcastBoardUpdate(com.sun.sgs.app.Channel channel,
                        Collection<BoardSpace> spaces)

Sends updates about a Collection of spaces.

Parameters:

spaces - the spaces that are being updated

sendServerMessage

public static void sendServerMessage(com.sun.sgs.app.ClientSession session,
                     String message)

Sends a text message to the client. These are messages generated by the game logic, not chat messages from other clients.

Parameters:

message - the message to send

sendCharacter

public static void sendCharacter(com.sun.sgs.app.ClientSession session,
                 int id,
                 CharacterStats stats)

Sends detail about a single character.

Parameters:

id - the character's id

stats - the character's statistics