io.nadron.app.impl

Class DefaultPlayerSession

java.lang.Object

io.nadron.app.impl.DefaultSession

io.nadron.app.impl.DefaultPlayerSession

All Implemented Interfaces:

PlayerSession, Session

public class DefaultPlayerSession
extends DefaultSession
implements PlayerSession

This implementation of the PlayerSession interface is used to both receive and send messages to a particular player using the DefaultSession.onEvent(io.nadron.event.Event). Broadcasts from the GameRoom are directly patched to the EventDispatcher which listens on the room's MemoryChannel for events and in turn publishes them to the listeners.

Author:

Abraham Menacherry

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DefaultPlayerSession.PlayerSessionBuilder

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 GameRoom	parentGameRoom Each incoming connection is made to a game room.
protected Player	player Each session belongs to a Player.
protected Protocol	protocol This variable holds information about the type of binary communication protocol to be used with this session.

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	DefaultPlayerSession(DefaultPlayerSession.PlayerSessionBuilder playerSessionBuilder)

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
GameRoom	getGameRoom() Each user session is attached to a game room.
Player	getPlayer() Each session is associated with a Player.
Protocol	getProtocol() Get the Protocol associated with this session.
void	sendToGameRoom(Event event) The event to be send to the GameRoom to which the PlayerSession belongs.
void	setGameRoom(GameRoom gameRoom) Method used to set the game room for a particular session.
void	setProtocol(Protocol protocol) Set the network protocol on the user session.
String	toString()

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

addHandler, equals, getAttribute, getCreationTime, getEventDispatcher, getEventHandlers, getId, getLastReadWriteTime, getSessionAttributes, getStatus, getTcpSender, getUdpSender, hashCode, isConnected, isShuttingDown, 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, wait, wait, wait

Methods inherited from interface io.nadron.app.Session

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

Field Detail

player

protected final Player player

Each session belongs to a Player. This variable holds the reference.

parentGameRoom

protected GameRoom parentGameRoom

Each incoming connection is made to a game room. This reference holds the association to the game room.

protocol

protected Protocol protocol

This variable holds information about the type of binary communication protocol to be used with this session.

Constructor Detail

DefaultPlayerSession

protected DefaultPlayerSession(DefaultPlayerSession.PlayerSessionBuilder playerSessionBuilder)

Method Detail

getPlayer

public Player getPlayer()

Description copied from interface: PlayerSession

Each session is associated with a Player. This is the actual human or machine using this session.

Specified by:

getPlayer in interface PlayerSession

Returns:

Returns that associated Player object or null if it is not associated yet.

getGameRoom

public GameRoom getGameRoom()

Description copied from interface: PlayerSession

Each user session is attached to a game room. This method is used to retrieve that game room object.

Specified by:

getGameRoom in interface PlayerSession

Returns:

Returns the associated game room object or null if none is associated.

setGameRoom

public void setGameRoom(GameRoom gameRoom)

Description copied from interface: PlayerSession

Method used to set the game room for a particular session.

Specified by:

setGameRoom in interface PlayerSession

Parameters:

gameRoom - The gameRoom object to set.

getProtocol

public Protocol getProtocol()

Description copied from interface: PlayerSession

Get the Protocol associated with this session.

Specified by:

getProtocol in interface PlayerSession

Returns:

Returns the associated protocol instance.

setProtocol

public void setProtocol(Protocol protocol)

Description copied from interface: PlayerSession

Set the network protocol on the user session.

Specified by:

setProtocol in interface PlayerSession

Parameters:

protocol - The Protocol to set.

close

public void close()

Specified by:

close in interface Session

Overrides:

close in class DefaultSession

sendToGameRoom

public void sendToGameRoom(Event event)

Description copied from interface: PlayerSession

The event to be send to the GameRoom to which the PlayerSession belongs. Behavior is unspecified if message is sent when a room change is taking place.

Specified by:

sendToGameRoom in interface PlayerSession

Parameters:

event - The event to send to the GameRoom

toString

public String toString()

Overrides:

toString in class Object