io.nadron.service

Interface GameStateManagerService

All Known Implementing Classes:

GameStateManager

public interface GameStateManagerService

Every multi-player game requires some sort of state management, this interface contains methods which can be implemented for doing such service.

Author:

Abraham Menacherry

Method Summary

Methods

Modifier and Type	Method and Description
boolean	compareAndSetState(Object syncKey, Object state) This method is actually a combination of compareAndSetSyncKey and setState.
boolean	compareAndSetSyncKey(Object key) Method used to achieve synchronization while doing state management.
Object	computeAndSetNextState(Object state, Object syncKey, Object stateAlgorithm)
Object	computeNextState(Object state, Object syncKey, Object stateAlgorithm)
byte[]	getSerializedByteArray() Whenever serialization is done from Java object to AMF3, or just plain seriazlied java object, it should be saved in byte array format to the state manager.
Object	getState()
Object	getStateAlgorithm()
Object	getSyncKey() Method used to retrieve the synchronization key object.
void	setSerializedByteArray(byte[] serializedBytes) Whenever serialization is done from Java object to AMF3, or just plain java serialized object, it should be saved in byte array format to the state manager.
void	setState(Object state) Set's current state object.

Method Detail

getState

Object getState()

Returns:

Returns the current state object. This could be any object like a byte array, an object reference that holds a hierarchy of other objects etc. This will be used to manage the state of the game.

setState

void setState(Object state)

Set's current state object. This could be any object like a byte array, an object reference that holds a hierarchy of other objects etc. This will be used to manage the state of the game.

compareAndSetSyncKey

boolean compareAndSetSyncKey(Object key)

Method used to achieve synchronization while doing state management. PictureDataStateManager does it by using an AtomicInteger.

Parameters:

key - The current state is wrapped in this object key.

Returns:

True if the atomic compare and set was successful. False otherwise.

compareAndSetState

boolean compareAndSetState(Object syncKey,
                         Object state)

This method is actually a combination of compareAndSetSyncKey and setState. It will take care of setting the new sync key and set state. If the sync key is not valid it will return false, if it is, it will set the state and the new sync key.

Parameters:

syncKey - Sync key of the incoming object

state - The new state to be set.

Returns:

True if sync key is valid, false if it is invalid.

getSyncKey

Object getSyncKey()

Method used to retrieve the synchronization key object. For the case of Doodler application it is an AtomicInteger.

Returns:

Returns the synchronization key associated with the state manager.

getSerializedByteArray

byte[] getSerializedByteArray()

Whenever serialization is done from Java object to AMF3, or just plain seriazlied java object, it should be saved in byte array format to the state manager. This will save re-serialization in case the same object is to be sent again. Below method will return the saved array.

Returns:

Return the latest byte array representation of the state.

setSerializedByteArray

void setSerializedByteArray(byte[] serializedBytes)
                            throws UnsupportedOperationException

Whenever serialization is done from Java object to AMF3, or just plain java serialized object, it should be saved in byte array format to the state manager. This will save re-serialization in case the same object is to be sent again. Below method will set the array to the state manager.

Parameters:

serializedBytes - the serialized AMF3 or other object in byte array format.

Throws:

UnsupportedOperationException

computeNextState

Object computeNextState(Object state,
                      Object syncKey,
                      Object stateAlgorithm)
                        throws UnsupportedOperationException

Throws:

UnsupportedOperationException

computeAndSetNextState

Object computeAndSetNextState(Object state,
                            Object syncKey,
                            Object stateAlgorithm)
                              throws UnsupportedOperationException

Throws:

UnsupportedOperationException

getStateAlgorithm

Object getStateAlgorithm()
                         throws UnsupportedOperationException

Throws:

UnsupportedOperationException