org.apache.commons.net
public abstract class DatagramSocketClient extends Object
setDatagramSocketFactory
method, which allows you to control the type of DatagramSocket the
DatagramSocketClient creates for network communications. This is
especially useful for adding things like proxy support as well as better
support for applets. For
example, you could create a
DatagramSocketFactory
that
requests browser security capabilities before creating a socket.
All classes derived from DatagramSocketClient should use the
_socketFactory_
member variable to
create DatagramSocket instances rather than instantiating
them by directly invoking a constructor. By honoring this contract
you guarantee that a user will always be able to provide his own
Socket implementations by substituting his own SocketFactory.
Field Summary | |
---|---|
protected boolean | _isOpen_
A status variable indicating if the client's socket is currently open.
|
protected DatagramSocketFactory | _socketFactory_ The datagram socket's DatagramSocketFactory. |
protected DatagramSocket | _socket_ The datagram socket used for the connection. |
protected int | _timeout_ The timeout to use after opening a socket. |
Constructor Summary | |
---|---|
DatagramSocketClient()
Default constructor for DatagramSocketClient. |
Method Summary | |
---|---|
void | close()
Closes the DatagramSocket used for the connection.
|
int | getDefaultTimeout()
Returns the default timeout in milliseconds that is used when
opening a socket.
|
InetAddress | getLocalAddress()
Returns the local address to which the client's socket is bound.
|
int | getLocalPort()
Returns the port number of the open socket on the local host used
for the connection. |
int | getSoTimeout()
Returns the timeout in milliseconds of the currently opened socket.
|
boolean | isOpen()
Returns true if the client has a currently open socket.
|
void | open()
Opens a DatagramSocket on the local host at the first available port.
|
void | open(int port)
Opens a DatagramSocket on the local host at a specified port.
|
void | open(int port, InetAddress laddr)
Opens a DatagramSocket at the specified address on the local host
at a specified port.
|
void | setDatagramSocketFactory(DatagramSocketFactory factory)
Sets the DatagramSocketFactory used by the DatagramSocketClient
to open DatagramSockets. |
void | setDefaultTimeout(int timeout)
Set the default timeout in milliseconds to use when opening a socket.
|
void | setSoTimeout(int timeout)
Set the timeout in milliseconds of a currently open connection.
|
open()
again. _isOpen_ is set to false and _socket_ is set to null.
If you call this method when the client socket is not open,
a NullPointerException is thrown.
Returns: The default timeout in milliseconds that is used when opening a socket.
Returns: The local address to which the client's socket is bound.
Returns: The port number of the open socket on the local host used for the connection.
Returns: The timeout in milliseconds of the currently opened socket.
Returns: True if the client has a curerntly open socket, false otherwise.
setDefaultTimeout()
.
_isOpen_ is set to true after calling this method and _socket_ is set to the newly opened socket.
Throws: SocketException If the socket could not be opened or the timeout could not be set.
setDefaultTimeout()
.
_isOpen_ is set to true after calling this method and _socket_ is set to the newly opened socket.
Parameters: port The port to use for the socket.
Throws: SocketException If the socket could not be opened or the timeout could not be set.
setDefaultTimeout()
.
_isOpen_ is set to true after calling this method and _socket_ is set to the newly opened socket.
Parameters: port The port to use for the socket. laddr The local address to use.
Throws: SocketException If the socket could not be opened or the timeout could not be set.
Parameters: factory The new DatagramSocketFactory the DatagramSocketClient should use.
open()
and should not be confused with setSoTimeout()
which operates on the currently open socket. _timeout_ contains
the new timeout value.
Parameters: timeout The timeout in milliseconds to use for the datagram socket connection.
open()
.
Parameters: timeout The timeout in milliseconds to use for the currently open datagram socket connection.