View Javadoc
1 package org.apache.commons.net; 2 3 /* ==================================================================== 4 * The Apache Software License, Version 1.1 5 * 6 * Copyright (c) 2001 The Apache Software Foundation. All rights 7 * reserved. 8 * 9 * Redistribution and use in source and binary forms, with or without 10 * modification, are permitted provided that the following conditions 11 * are met: 12 * 13 * 1. Redistributions of source code must retain the above copyright 14 * notice, this list of conditions and the following disclaimer. 15 * 16 * 2. Redistributions in binary form must reproduce the above copyright 17 * notice, this list of conditions and the following disclaimer in 18 * the documentation and/or other materials provided with the 19 * distribution. 20 * 21 * 3. The end-user documentation included with the redistribution, 22 * if any, must include the following acknowledgment: 23 * "This product includes software developed by the 24 * Apache Software Foundation (http://www.apache.org/)." 25 * Alternately, this acknowledgment may appear in the software itself, 26 * if and wherever such third-party acknowledgments normally appear. 27 * 28 * 4. The names "Apache" and "Apache Software Foundation" and 29 * "Apache Commons" must not be used to endorse or promote products 30 * derived from this software without prior written permission. For 31 * written permission, please contact apache@apache.org. 32 * 33 * 5. Products derived from this software may not be called "Apache", 34 * nor may "Apache" appear in their name, without 35 * prior written permission of the Apache Software Foundation. 36 * 37 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED 38 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 39 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 40 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR 41 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 42 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 43 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF 44 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 45 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 46 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT 47 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 48 * SUCH DAMAGE. 49 * ==================================================================== 50 * 51 * This software consists of voluntary contributions made by many 52 * individuals on behalf of the Apache Software Foundation. For more 53 * information on the Apache Software Foundation, please see 54 * <http://www.apache.org/>;. 55 */ 56 57 import java.io.IOException; 58 import java.net.DatagramPacket; 59 import java.net.InetAddress; 60 61 /**** 62 * The EchoUDPClient class is a UDP implementation of a client for the 63 * Echo protocol described in RFC 862. To use the class, 64 * just open a local UDP port 65 * with <a href="org.apache.commons.net.DatagramSocketClient.html#open"> open </a> 66 * and call <a href="#send"> send </a> to send datagrams to the server, 67 * then call <a href="#receive"> receive </a> to receive echoes. 68 * After you're done echoing data, call 69 * <a href="org.apache.commons.net.DatagramSocketClient.html#close"> close() </a> 70 * to clean up properly. 71 * <p> 72 * <p> 73 * @author Daniel F. Savarese 74 * @see EchoTCPClient 75 * @see DiscardUDPClient 76 ***/ 77 78 public final class EchoUDPClient extends DiscardUDPClient 79 { 80 /**** The default echo port. It is set to 7 according to RFC 862. ***/ 81 public static final int DEFAULT_PORT = 7; 82 83 private DatagramPacket __receivePacket = new DatagramPacket(new byte[0], 0); 84 85 /**** 86 * Sends the specified data to the specified server at the default echo 87 * port. 88 * <p> 89 * @param data The echo data to send. 90 * @param length The length of the data to send. Should be less than 91 * or equal to the length of the data byte array. 92 * @param host The address of the server. 93 * @exception IOException If an error occurs during the datagram send 94 * operation. 95 ***/ 96 public void send(byte[] data, int length, InetAddress host) 97 throws IOException 98 { 99 send(data, length, host, DEFAULT_PORT); 100 } 101 102 103 /**** Same as <code> send(data, data.length, host) </code> ***/ 104 public void send(byte[] data, InetAddress host) throws IOException 105 { 106 send(data, data.length, host, DEFAULT_PORT); 107 } 108 109 110 /**** 111 * Receives echoed data and returns its length. The data may be divided 112 * up among multiple datagrams, requiring multiple calls to receive. 113 * Also, the UDP packets will not necessarily arrive in the same order 114 * they were sent. 115 * <p> 116 * @return Length of actual data received. 117 * @exception IOException If an error occurs while receiving the data. 118 ***/ 119 public int receive(byte[] data, int length) throws IOException 120 { 121 __receivePacket.setData(data); 122 __receivePacket.setLength(length); 123 _socket_.receive(__receivePacket); 124 return __receivePacket.getLength(); 125 } 126 127 /**** Same as <code> receive(data, data.length)</code> ***/ 128 public int receive(byte[] data) throws IOException 129 { 130 return receive(data, data.length); 131 } 132 133 } 134

This page was automatically generated by Maven