org.apache.commons.net

Class TimeTCPClient


public final class TimeTCPClient
extends SocketClient

The TimeTCPClient class is a TCP implementation of a client for the Time protocol described in RFC 868. To use the class, merely establish a connection with connect and call either getTime() or getDate() to retrieve the time, then call disconnect to close the connection properly.

See Also:
TimeUDPClient

Field Summary

static int
DEFAULT_PORT
The default time port.
static long
SECONDS_1900_TO_1970
The number of seconds between 00:00 1 January 1900 and 00:00 1 January 1970.

Fields inherited from class org.apache.commons.net.SocketClient

NETASCII_EOL, _defaultPort_, _input_, _isConnected_, _output_, _socketFactory_, _socket_, _timeout_

Constructor Summary

TimeTCPClient()
The default TimeTCPClient constructor.

Method Summary

Date
getDate()
Retrieves the time from the server and returns a Java Date containing the time converted to the local timezone.
long
getTime()
Retrieves the time from the server and returns it.

Methods inherited from class org.apache.commons.net.SocketClient

_connectAction_, connect, connect, connect, connect, connect, connect, disconnect, getDefaultPort, getDefaultTimeout, getLocalAddress, getLocalPort, getRemoteAddress, getRemotePort, getSoLinger, getSoTimeout, getTcpNoDelay, isConnected, setDefaultPort, setDefaultTimeout, setSoLinger, setSoTimeout, setSocketFactory, setTcpNoDelay, verifyRemote

Field Details

DEFAULT_PORT

public static final int DEFAULT_PORT
The default time port. It is set to 37 according to RFC 868. **
Field Value:
37

SECONDS_1900_TO_1970

public static final long SECONDS_1900_TO_1970
The number of seconds between 00:00 1 January 1900 and 00:00 1 January 1970. This value can be useful for converting time values to other formats.
Field Value:
2208988800L

Constructor Details

TimeTCPClient

public TimeTCPClient()
The default TimeTCPClient constructor. It merely sets the default port to DEFAULT_PORT .

Method Details

getDate

public Date getDate()
            throws IOException
Retrieves the time from the server and returns a Java Date containing the time converted to the local timezone.

The server will have closed the connection at this point, so you should call disconnect after calling this method. To retrieve another time, you must initiate another connection with connect before calling getDate() again.

Returns:
A Date value containing the time retrieved from the server converted to the local timezone.

getTime

public long getTime()
            throws IOException
Returns:
The time value retrieved from the server.