io.nadron.app.impl

Class DefaultSession

java.lang.Object

io.nadron.app.impl.DefaultSession

All Implemented Interfaces:

Session

Direct Known Subclasses:

DefaultPlayerSession, GameRoomSession

public class DefaultSession
extends Object
implements Session

The default implementation of the session class. This class is responsible for receiving and sending events. For receiving it uses the onEvent(Event) method and for sending it uses the EventDispatcher fireEvent method. The Method setId(Object) will throw IllegalArgumentException in this implementation class.

Author:

Abraham Menacherry

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DefaultSession.SessionBuilder This class is roughly based on Joshua Bloch's Builder pattern.

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

Session.Status

Field Summary

Fields

Modifier and Type	Field and Description
protected long	creationTime
protected EventDispatcher	eventDispatcher event dispatcher
protected Object	id session id
protected boolean	isShuttingDown Life cycle variable to check if the session is shutting down.
protected boolean	isUDPEnabled
protected boolean	isWriteable
protected long	lastReadWriteTime
protected Map<String,Object>	sessionAttributes session parameters
protected Session.Status	status
protected MessageSender.Reliable	tcpSender
protected MessageSender.Fast	udpSender

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DefaultSession(DefaultSession.SessionBuilder sessionBuilder)

Method Summary

Methods

Modifier and Type	Method and Description
void	addHandler(EventHandler eventHandler)
void	close()
boolean	equals(Object obj)
Object	getAttribute(String key)
long	getCreationTime()
EventDispatcher	getEventDispatcher()
List<EventHandler>	getEventHandlers(int eventType)
Object	getId()
long	getLastReadWriteTime()
Map<String,Object>	getSessionAttributes()
Session.Status	getStatus()
MessageSender.Reliable	getTcpSender()
MessageSender.Fast	getUdpSender()
int	hashCode()
boolean	isConnected()
boolean	isShuttingDown()
boolean	isUDPEnabled() Not synchronized because default implementation does not care whether a duplicated message sender is created.
boolean	isWriteable()
void	onEvent(Event event)
void	removeAttribute(String key)
void	removeHandler(EventHandler eventHandler)
void	setAttribute(String key, Object value)
void	setId(Object id)
void	setLastReadWriteTime(long lastReadWriteTime)
void	setStatus(Session.Status status)
void	setTcpSender(MessageSender.Reliable tcpSender)
void	setUDPEnabled(boolean isEnabled) A session would not have UDP capability when created.
void	setUdpSender(MessageSender.Fast udpSender)
void	setWriteable(boolean isWriteable)

Methods inherited from class java.lang.Object

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

Field Detail

id

protected final Object id

session id

eventDispatcher

protected EventDispatcher eventDispatcher

event dispatcher

sessionAttributes

protected final Map<String,Object> sessionAttributes

session parameters

creationTime

protected final long creationTime

lastReadWriteTime

protected long lastReadWriteTime

status

protected Session.Status status

isWriteable

protected boolean isWriteable

isShuttingDown

protected volatile boolean isShuttingDown

Life cycle variable to check if the session is shutting down. If it is, then no more incoming events will be accepted.

isUDPEnabled

protected boolean isUDPEnabled

tcpSender

protected MessageSender.Reliable tcpSender

udpSender

protected MessageSender.Fast udpSender

Constructor Detail

DefaultSession

protected DefaultSession(DefaultSession.SessionBuilder sessionBuilder)

Method Detail

onEvent

public void onEvent(Event event)

Specified by:

onEvent in interface Session

getId

public Object getId()

Specified by:

getId in interface Session

setId

public void setId(Object id)

Specified by:

setId in interface Session

getEventDispatcher

public EventDispatcher getEventDispatcher()

Specified by:

getEventDispatcher in interface Session

addHandler

public void addHandler(EventHandler eventHandler)

Specified by:

addHandler in interface Session

removeHandler

public void removeHandler(EventHandler eventHandler)

Specified by:

removeHandler in interface Session

getEventHandlers

public List<EventHandler> getEventHandlers(int eventType)

Specified by:

getEventHandlers in interface Session

getAttribute

public Object getAttribute(String key)

Specified by:

getAttribute in interface Session

removeAttribute

public void removeAttribute(String key)

Specified by:

removeAttribute in interface Session

setAttribute

public void setAttribute(String key,
                Object value)

Specified by:

setAttribute in interface Session

getCreationTime

public long getCreationTime()

Specified by:

getCreationTime in interface Session

getLastReadWriteTime

public long getLastReadWriteTime()

Specified by:

getLastReadWriteTime in interface Session

setLastReadWriteTime

public void setLastReadWriteTime(long lastReadWriteTime)

getStatus

public Session.Status getStatus()

Specified by:

getStatus in interface Session

setStatus

public void setStatus(Session.Status status)

Specified by:

setStatus in interface Session

isConnected

public boolean isConnected()

Specified by:

isConnected in interface Session

isWriteable

public boolean isWriteable()

Specified by:

isWriteable in interface Session

setWriteable

public void setWriteable(boolean isWriteable)

Specified by:

setWriteable in interface Session

isUDPEnabled

public boolean isUDPEnabled()

Not synchronized because default implementation does not care whether a duplicated message sender is created.

Specified by:

isUDPEnabled in interface Session

Returns:

Returns true if the a UDP MessageSender instance is attached to this session, else false.

See Also:

Session.isUDPEnabled()

setUDPEnabled

public void setUDPEnabled(boolean isEnabled)

Description copied from interface: Session

A session would not have UDP capability when created. Depending on the network abilities of the client, it can request UDP communication to be enabled with the LOGIN_UDP and CONNECT_UDP events of the Events class. Once UDP MessageSender instance is attached to the session, this method should be called with flag to true to signal that the session is now UDP enabled.

Specified by:

setUDPEnabled in interface Session

Parameters:

isEnabled - Should be true in most use cases. It is used to signal that the UDP MessageSender has been attached to session.

close

public void close()

Specified by:

close in interface Session

isShuttingDown

public boolean isShuttingDown()

Specified by:

isShuttingDown in interface Session

getSessionAttributes

public Map<String,Object> getSessionAttributes()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getTcpSender

public MessageSender.Reliable getTcpSender()

Specified by:

getTcpSender in interface Session

setTcpSender

public void setTcpSender(MessageSender.Reliable tcpSender)

Specified by:

setTcpSender in interface Session

getUdpSender

public MessageSender.Fast getUdpSender()

Specified by:

getUdpSender in interface Session

setUdpSender

public void setUdpSender(MessageSender.Fast udpSender)

Specified by:

setUdpSender in interface Session