io.nadron.event.Events Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of nadron Show documentation
Nadron is a high speed socket based java game server written using Netty and Mike Rettig's Jetlang. It is specifically tuned for network based multiplayer games and supports TCP and UDP network protocols.
There is a newer version: 0.7
Show newest version
package io.nadron.event;

import io.nadron.app.Session;
import io.nadron.communication.DeliveryGuaranty;
import io.nadron.communication.DeliveryGuaranty.DeliveryGuarantyOptions;
import io.nadron.communication.MessageSender.Fast;
import io.nadron.communication.MessageSender.Reliable;
import io.nadron.event.impl.ChangeAttributeEvent;
import io.nadron.event.impl.DefaultConnectEvent;
import io.nadron.event.impl.DefaultEvent;
import io.nadron.event.impl.DefaultEventContext;
import io.nadron.event.impl.DefaultNetworkEvent;
import io.nadron.event.impl.DefaultSessionEventHandler;


public class Events
{
	public static final byte PROTCOL_VERSION=0x01;
	/**
	 * Events should NEVER have this type. But event handlers can choose
	 * to have this type to signify that they will handle any type of incoming
	 * event. For e.g. {@link DefaultSessionEventHandler}
	 */
	public final static byte ANY = 0x00;
	
	// Lifecycle events.
	public final static byte CONNECT = 0x02;
	/**
	 * Similar to LOG_IN but parameters are different. This event is sent from
	 * client to server.
	 */
	public static final byte RECONNECT = 0x3;
	public final static byte CONNECT_FAILED = 0x06;
	/**
	 * Event used to log in to a server from a remote client. Example payload
	 * will be login opcode 0x08-protocl version 0x01- username as string
	 * bytes- password as string bytes - connection key as string bytes -
	 * optional udp client address as bytes
	 */
	public static final byte LOG_IN = 0x08;
	public static final byte LOG_OUT = 0x0a;
	public static final byte LOG_IN_SUCCESS = 0x0b;
	public static final byte LOG_IN_FAILURE = 0x0c;
	public static final byte LOG_OUT_SUCCESS = 0x0e;
	public static final byte LOG_OUT_FAILURE = 0x0f;
	
	// Metadata events
	public static final byte GAME_LIST = 0x10;
	public static final byte ROOM_LIST = 0x12;
	public static final byte GAME_ROOM_JOIN = 0x14;
	public static final byte GAME_ROOM_LEAVE = 0x16;
	public static final byte GAME_ROOM_JOIN_SUCCESS = 0x18;
	public static final byte GAME_ROOM_JOIN_FAILURE = 0x19;
	
	/**
	 * Event sent from server to client to start message sending from client to server.
	 */
	public static final byte START = 0x1a;
	
	/**
	 * Event sent from server to client to stop messages from being sent to server.
	 */
	public static final byte STOP = 0x1b;
	/**
	 * Incoming data from another machine/JVM to this JVM (server or client)
	 */
	public static final byte SESSION_MESSAGE = 0x1c;

	/**
	 * This event is used to send data from the current machine to remote
	 * machines using TCP or UDP transports. It is an out-going event.
	 */
	public static final byte NETWORK_MESSAGE = 0x1d;
	
	
	public static final byte CHANGE_ATTRIBUTE = 0x20;
	
	/**
	 * If a remote connection is disconnected or closed then raise this event.
	 */
	public static final byte DISCONNECT = 0x22;
	
	/**
	 * A network exception will in turn cause this even to be raised.
	 */
	public static final byte EXCEPTION = 0x24;
	
	public static Event event(Object source, int eventType)
	{
		return event(source,eventType,(Session)null);
	}
	
	public static Event event(Object source, int eventType,Session session)
	{
		EventContext context = null;
		if(null != session)
		{
			context = new DefaultEventContext();
		}
		return event(source,eventType,context);
	}
	
	public static Event event(Object source, int eventType, EventContext context)
	{
		DefaultEvent event = new DefaultEvent();
		event.setSource(source);
		event.setType(eventType);
		event.setEventContext(context);
		event.setTimeStamp(System.currentTimeMillis());
		return event;
	}
	
	/**
	 * Creates a network event with the source set to the object passed in as
	 * parameter and the {@link DeliveryGuaranty} set to
	 * {@link DeliveryGuarantyOptions#RELIABLE}. This method delegates to
	 * {@link #networkEvent(Object, DeliveryGuaranty)}.
	 * 
	 * @param source
	 *            The payload of the event. This is the actual data that gets
	 *            transmitted to remote machine.
	 * @return An instance of {@link NetworkEvent}
	 */
	public static NetworkEvent networkEvent(Object source)
	{
		return networkEvent(source,DeliveryGuaranty.DeliveryGuarantyOptions.RELIABLE);
	}
	
	/**
	 * Creates a network event with the source set to the object passed in as
	 * parameter and the {@link DeliveryGuaranty} set to the incoming
	 * parameter.
	 * 
	 * @param source
	 *            The payload of the event. This is the actual data that gets
	 *            transmitted to remote machine.
	 * @param deliveryGuaranty
	 *            This decides which transport TCP or UDP to be used to send the
	 *            message to remote machine.
	 * @return An instance of {@link NetworkEvent}
	 */
	public static NetworkEvent networkEvent(Object source, DeliveryGuaranty deliveryGuaranty)
	{
		Event event = event(source,Events.NETWORK_MESSAGE);
		NetworkEvent networkEvent = new DefaultNetworkEvent(event);
		networkEvent.setDeliveryGuaranty(deliveryGuaranty);
		return networkEvent;
	}
	
	public static Event connectEvent(Reliable tcpSender){
		Event event = new DefaultConnectEvent(tcpSender);
		event.setTimeStamp(System.currentTimeMillis());
		return event;
	}
	
	public static Event connectEvent(Fast udpSender){
		Event event = new DefaultConnectEvent(udpSender);
		event.setTimeStamp(System.currentTimeMillis());
		return event;
	}
	
	public static Event connectEvent(Reliable tcpSender, Fast udpSender){
		Event event = new DefaultConnectEvent(tcpSender, udpSender);
		event.setTimeStamp(System.currentTimeMillis());
		return event;
	}
	
	public static Event dataInEvent(Object source)
	{
		return event(source,Events.SESSION_MESSAGE);
	}
	
	public static Event changeAttributeEvent(String key, Object value)
	{
		return new ChangeAttributeEvent(key,value);
	}
}