panda.net.discard.DiscardUDPClient Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of panda-nets Show documentation

Panda Nets is a client side library of many basic Internet protocols.

There is a newer version: 1.8.0

package panda.net.discard;

import java.io.IOException;
import java.net.DatagramPacket;
import java.net.InetAddress;

import panda.net.DatagramSocketClient;

/***
 * The DiscardUDPClient class is a UDP implementation of a client for the Discard protocol described
 * in RFC 863. To use the class, just open a local UDP port with
 * {@link panda.net.DatagramSocketClient#open open } and call {@link #send send } to send datagrams
 * to the server After you're done sending discard data, call
 * {@link panda.net.DatagramSocketClient#close close() } to clean up properly.
 * 
 * @see DiscardTCPClient
 ***/

public class DiscardUDPClient extends DatagramSocketClient {
	/*** The default discard port. It is set to 9 according to RFC 863. ***/
	public static final int DEFAULT_PORT = 9;

	DatagramPacket _sendPacket;

	public DiscardUDPClient() {
		_sendPacket = new DatagramPacket(new byte[0], 0);
	}

	/***
	 * Sends the specified data to the specified server at the specified port.
	 * 
	 * @param data The discard data to send.
	 * @param length The length of the data to send. Should be less than or equal to the length of
	 *            the data byte array.
	 * @param host The address of the server.
	 * @param port The service port.
	 * @exception IOException If an error occurs during the datagram send operation.
	 ***/
	public void send(byte[] data, int length, InetAddress host, int port) throws IOException {
		_sendPacket.setData(data);
		_sendPacket.setLength(length);
		_sendPacket.setAddress(host);
		_sendPacket.setPort(port);
		_socket_.send(_sendPacket);
	}

	/***
	 * Same as send(data, length, host. DiscardUDPClient.DEFAULT_PORT).
	 * 
	 * @param data the buffer to send
	 * @param length the length of the data in the buffer
	 * @param host the target host
	 * @see #send(byte[], int, InetAddress, int)
	 * @throws IOException if an error occurs
	 ***/
	public void send(byte[] data, int length, InetAddress host) throws IOException {
		send(data, length, host, DEFAULT_PORT);
	}

	/***
	 * Same as send(data, data.length, host. DiscardUDPClient.DEFAULT_PORT).
	 * 
	 * @param data the buffer to send
	 * @param host the target host
	 * @see #send(byte[], int, InetAddress, int)
	 * @throws IOException if an error occurs
	 ***/
	public void send(byte[] data, InetAddress host) throws IOException {
		send(data, data.length, host, DEFAULT_PORT);
	}

}