org.mega.gasp.platform
Interface ActorSession

All Known Implementing Classes:
ActorSessionImpl

public interface ActorSession

ActorSession represent the link between a user (represented by instances of Session and Actor) and an ApplicationInstance. It receive and transmit all the events or message in an ApplicationInstance, in game it is the communication link between the client and the game session server.

Author:
PELLERIN Romain (pellerin@cnam.fr) - MEGA Project

Method Summary
 int getActorID()
          Returns the Actor ID of the user.
 int getActorSessionID()
          Returns the ActorSession ID.
 int getApplicationInstanceID()
          Returns the ApplicationInstance ID linked.
 java.util.Vector getEvents()
          Return the events stored since the last request from the actor.
 java.lang.String getPseudoName()
          Returns the current pseudo name of the user session.
 int getSessionID()
          Returns the Session ID of the user
 boolean isPseudoHasModified()
          Determines if the pseudo has modified during the session.
 void raiseEvent(Event e)
          Put the event on the stack of the events must be read by the actor.
 void setPseudoName(java.lang.String name)
          Set the current pseudo name of the user session.
 

Method Detail

getApplicationInstanceID

public int getApplicationInstanceID()
Returns the ApplicationInstance ID linked.

Returns:
the ApplicationInstance ID

getActorID

public int getActorID()
Returns the Actor ID of the user.

Returns:
the Actor ID

getSessionID

public int getSessionID()
Returns the Session ID of the user

Returns:
the Session ID

getActorSessionID

public int getActorSessionID()
Returns the ActorSession ID.

Returns:
the ActorSession ID.

getPseudoName

public java.lang.String getPseudoName()
Returns the current pseudo name of the user session.

Returns:
the ActorSession ID

setPseudoName

public void setPseudoName(java.lang.String name)
Set the current pseudo name of the user session.


isPseudoHasModified

public boolean isPseudoHasModified()
Determines if the pseudo has modified during the session.


getEvents

public java.util.Vector getEvents()
Return the events stored since the last request from the actor.

Returns:
the stack of events

raiseEvent

public void raiseEvent(Event e)
Put the event on the stack of the events must be read by the actor.

Parameters:
e - the Event