PacketDirection.java

package de.take_weiland.mods.commons.net;

import cpw.mods.fml.relauncher.Side;

import java.lang.annotation.Retention;
import java.lang.annotation.Target;

import static java.lang.annotation.ElementType.TYPE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

/**
 * <p>Specify whether a {@link de.take_weiland.mods.commons.net.ModPacket} is send from the client to the server
 * or the other way around.</p>
 * <p>If a packet is received on the wrong side, the player is kicked with a {@link de.take_weiland.mods.commons.net.ProtocolException}.</p>
 * <p>The default value is {@link Dir#BOTH_WAYS}.</p>
 *
 * @author diesieben07
 */
@Retention(RUNTIME)
@Target(TYPE)
public @interface PacketDirection {

	Dir value();

	enum Dir {
		/**
		 * <p>The packet is only send from the client to the server.</p>
		 */
		TO_SERVER(Side.SERVER),
		/**
		 * <p>The packet is only send from the server to the client.</p>
		 */
		TO_CLIENT(Side.CLIENT),
		/**
		 * <p>The packet can be send both ways. This is the default value.</p>
		 */
		BOTH_WAYS(null);

        public final Side validTarget;

        Dir(Side validTarget) {
            this.validTarget = validTarget;
        }

	}

}