java.lang.Object
org.apache.commons.net.SocketClient
org.apache.commons.net.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 55
and call either getTime() 55 or
getDate() 55 to retrieve the time, then
call disconnect 55
to close the connection properly.
|
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. |
|
Constructor Summary |
TimeTCPClient()
The default TimeTCPClient constructor. |
|
Method Summary |
java.util.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, setSocketFactory, setSoLinger, setSoTimeout, setTcpNoDelay, verifyRemote |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
DEFAULT_PORT
public static final int DEFAULT_PORT
- The default time port. It is set to 37 according to RFC 868.
- See Also:
- Constant Field Values
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.
- See Also:
- Constant Field Values
TimeTCPClient
public TimeTCPClient()
- The default TimeTCPClient constructor. It merely sets the default
port to
DEFAULT_PORT .
getTime
public long getTime()
throws java.io.IOException
- Retrieves the time from the server and returns it. The time
is the number of seconds since 00:00 (midnight) 1 January 1900 GMT,
as specified by RFC 868. This method reads the raw 32-bit big-endian
unsigned integer from the server, converts it to a Java long, and
returns the value.
The server will have closed the connection at this point, so you should
call
disconnect 55
after calling this method. To retrieve another time, you must
initiate another connection with
connect 55
before calling getTime() again.
getDate
public java.util.Date getDate()
throws java.io.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 55
after calling this method. To retrieve another time, you must
initiate another connection with
connect 55
before calling getDate() again.