Java-part of MDP JNI bindings

src/org/servalproject/servald/mdp/MeshPacket.java

@@ -0,0 +1,341 @@
+package org.servalproject.servald.mdp;
+
+import java.net.DatagramPacket;
+
+import org.servalproject.servald.SubscriberId;
+
+/**
+ * Equivalent of {@link DatagramPacket} for MDP protocol.
+ * 
+ * @author Romain Vimont (®om) <[email protected]>
+ */
+public class MeshPacket {
+
+	/* QoS flags copied from constants.h */
+	public static final int OQ_ISOCHRONOUS_VOICE = 0;
+	public static final int OQ_MESH_MANAGEMENT = 1;
+	public static final int OQ_ISOCHRONOUS_VIDEO = 2;
+	public static final int OQ_ORDINARY = 3;
+	public static final int OQ_OPPORTUNISTIC = 4;
+	public static final int OQ_MAX = 5;
+
+	/* MDP flags copied from constants.h */
+	public static final int FLAG_MDP_FORCE = 1 << 8;
+	public static final int FLAG_MDP_NOCRYPT = 1 << 9;
+	public static final int FLAG_MDP_NOSIGN = 1 << 10;
+
+	/** Flag mask for {@code mdpTypeAndFlag} field. */
+	private static final int FLAG_MASK = 0xff00;
+
+	/** Data buffer. */
+	private byte[] buf;
+
+	/** Offset. */
+	private int offset;
+
+	/** Length. */
+	private int length;
+
+	/** SID address. */
+	private SubscriberId sid;
+
+	/** Port. */
+	private int port = -1;
+
+	/** Flags. */
+	private int flags;
+
+	/** QoS type. */
+	private int qos = OQ_ORDINARY;
+
+	/**
+	 * Constructs a mesh packet for receiving packets of length {@code length} with offset
+	 * {@code offset}.
+	 * 
+	 * The {@code length} argument must be less than or equal to {@code buf.length}.
+	 * 
+	 * @param buf
+	 *            buffer for holding the incoming data.
+	 * @param offset
+	 *            offset.
+	 * @param length
+	 *            the number of bytes to read.
+	 */
+	public MeshPacket(byte[] buf, int offset, int length) {
+		setData(buf, offset, length);
+	}
+
+	/**
+	 * Constructs a mesh packet for receiving packets of length {@code length}.
+	 * 
+	 * The {@code length} argument must be less than or equal to {@code buf.length}.
+	 * 
+	 * @param buf
+	 *            buffer for holding the incoming data.
+	 * @param length
+	 *            the number of bytes to read.
+	 */
+	public MeshPacket(byte[] buf, int length) {
+		this(buf, 0, length);
+	}
+
+	/**
+	 * Constructs a mesh packet for sending packets of length {@code length} with offset
+	 * {@code offset} to the specified port number on the specified host. The {@code length}
+	 * argument must be less than or equal to {@code buf.length}.
+	 * 
+	 * @param buf
+	 *            packet data.
+	 * @param offset
+	 *            offset.
+	 * @param length
+	 *            length.
+	 * @param sid
+	 *            destination SID address.
+	 * @param port
+	 *            destination port.
+	 */
+	public MeshPacket(byte[] buf, int offset, int length, SubscriberId sid, int port) {
+		this(buf, offset, length);
+		setSid(sid);
+		setPort(port);
+	}
+
+	/**
+	 * Constructs a mesh packet for sending packets of length {@code length} to the specified port
+	 * number on the specified host. The {@code length} argument must be less than or equal to
+	 * {@code buf.length}.
+	 * 
+	 * @param buf
+	 *            packet data.
+	 * @param length
+	 *            length.
+	 * @param sid
+	 *            destination SID address.
+	 * @param port
+	 *            destination port.
+	 */
+	public MeshPacket(byte[] buf, int length, SubscriberId sid, int port) {
+		this(buf, 0, length, sid, port);
+	}
+
+	/**
+	 * Constructs a mesh packet for sending packets of length {@code length} with offset
+	 * {@code offset} to the specified port number on the specified host. The {@code length}
+	 * argument must be less than or equal to {@code buf.length}.
+	 * 
+	 * @param buf
+	 *            packet data.
+	 * @param offset
+	 *            offset.
+	 * @param length
+	 *            length.
+	 * @param address
+	 *            destination address.
+	 */
+	public MeshPacket(byte[] buf, int offset, int length, MeshSocketAddress address) {
+		setData(buf, offset, length);
+		setMeshSocketAddress(address);
+	}
+
+	/**
+	 * Constructs a mesh packet for sending packets of length {@code length} to the specified port
+	 * number on the specified host. The {@code length} argument must be less than or equal to
+	 * {@code buf.length}.
+	 * 
+	 * @param buf
+	 *            packet data.
+	 * @param length
+	 *            length.
+	 * @param address
+	 *            destination address.
+	 */
+	public MeshPacket(byte[] buf, int length, MeshSocketAddress address) {
+		this(buf, 0, length, address);
+	}
+
+	/**
+	 * Set the data buffer, with the specified offset and length.
+	 * 
+	 * @param buf
+	 *            buffer.
+	 * @param offset
+	 *            offset.
+	 * @param length
+	 *            length.
+	 */
+	public synchronized void setData(byte[] buf, int offset, int length) {
+		/* this will check to see if buf is null */
+		if (length < 0 || offset < 0 || length + offset < 0 || length + offset > buf.length) {
+			throw new IllegalArgumentException("Illegal length or offset");
+		}
+		this.buf = buf;
+		this.offset = offset;
+		this.length = length;
+	}
+
+	/**
+	 * Set the data buffer, with the offset set to 0, and the length set to the length of
+	 * {@code buf}.
+	 * 
+	 * @param buf
+	 *            buffer.
+	 */
+	public synchronized void setData(byte[] buf) {
+		setData(buf, 0, buf.length);
+	}
+
+	/**
+	 * Sets the SID address of the machine to which this mesh packet is being sent.
+	 * 
+	 * @param sid
+	 *            SID address.
+	 */
+	public synchronized void setSid(SubscriberId sid) {
+		this.sid = sid;
+	}
+
+	/**
+	 * Sets the port number on the remote host to which this mesh packet is being sent.
+	 * 
+	 * @param port
+	 *            port.
+	 */
+	public synchronized void setPort(int port) {
+		this.port = port;
+	}
+
+	/**
+	 * Sets the mesh socket address of the remote host to which this packet is being sent.
+	 * 
+	 * @param address
+	 *            mesh socket address.
+	 */
+	public synchronized void setMeshSocketAddress(MeshSocketAddress address) {
+		setSid(address.getSid());
+		setPort(address.getPort());
+	}
+
+	/**
+	 * Set the length for this packet. The length of the packet is the number of bytes from the
+	 * packet's data buffer that will be sent, or the number of bytes of the packet's data buffer
+	 * that will be used for receiving data. The length must be lesser or equal to the offset plus
+	 * the length of the packet's buffer.
+	 * 
+	 * @param length
+	 *            data length.
+	 */
+	public synchronized void setLength(int length) {
+		if (length < 0 || length + offset < 0 || length + offset > buf.length) {
+			throw new IllegalArgumentException("illegal length");
+		}
+		this.length = length;
+	}
+
+	/**
+	 * Set the flags.
+	 * 
+	 * @param flags
+	 *            flags.
+	 */
+	public synchronized void setFlags(int flags) {
+		this.flags = flags & FLAG_MASK;
+	}
+
+	/**
+	 * Add the flags.
+	 * 
+	 * @param flags
+	 *            flags.
+	 */
+	public synchronized void addFlags(int flags) {
+		this.flags |= flags & FLAG_MASK;
+	}
+
+	/**
+	 * Remove the flags.
+	 * 
+	 * @param flags
+	 *            flags.
+	 */
+	public synchronized void removeFlag(int flags) {
+		this.flags &= ~(flags & FLAG_MASK);
+	}
+
+	/**
+	 * Set the QoS type.
+	 * 
+	 * @param qos
+	 *            QoS.
+	 */
+	public synchronized void setQos(int qos) {
+		this.qos = qos;
+	}
+
+	/**
+	 * Returns the data buffer. The data received or the data to be sent starts from the offset in
+	 * the buffer, and runs for length long.
+	 * 
+	 * @return data buffer.
+	 */
+	public synchronized byte[] getBuf() {
+		return buf;
+	}
+
+	/**
+	 * Returns the offset of the data to be sent or the offset of the data received.
+	 * 
+	 * @return data offset.
+	 */
+	public synchronized int getOffset() {
+		return offset;
+	}
+
+	/**
+	 * Returns the length of the data to be sent or the length of the data received.
+	 * 
+	 * @return data length.
+	 */
+	public synchronized int getLength() {
+		return length;
+	}
+
+	/**
+	 * Returns the SID address of the machine to which this packet is being sent or from which the
+	 * packet was received.
+	 * 
+	 * @return SID address.
+	 */
+	public synchronized SubscriberId getSid() {
+		return sid;
+	}
+
+	/**
+	 * Returns the port number on the remote host to which this packet is being sent or from which
+	 * the packet was received.
+	 * 
+	 * @return Port.
+	 */
+	public synchronized int getPort() {
+		return port;
+	}
+
+	/**
+	 * Returns the flags.
+	 * 
+	 * @return Flags.
+	 */
+	public synchronized int getFlags() {
+		return flags;
+	}
+
+	/**
+	 * Return the QoS type.
+	 * 
+	 * @return QoS.
+	 */
+	public synchronized int getQos() {
+		return qos;
+	}
+
+}