io.nadron.client.app.Game Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of nadclient Show documentation

This is a client library for Nadron server https://github.com/menacher/java-game-server/tree/netty4/nadron. Java clients can use this program to connect and interact with nadron server.

There is a newer version: 0.5

Show newest version

package io.nadron.client.app;

import io.netty.channel.ChannelFuture;

/**
 * This interface abstracts a game domain object. Each game deployed in the
 * server should implement this interface.
 * 
 * @author Abraham Menacherry
 * 
 */
public interface Game
{
	/**
	 * @return Returns the unique id associated with this game object.
	 */
	public Object getId();

	/**
	 * @param id
	 *            Sets the unique id for this game.
	 */
	public void setId(Object id);

	/**
	 * Get the name of the game. Preferably should be a unique name.
	 * 
	 * @return Returns the name of the game.
	 */
	public String getGameName();

	/**
	 * Set the name of the game. Preferably it should be a unique value.
	 * 
	 * @param gameName
	 *            Set the preferably unique game name.
	 */
	public void setGameName(String gameName);

	/**
	 * Unloads the current game, by closing all sessions.
	 * 
	 * @return In case of Netty Implementation it would return a collection of
	 *         {@link ChannelFuture} object.
	 */
	public Object unload();
}