Package 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
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:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final DatagramPacket
static final int
The default echo port.Fields inherited from class org.apache.commons.net.DatagramSocketClient
_isOpen_, _socket_, _socketFactory_, _timeout_
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionint
receive
(byte[] data) Same asreceive(data, data.length)
int
receive
(byte[] data, int length) Receives echoed data and returns its length.void
send
(byte[] data, int length, InetAddress host) Sends the specified data to the specified server at the default echo port.void
send
(byte[] data, InetAddress host) Same assend(data, data.length, host)
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
-
Field Details
-
DEFAULT_PORT
public static final int DEFAULT_PORTThe default echo port. It is set to 7 according to RFC 862.- See Also:
-
__receivePacket
-
-
Constructor Details
-
EchoUDPClient
public EchoUDPClient()
-
-
Method Details
-
send
Sends the specified data to the specified server at the default echo port.- Overrides:
send
in classDiscardUDPClient
- 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:
IOException
- If an error occurs during the datagram send operation.- See Also:
-
send
Same assend(data, data.length, host)
- Overrides:
send
in classDiscardUDPClient
- Parameters:
data
- the buffer to sendhost
- the target host- Throws:
IOException
- if an error occurs- See Also:
-
receive
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 inputlength
- of the buffer- Returns:
- Length of actual data received.
- Throws:
IOException
- If an error occurs while receiving the data.
-
receive
Same asreceive(data, data.length)
- Parameters:
data
- the buffer to receive the input- Returns:
- the number of bytes
- Throws:
IOException
- on error
-