NetClock Class

Properties   Methods   Events   Configuration Settings   Errors  

The NetClock class 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);
 ipworks_netclock_do_reset($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.

IdleThe current status of the class.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
LocalTimeThe time returned by the TimeServer converted to local time.
ProtocolThe protocol used by the class.
ServerTimeThe time returned by the TimeServer .
TimeoutA timeout for the class.
TimePortThe UDP port where the remote Time server is listening.
TimeServerThe 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.

ConfigSets or retrieves a configuration setting.
DoEventsProcesses events from the internal message queue.
GetAndSetTimeSame as the GetTime method, but system clock is also set to the received time.
GetTimeSends a time request to the TimeServer to get the current time.
InterruptInterrupt the current method.
ResetReset the class.

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.

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

CaptureIPPacketInfoUsed to capture the packet information.
DestinationAddressUsed to get the destination address from the packet information.
DontFragmentUsed to set the Don't Fragment flag of outgoing packets.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe port in the local host where the class binds.
MaxPacketSizeThe maximum length of the packets that can be received.
QOSDSCPValueUsed to specify an arbitrary QOS/DSCP setting (optional).
QOSTrafficTypeUsed to specify QOS/DSCP settings (optional).
ShareLocalPortIf set to True, allows more than one instance of the class to be active on the same local port.
SourceIPAddressUsed to set the source IP address used when sending a packet.
SourceMacAddressUsed to set the source MAC address used when sending a packet.
UseConnectionDetermines whether to use a connected socket.
UseIPv6Whether or not to use IPv6.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
ProcessIdleEventsWhether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillisThe length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPITells the class whether or not to use the system security libraries or an internal implementation.

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks 2020 PHP Edition - Version 20.0 [Build 8307]