NetClock Class

Properties Methods Events Configuration Settings Errors

The NetClock component provides the current (GMT) time from an Internet Time Server.

Class Name

IPWorks_NetClock

Procedural Interface

 ipworks_netclock_open();
 ipworks_netclock_close($res);
 ipworks_netclock_register_callback($res, $id, $function);
 ipworks_netclock_get_last_error($res);
 ipworks_netclock_get_last_error_code($res);
 ipworks_netclock_set($res, $id, $index, $value);
 ipworks_netclock_get($res, $id, $index);
 ipworks_netclock_do_config($res, $configurationstring);
 ipworks_netclock_do_doevents($res);
 ipworks_netclock_do_getandsettime($res);
 ipworks_netclock_do_gettime($res);
 ipworks_netclock_do_interrupt($res);

Remarks

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 class 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.

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.


Idle	The current status of the component.
LocalHost	The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
LocalTime	The time returned by the TimeServer converted to local time.
Protocol	The protocol used by the component.
ServerTime	The time returned by the TimeServer .
Timeout	A timeout for the component.
TimePort	The UDP port where the remote Time server is listening.
TimeServer	The time server from which to request the time.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.


Config	Sets or retrieves a configuration setting .
DoEvents	Processes events from the internal message queue.
GetAndSetTime	Same as the GetTime method, but system clock is also set to the received time.
GetTime	Sends a time request to the TimeServer to get the current time.
Interrupt	Interrupt the current method.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.


Error	Information about errors during data delivery.

Configuration Settings

The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.


CaptureIPPacketInfo	Used to capture the packet information.
DestinationAddress	Used to get the destination address from the packet information.
DontFragment	Used to set the Don't Fragment flag of outgoing packets.
LocalHost	The name of the local host through which connections are initiated or accepted.
LocalPort	The TCP port in the local host where the component binds.
MaxPacketSize	The maximum length of the packets that can be received.
ShareLocalPort	If set to True, allows more than one instance of the component to be active on the same local port.
UseConnection	Determines whether to use a connected socket.
QOSDSCPValue	Used to specify an arbitrary QOS/DSCP setting (optional).
QOSTrafficType	Used to specify QOS/DSCP settings (optional).
UseIPv6	Whether or not to use IPv6.
AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallData	Used to send extra data to the firewall.
InBufferSize	The size in bytes of the incoming queue of the socket.
OutBufferSize	The size in bytes of the outgoing queue of the socket.
CodePage	The system code page used for Unicode to Multibyte translations.