GameRoom (nadron 0.4.1 API)

All Known Implementing Classes:

GameRoomSession
```
public interface GameRoom
```
This interface represents a game room and the related operations available on it. The game room keeps the list of user sessions which are connected to it and is responsible for sending broadcast messages. It can also considered to be kind of a Factory pattern implementer, since it is responsible for creating/initializing the game state, player sessions etc for the game.

Author:

Abraham Menacherry

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.
`PlayerSession`	`createPlayerSession(Player player)` Method used to create a player session object.
`boolean`	`disconnectSession(PlayerSession session)` 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.
`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.
`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`	`setStateManager(GameStateManagerService stateManager)` Method used to set the state manager for a game room.

- Method Detail
  - createPlayerSession
```
PlayerSession createPlayerSession(Player player)
```
    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.
    
    Returns:
    The game specific implementation of the player session.
  - onLogin
```
void onLogin(PlayerSession playerSession)
```
    Method called after the session is created. Can be used to add EventListeners to the session
  - connectSession
```
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.
    
    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
```
void afterSessionConnect(PlayerSession playerSession)
```
    Method called after the session is created. Can be used to add EventListeners to the session
  - disconnectSession
```
boolean disconnectSession(PlayerSession session)
```
    Remove a session from the existing list of user sessions.
    
    Parameters:
    session - The session to be removed from the set.
    
    Returns:
    true if removal was successful and false if it was not.
  - getSessions
```
Set<PlayerSession> getSessions()
```
    Returns a list of sessions that is held by the game room.
    
    Returns:
    Returns the set of user sessions associated with game room.
  - getGameRoomName
```
String getGameRoomName()
```
    Returns:
    Returns the name of the game room
  - setGameRoomName
```
void setGameRoomName(String gameRoomName)
```
    Sets the name of the game room. Preferably unique.
    
    Parameters:
    gameRoomName -
  - getParentGame
```
Game getParentGame()
```
    Each game room belongs to a game. This method can be used to retrieve that game object.
    
    Returns:
    Returns the associated parent game object.
  - setParentGame
```
void setParentGame(Game parentGame)
```
    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.
    
    Parameters:
    parentGame - The game to which this game room belongs.
  - getStateManager
```
GameStateManagerService getStateManager()
```
    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.
    
    Returns:
    returns the state manager instance associated with the game room or null if none are associated.
  - setStateManager
```
void setStateManager(GameStateManagerService stateManager)
```
    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.
    
    Parameters:
    stateManager -
  - getProtocol
```
Protocol getProtocol()
```
    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.
    
    Returns:
    Returns the associated protocol instance.
  - setProtocol
```
void setProtocol(Protocol protocol)
```
    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.
    
    Parameters:
    protocol - The protocol instance to set.
  - setSessions
```
void setSessions(Set<PlayerSession> sessions)
```
    Method used to set the set of user sessions to a particular game room.
    
    Parameters:
    sessions - The set of sessions to be set.
  - send
```
void send(Event event)
```
    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.
    
    Parameters:
    event - The event to send to room
  - sendBroadcast
```
void sendBroadcast(NetworkEvent networkEvent)
```
    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.
    
    Parameters:
    networkEvent - The message that is to be broadcast to all user sessions of this game room
  - close
```
void close()
```
    This method will close down the game room. It can be used to disconnect all users connected to a game room.
  - setFactory
```
void setFactory(SessionFactory factory)
```
  - getFactory
```
SessionFactory getFactory()
```

Interface GameRoom

Method Summary

Method Detail

createPlayerSession

onLogin

connectSession

afterSessionConnect

disconnectSession

getSessions

getGameRoomName

setGameRoomName

getParentGame

setParentGame

getStateManager

setStateManager

getProtocol

setProtocol

setSessions

send

sendBroadcast

close

setFactory

getFactory