EchoUDPClient
Date: 2016-06-23

org.apache.commons.net.echo

## Class EchoUDPClient

- java.lang.Object
- - org.apache.commons.net.DatagramSocketClient
  - - org.apache.commons.net.discard.DiscardUDPClient
    - - org.apache.commons.net.echo.EchoUDPClient

-     public final class EchoUDPClient
      extends DiscardUDPClient

  The EchoUDPClient class is a UDP implementation of a client for the Echo protocol described in RFC 862. To use the class, just open a local UDP port with `open` and call `send` to send datagrams to the server, then call `receive` to receive echoes. After you're done echoing data, call `close()` to clean up properly.
  See Also:
    `EchoTCPClient`, `DiscardUDPClient`

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `static int` | `DEFAULT_PORT` The default echo port.

    - ### Fields inherited from class org.apache.commons.net.DatagramSocketClient

      `_isOpen_, _socket_, _socketFactory_, _timeout_`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `EchoUDPClient()`

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `int` | `receive(byte[] data)` Same as `receive(data, data.length)`
    `int` | `receive(byte[] data, int length)` Receives echoed data and returns its length.
    `void` | `send(byte[] data, java.net.InetAddress host)` Same as `send(data, data.length, host)`
    `void` | `send(byte[] data, int length, java.net.InetAddress host)` Sends the specified data to the specified server at the default echo port.

    - ### Methods inherited from class org.apache.commons.net.discard.DiscardUDPClient

      `send`

    - ### Methods inherited from class org.apache.commons.net.DatagramSocketClient

      `close, getCharset, getCharsetName, getDefaultTimeout, getLocalAddress, getLocalPort, getSoTimeout, isOpen, open, open, open, setCharset, setDatagramSocketFactory, setDefaultTimeout, setSoTimeout`

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Field Detail

    - #### DEFAULT_PORT

          public static final int DEFAULT_PORT

      The default echo port. It is set to 7 according to RFC 862.
      See Also:
        Constant Field Values

  - ### Constructor Detail

    - #### EchoUDPClient

          public EchoUDPClient()

  - ### Method Detail

    - #### send

          public void send(byte[] data,
                  int length,
                  java.net.InetAddress host)
                    throws java.io.IOException

      Sends the specified data to the specified server at the default echo port.
      Overrides:
        `send` in class `DiscardUDPClient`
      Parameters:
        `data` - The echo data to send.
        `length` - The length of the data to send. Should be less than or equal to the length of the data byte array.
        `host` - The address of the server.
      Throws:
        `java.io.IOException` - If an error occurs during the datagram send operation.
      See Also:
        `DiscardUDPClient.send(byte[], int, InetAddress, int)`

    - #### send

          public void send(byte[] data,
                  java.net.InetAddress host)
                    throws java.io.IOException

      Same as `send(data, data.length, host)`
      Overrides:
        `send` in class `DiscardUDPClient`
      Parameters:
        `data` - the buffer to send
        `host` - the target host
      Throws:
        `java.io.IOException` - if an error occurs
      See Also:
        `DiscardUDPClient.send(byte[], int, InetAddress, int)`

    - #### receive

          public int receive(byte[] data,
                    int length)
                      throws java.io.IOException

      Receives echoed data and returns its length. The data may be divided up among multiple datagrams, requiring multiple calls to receive. Also, the UDP packets will not necessarily arrive in the same order they were sent.
      Parameters:
        `data` - the buffer to receive the input
        `length` - of the buffer
      Returns:
        Length of actual data received.
      Throws:
        `java.io.IOException` - If an error occurs while receiving the data.

    - #### receive

          public int receive(byte[] data)
                      throws java.io.IOException

      Same as `receive(data, data.length)`
      Parameters:
        `data` - the buffer to receive the input
      Returns:
        the number of bytes
      Throws:
        `java.io.IOException` - on error