|
IP*Works! V9 | |||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectipworks.Netclock
public class Netclock
The NetClock bean provides the current (GMT) time from an Internet Time Server.
The NetClock component implements a standard Time Protocol client as specified in RFC 868, as well as an SNTP Protocol.
The address of the Time Server is provided in the TimeServer
property. You get the time by calling the GetTime
method.
The bean also allows you to synchronize your system time
with that of the TimeServer
. This is done through the GetAndSetTime
method. Calling GetAndSetTime
will request
the time from the
server and then set the system clock to match it.
Field Summary | |
---|---|
static int |
tpSNTP
|
static int |
tpTime
|
Constructor Summary | |
---|---|
Netclock()
Creates an instance of Netclock Bean. |
|
Netclock(java.lang.String runtimeLicense)
Creates an instance of Netclock Bean with specified run-time license. |
Method Summary | |
---|---|
void |
addNetclockEventListener(NetclockEventListener l)
|
java.lang.String |
config(java.lang.String configurationString)
Sets or retrieves a configuration setting. |
void |
doEvents()
Processes events from the internal message queue. |
void |
getAndSetTime()
Same as the GetTime method, but system clock is also set to the received time. |
java.lang.String |
getLocalHost()
The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
java.lang.String |
getLocalTime()
The time returned by the TimeServer converted to local time. |
int |
getProtocol()
The protocol used by the component. |
java.lang.String |
getServerTime()
The time returned by the TimeServer . |
void |
getTime()
Sends a time request to the TimeServer to get the current time. |
int |
getTimeout()
A timeout for the bean. |
int |
getTimePort()
The UDP port where the remote Time server is listening. |
java.lang.String |
getTimeServer()
The time server from which to request the time. |
void |
interrupt()
Interrupt the current method. |
boolean |
isIdle()
The current status of the component. |
void |
removeNetclockEventListener(NetclockEventListener l)
|
void |
setLocalHost(java.lang.String localHost)
The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
void |
setProtocol(int protocol)
The protocol used by the component. |
void |
setTimeout(int timeout)
A timeout for the bean. |
void |
setTimePort(int timePort)
The UDP port where the remote Time server is listening. |
void |
setTimeServer(java.lang.String timeServer)
The time server from which to request the time. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int tpTime
public static final int tpSNTP
Constructor Detail |
---|
public Netclock()
public Netclock(java.lang.String runtimeLicense)
Method Detail |
---|
public boolean isIdle()
Idle
will be False if the component is currently busy (communicating
and/or waiting for an answer), and True at all other times.
public java.lang.String getLocalHost()
The LocalHost
property contains the name of the local host
as obtained by the gethostname() system call, or if the
user has assigned an IP address, the value of that address.
In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the bean initiate connections (or accept in the case of server beans) only through that interface.
If the bean is connected, the LocalHost
property shows
the IP address of the interface through which the connection
is made in internet dotted format (aaa.bbb.ccc.ddd). In most
cases, this is the address of the local host, except for multi-homed
hosts (machines with more than one IP interface).
NOTE: LocalHost
is not persistent. You must always set it in
code, and never in the property window.
public void setLocalHost(java.lang.String localHost) throws IPWorksException
The LocalHost
property contains the name of the local host
as obtained by the gethostname() system call, or if the
user has assigned an IP address, the value of that address.
In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the bean initiate connections (or accept in the case of server beans) only through that interface.
If the bean is connected, the LocalHost
property shows
the IP address of the interface through which the connection
is made in internet dotted format (aaa.bbb.ccc.ddd). In most
cases, this is the address of the local host, except for multi-homed
hosts (machines with more than one IP interface).
NOTE: LocalHost
is not persistent. You must always set it in
code, and never in the property window.
IPWorksException
public java.lang.String getLocalTime()
TimeServer
converted to local time.
The server provides Greenwich Mean Time (GMT). This property contains the corresponding local time formatted as "MM/DD/YYYY HH:MM:SS" (where "HH" is in 24 hour format).
public int getProtocol()
This property is the protocol used by the component. Use this property to specify which protocol the bean will use to connect to the server. By default, this property is tpTimeProtocol (0). The SNTP protocol may be selected by setting this property to tpSNTP (1).
public void setProtocol(int protocol) throws IPWorksException
This property is the protocol used by the component. Use this property to specify which protocol the bean will use to connect to the server. By default, this property is tpTimeProtocol (0). The SNTP protocol may be selected by setting this property to tpSNTP (1).
IPWorksException
public java.lang.String getServerTime()
TimeServer
.
This property contains the time returned by the TimeServer
. The time is Greenwich Mean Time (GMT) formatted as
"MM/DD/YYYY HH:MM:SS GMT" (where "HH" is in 24 hour format).
For the corresponding local time, please consult the LocalTime
property.
public int getTimeout()
If the Timeout
property is set to 0, all operations
will run uninterrupted until successful completion or an error condition
is encountered.
If Timeout
is set to a positive value, the bean will
wait for the operation to complete before returning control.
The bean will use DoEvents
to enter an efficient wait loop
during any potential waiting period, making sure that all system events
are processed immediately as they arrive. This ensures that the host
application does not "freeze" and remains responsive.
If Timeout
expires, and the operation is not yet complete,
the bean throws an exception.
Please note that by default, all timeouts are inactivity timeouts ,
i.e. the timeout period is extended by Timeout
seconds when
any amount of data is successfully sent or received.
Optionally, the behavior of the bean may be changed to absolute timeouts , i.e. the bean will wait for a maximum
of Timeout
seconds since the beginning of the operation, without
extending the timeout period during communications.
This behavior is controlled by the AbsoluteTimeout
configuration setting.
The default value for the Timeout
property is 60 (seconds).
public void setTimeout(int timeout) throws IPWorksException
If the Timeout
property is set to 0, all operations
will run uninterrupted until successful completion or an error condition
is encountered.
If Timeout
is set to a positive value, the bean will
wait for the operation to complete before returning control.
The bean will use DoEvents
to enter an efficient wait loop
during any potential waiting period, making sure that all system events
are processed immediately as they arrive. This ensures that the host
application does not "freeze" and remains responsive.
If Timeout
expires, and the operation is not yet complete,
the bean throws an exception.
Please note that by default, all timeouts are inactivity timeouts ,
i.e. the timeout period is extended by Timeout
seconds when
any amount of data is successfully sent or received.
Optionally, the behavior of the bean may be changed to absolute timeouts , i.e. the bean will wait for a maximum
of Timeout
seconds since the beginning of the operation, without
extending the timeout period during communications.
This behavior is controlled by the AbsoluteTimeout
configuration setting.
The default value for the Timeout
property is 60 (seconds).
IPWorksException
public int getTimePort()
This property is the UDP port on the TimeServer
to which
Time requests are sent. If Protocol
is set to tpSNTP the component
will set this property to 123.
public void setTimePort(int timePort) throws IPWorksException
This property is the UDP port on the TimeServer
to which
Time requests are sent. If Protocol
is set to tpSNTP the component
will set this property to 123.
IPWorksException
public java.lang.String getTimeServer()
This property contains the time server from which to request the time. This property should be set to a valid internet address of a time server. The server will reply with its current time (GMT).
Time requests are sent to port TimePort
on the TimeServer
.
public void setTimeServer(java.lang.String timeServer) throws IPWorksException
This property contains the time server from which to request the time. This property should be set to a valid internet address of a time server. The server will reply with its current time (GMT).
Time requests are sent to port TimePort
on the TimeServer
.
IPWorksException
public java.lang.String config(java.lang.String configurationString) throws IPWorksException
Config
is a generic method available in every bean.
It is used to set and retrieve configuration settings
for the
bean.
Configuration settings are similar in functionality to properties,
but they are rarely used. In order to avoid "polluting" the property
namespace of the bean, access to these internal properties is provided through the Config
method.
To set a configuration setting named PROPERTY , you must call Config("PROPERTY=VALUE") , where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY") . The value will be returned as a string.
The bean accepts one or more of the following configuration settings .
Configuration settings are similar in functionality to properties,
but they are rarely used. In order to avoid "polluting" the property
namespace of the bean, access to these internal properties is provided through the Config
method.
Note: This setting is only available in Windows.
CaptureIPPacketInfo
is set to true, then this will be populated with the packet's destination address when a packet is received.
This information will be accessible in the DataIn event.Note: This setting is only available in Windows.
LocalHost
setting contains the name of the local host
as obtained by the gethostname() system call, or if the
user has assigned an IP address, the value of that address.In multi-homed hosts (machines with more than one IP interface)
setting LocalHost to the value of an interface will make the
bean initiate connections (or accept in the case of server
beans) only through that interface.
If the bean is connected, the LocalHost
setting shows
the IP address of the interface through which the connection
is made in internet dotted format (aaa.bbb.ccc.ddd). In most
cases, this is the address of the local host, except for multi-homed
hosts (machines with more than one IP interface).
LocalPort
after the connection is established.
LocalPort
cannot be changed once a connection is made.
Any attempt to set this when a connection is active will
generate an error.
This; setting is useful when trying to connect to services that require a trusted port in the client side. An example is the remote shell (rsh) service in UNIX systems.
Active
property or it will have no effect.The default value for this setting is False.
UseConnection
specifies whether the bean
should use a connected socket or not. The connection is
defined as an association in between the local address/port
and the remote address/port. As such, this
is not a connection in the traditional TCP sense. What it
means is only that the bean will send and receive data
only to and from the specified destination.The default value for this setting is False.
UseConnection
must be True to use this setting. This option allows you to specify an arbitrary DSCP value
between 0 and 63. The default is 0. When set to the default value the component will not set a DSCP value.Note: This setting uses the qWAVE API is only available on Windows 7, Windows Server 2008 R2, and later.
UseConnection
must be True to use this setting.
You may specify either the text or integer values: BestEffort (0), Background (1), ExcellentEffort (2), AudioVideo (3), Voice (4), and Control (5).Note: This setting uses the qWAVE API which is only available on Windows Vista and Windows Server 2008 or above.
Note: QOSTrafficType must be set before setting Active
to true.
IPWorksException
public void doEvents() throws IPWorksException
When DoEvents
is called, the bean processes any
available events. If no events are available, it waits for a
preset period of time, and then returns.
IPWorksException
public void getAndSetTime() throws IPWorksException
GetTime
method, but system clock is also set to the received time.
This method is similar to the GetTime
method, but the system clock is also set
to the received time (adjusted for timezone differences).
IPWorksException
public void getTime() throws IPWorksException
TimeServer
to get the current time.
This method sends a time request to the TimeServer
on port 37. The reply is provided in the ServerTime
property, and the equivalent local time is provided in the LocalTime
property.
IPWorksException
public void interrupt() throws IPWorksException
If there is no method in progress, Interrupt
simply returns, doing nothing.
IPWorksException
public void addNetclockEventListener(NetclockEventListener l) throws java.util.TooManyListenersException
java.util.TooManyListenersException
public void removeNetclockEventListener(NetclockEventListener l)
|
IP*Works! V9 | |||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |