io.nadron.app.impl

Class GameRoomSession

java.lang.Object

io.nadron.app.impl.DefaultSession

io.nadron.app.impl.GameRoomSession

All Implemented Interfaces:

GameRoom, Session

public abstract class GameRoomSession
extends DefaultSession
implements GameRoom

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GameRoomSession.GameRoomSessionBuilder

Nested classes/interfaces inherited from class io.nadron.app.impl.DefaultSession

DefaultSession.SessionBuilder

Nested classes/interfaces inherited from interface io.nadron.app.Session

Session.Status

Field Summary

Fields

Modifier and Type	Field and Description
protected String	gameRoomName The name of the game room, preferably unique across multiple games.
private static org.slf4j.Logger	LOG
protected Game	parentGame The parent SimpleGame reference of this game room.
protected Protocol	protocol Each game room has its own protocol for communication with client.
protected SessionFactory	sessionFactory
protected Set<PlayerSession>	sessions The set of sessions in this object.
protected GameStateManagerService	stateManager Each game room has separate state manager instances.

Fields inherited from class io.nadron.app.impl.DefaultSession

creationTime, eventDispatcher, id, isShuttingDown, isUDPEnabled, isWriteable, lastReadWriteTime, sessionAttributes, status, tcpSender, udpSender

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GameRoomSession(GameRoomSession.GameRoomSessionBuilder gameRoomSessionBuilder)

Method Summary

Methods

Modifier and Type	Method and Description
void	afterSessionConnect(PlayerSession playerSession) Method called after the session is created.
void	close() This method will close down the game room.
boolean	connectSession(PlayerSession playerSession) When a new user connects to the game, this method will be invoked to add the incoming session to the game room.
protected void	createAndAddEventHandlers(PlayerSession playerSession) Method which will create and add event handlers of the player session to the Game Room's EventDispatcher.
PlayerSession	createPlayerSession(Player player) Method used to create a player session object.
boolean	disconnectSession(PlayerSession playerSession) Remove a session from the existing list of user sessions.
SessionFactory	getFactory()
String	getGameRoomName()
Game	getParentGame() Each game room belongs to a game.
Protocol	getProtocol() Each game room has a protocol attached to it.
PlayerSession	getSessionInstance(Player player)
Set<PlayerSession>	getSessions() Returns a list of sessions that is held by the game room.
GameStateManagerService	getStateManager() Every non trivial game will have some sort of state management service going on.
boolean	isShuttingDown()
abstract void	onLogin(PlayerSession playerSession) Method called after the session is created.
void	send(Event event) Used to send an event to the GameRoom.
void	sendBroadcast(NetworkEvent networkEvent) Method used to send a broadcast message to all sessions in the group.
void	setFactory(SessionFactory factory)
void	setGameRoomName(String gameRoomName) Sets the name of the game room.
void	setParentGame(Game parentGame) Used to set the parent game object of the game room.
void	setProtocol(Protocol protocol) Sets the protocol instance on the game room.
void	setSessions(Set<PlayerSession> sessions) Method used to set the set of user sessions to a particular game room.
void	setShuttingDown(boolean isShuttingDown)
void	setStateManager(GameStateManagerService stateManager) Method used to set the state manager for a game room.

Methods inherited from class io.nadron.app.impl.DefaultSession

addHandler, equals, getAttribute, getCreationTime, getEventDispatcher, getEventHandlers, getId, getLastReadWriteTime, getSessionAttributes, getStatus, getTcpSender, getUdpSender, hashCode, isConnected, isUDPEnabled, isWriteable, onEvent, removeAttribute, removeHandler, setAttribute, setId, setLastReadWriteTime, setStatus, setTcpSender, setUDPEnabled, setUdpSender, setWriteable

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final org.slf4j.Logger LOG

gameRoomName

protected String gameRoomName

The name of the game room, preferably unique across multiple games.

parentGame

protected Game parentGame

The parent SimpleGame reference of this game room.

stateManager

protected GameStateManagerService stateManager

Each game room has separate state manager instances. This variable will manage the state for all the DefaultPlayers connected to this game room.

sessions

protected Set<PlayerSession> sessions

The set of sessions in this object.

protocol

protected Protocol protocol

Each game room has its own protocol for communication with client.

sessionFactory

protected SessionFactory sessionFactory

Constructor Detail

GameRoomSession

protected GameRoomSession(GameRoomSession.GameRoomSessionBuilder gameRoomSessionBuilder)

Method Detail

createPlayerSession

public PlayerSession createPlayerSession(Player player)

Description copied from interface: GameRoom

Method used to create a player session object. Depending on the game, the right implementation class would be created by the game room. If there is some specific player session creation logic then this method can be considered like the factory method which should be overriden.

Specified by:

createPlayerSession in interface GameRoom

Returns:

The game specific implementation of the player session.

onLogin

public abstract void onLogin(PlayerSession playerSession)

Description copied from interface: GameRoom

Method called after the session is created. Can be used to add EventListeners to the session

Specified by:

onLogin in interface GameRoom

connectSession

public boolean connectSession(PlayerSession playerSession)

Description copied from interface: GameRoom

When a new user connects to the game, this method will be invoked to add the incoming session to the game room.

Specified by:

connectSession in interface GameRoom

Parameters:

playerSession - The incoming user session. If we are using netty, it would be a Channel object wrapped in a PlayerSession.

Returns:

true if session is connected successfully.

afterSessionConnect

public void afterSessionConnect(PlayerSession playerSession)

Description copied from interface: GameRoom

Method called after the session is created. Can be used to add EventListeners to the session

Specified by:

afterSessionConnect in interface GameRoom

disconnectSession

public boolean disconnectSession(PlayerSession playerSession)

Description copied from interface: GameRoom

Remove a session from the existing list of user sessions.

Specified by:

disconnectSession in interface GameRoom

Parameters:

playerSession - The session to be removed from the set.

Returns:

true if removal was successful and false if it was not.

send

public void send(Event event)

Description copied from interface: GameRoom

Used to send an event to the GameRoom. The room can listen on this method for incoming events, do necessary business or game logic, transformations etc and then send it across to other PlayerSessions if required. Implementations are generally expected to be async, so default implementation would be to just patch incoming event to the Session.onEvent(io.nadron.event.Event) of the GameRoom's session where the actual business logic can be applied.

Specified by:

send in interface GameRoom

Parameters:

event - The event to send to room

sendBroadcast

public void sendBroadcast(NetworkEvent networkEvent)

Description copied from interface: GameRoom

Method used to send a broadcast message to all sessions in the group. It is the easiest way to update the state of all connected DefaultPlayer s to the same state. This method will transmit messages using the delivery guaranty provided in the NetworkEvent.

Specified by:

sendBroadcast in interface GameRoom

Parameters:

networkEvent - The message that is to be broadcast to all user sessions of this game room

close

public void close()

Description copied from interface: GameRoom

This method will close down the game room. It can be used to disconnect all users connected to a game room.

Specified by:

close in interface GameRoom

Specified by:

close in interface Session

Overrides:

close in class DefaultSession

getSessionInstance

public PlayerSession getSessionInstance(Player player)

getSessions

public Set<PlayerSession> getSessions()

Description copied from interface: GameRoom

Returns a list of sessions that is held by the game room.

Specified by:

getSessions in interface GameRoom

Returns:

Returns the set of user sessions associated with game room.

setSessions

public void setSessions(Set<PlayerSession> sessions)

Description copied from interface: GameRoom

Method used to set the set of user sessions to a particular game room.

Specified by:

setSessions in interface GameRoom

Parameters:

sessions - The set of sessions to be set.

getGameRoomName

public String getGameRoomName()

Specified by:

getGameRoomName in interface GameRoom

Returns:

Returns the name of the game room

setGameRoomName

public void setGameRoomName(String gameRoomName)

Description copied from interface: GameRoom

Sets the name of the game room. Preferably unique.

Specified by:

setGameRoomName in interface GameRoom

getParentGame

public Game getParentGame()

Description copied from interface: GameRoom

Each game room belongs to a game. This method can be used to retrieve that game object.

Specified by:

getParentGame in interface GameRoom

Returns:

Returns the associated parent game object.

setParentGame

public void setParentGame(Game parentGame)

Description copied from interface: GameRoom

Used to set the parent game object of the game room. By setting this we are able to identify which game room belongs to which game.

Specified by:

setParentGame in interface GameRoom

Parameters:

parentGame - The game to which this game room belongs.

setStateManager

public void setStateManager(GameStateManagerService stateManager)

Description copied from interface: GameRoom

Method used to set the state manager for a game room. Each game room will have its own instance of the state manager. If using spring, then the state manager bean needs to be of type "prototype" instead of singleton. Meaning that the state is not shared across multiple rooms.

Specified by:

setStateManager in interface GameRoom

getStateManager

public GameStateManagerService getStateManager()

Description copied from interface: GameRoom

Every non trivial game will have some sort of state management service going on. This is done on a per game room basis where the latest state of the game room is effective for all the users connected to the game room. The state manager object encapsulates the state.

Specified by:

getStateManager in interface GameRoom

Returns:

returns the state manager instance associated with the game room or null if none are associated.

getProtocol

public Protocol getProtocol()

Description copied from interface: GameRoom

Each game room has a protocol attached to it. This protocol object can be used to configure the Netty pipeline to add handlers or to add appropriate filter chains to the session.

Specified by:

getProtocol in interface GameRoom

Returns:

Returns the associated protocol instance.

setProtocol

public void setProtocol(Protocol protocol)

Description copied from interface: GameRoom

Sets the protocol instance on the game room. This protocol object can be used to configure the Netty pipeline to add handlers or to add appropriate filter chains to the session.

Specified by:

setProtocol in interface GameRoom

Parameters:

protocol - The protocol instance to set.

getFactory

public SessionFactory getFactory()

Specified by:

getFactory in interface GameRoom

setFactory

public void setFactory(SessionFactory factory)

Specified by:

setFactory in interface GameRoom

isShuttingDown

public boolean isShuttingDown()

Specified by:

isShuttingDown in interface Session

Overrides:

isShuttingDown in class DefaultSession

setShuttingDown

public void setShuttingDown(boolean isShuttingDown)

createAndAddEventHandlers

protected void createAndAddEventHandlers(PlayerSession playerSession)

Method which will create and add event handlers of the player session to the Game Room's EventDispatcher.

Parameters:

playerSession - The session for which the event handlers are created.