NetClock Class

Properties Methods Events Configuration Settings Errors

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

Syntax

class ipworks.NetClock

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 time_server property. You get the time by calling the get_time method.

The class also allows you to synchronize your system time with that of the time_server. This is done through the get_and_set_time method. Calling get_and_set_time 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 class.
local_host	The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
local_time	The time returned by the TimeServer converted to local time.
protocol	The protocol used by the class.
server_time	The time returned by the TimeServer .
timeout	A timeout for the class.
time_port	The UDP port where the remote Time server is listening.
time_server	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.
do_events	Processes events from the internal message queue.
get_and_set_time	Same as the GetTime method, but system clock is also set to the received time.
get_time	Sends a time request to the TimeServer to get the current time.
interrupt	Interrupt the current method.
reset	Reset 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.


on_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 port in the local host where the class binds.
MaxPacketSize	The maximum length of the packets that can be received.
QOSDSCPValue	Used to specify an arbitrary QOS/DSCP setting (optional).
QOSTrafficType	Used to specify QOS/DSCP settings (optional).
ShareLocalPort	If set to True, allows more than one instance of the class to be active on the same local port.
SourceIPAddress	Used to set the source IP address used when sending a packet.
SourceMacAddress	Used to set the source MAC address used when sending a packet.
UseConnection	Determines whether to use a connected socket.
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.
BuildInfo	Information about the product's build.
CodePage	The system code page used for Unicode to Multibyte translations.
LicenseInfo	Information about the current license.
ProcessIdleEvents	Whether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillis	The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPI	Tells the class whether or not to use the system security libraries or an internal implementation.