NetClock Class

Properties   Methods   Events   Config Settings   Errors  

The NetClock class provides the current time in Greenwich Mean 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 (Simple Network Time 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.

Method List

---

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

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.

Config Settings

---

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

idle Property

The current status of the class.

Syntax

def get_idle() -> bool: ...

idle = property(get_idle, None)

Default Value

TRUE

Remarks

This property will be False if the component is currently busy (communicating or waiting for an answer), and True at all other times.

This property is read-only.

local_host Property

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

def get_local_host() -> str: ...
def set_local_host(value: str) -> None: ...

local_host = property(get_local_host, set_local_host)

Default Value

""

Remarks

This 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 multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

If the class is connected, the local_host 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 multihomed hosts (machines with more than one IP interface).

Note: local_host is not persistent. You must always set it in code, and never in the property window.

local_time Property

This property includes the time returned by the TimeServer converted to local time.

Syntax

def get_local_time() -> str: ...

local_time = property(get_local_time, None)

Default Value

""

Remarks

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

This property is read-only.

protocol Property

This property is the protocol used by the class.

Syntax

def get_protocol() -> int: ...
def set_protocol(value: int) -> None: ...

protocol = property(get_protocol, set_protocol)

Default Value

1

Remarks

This property is the protocol used by the component. This property is used to specify which protocol the class will use to connect to the server. By default, this property is tpSNTP (1). The Time Protocol may be selected by setting this property to tpTimeProtocol (0).

server_time Property

This property includes the time returned by the TimeServer .

Syntax

def get_server_time() -> str: ...

server_time = property(get_server_time, None)

Default Value

""

Remarks

This property contains the time returned by the time_server. The time is given in Greenwich Mean Time (GMT) and is formatted as "MM/DD/YYYY HH:MM:SS GMT" (where "HH" is in 24-hour format).

For the corresponding local time, please consult the local_time property.

This property is read-only.

timeout Property

The timeout for the class.

Syntax

def get_timeout() -> int: ...
def set_timeout(value: int) -> None: ...

timeout = property(get_timeout, set_timeout)

Default Value

60

Remarks

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 class will wait for the operation to complete before returning control.

The class will use do_events 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 class fails with an error.

Note: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by timeout seconds when any amount of data is successfully sent or received.

The default value for the timeout property is 60 seconds.

time_port Property

This property includes the User Datagram Protocol (UDP) port where the remote time server is listening.

Syntax

def get_time_port() -> int: ...
def set_time_port(value: int) -> None: ...

time_port = property(get_time_port, set_time_port)

Default Value

123

Remarks

This property is the UDP port on the time_server to which time requests are sent. If protocol is set to tpTimeProtocol, the component will set this property to 37.

time_server Property

This property includes the time server from which to request the time.

Syntax

def get_time_server() -> str: ...
def set_time_server(value: str) -> None: ...

time_server = property(get_time_server, set_time_server)

Default Value

"pool.ntp.org"

Remarks

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 (in Greenwich Mean Time).

When protocol is set to SNTP another public server that may be used is "time.google.com".

Time requests are sent to port time_port on the time_server.

config Method

Sets or retrieves a configuration setting.

Syntax

def config(configuration_string: str) -> str: ...

Remarks

config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, 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.

do_events Method

This method processes events from the internal message queue.

Syntax

def do_events() -> None: ...

Remarks

When do_events is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.

get_and_set_time Method

This method is the same as the GetTime method, but the system clock is also set to the received time.

Syntax

def get_and_set_time() -> None: ...

Remarks

This method is similar to the get_time method, but the system clock is also set to the received time (adjusted for timezone differences).

get_time Method

This method sends a time request to the TimeServer to get the current time.

Syntax

def get_time() -> None: ...

Remarks

This method sends a time request to the time_server on port 37. The reply is provided in the server_time property, and the equivalent local time is provided in the local_time property.

interrupt Method

This method interrupts the current method.

Syntax

def interrupt() -> None: ...

Remarks

If there is no method in progress, interrupt simply returns, doing nothing.

reset Method

This method resets the class.

Syntax

def reset() -> None: ...

Remarks

This method will reset the class's properties to their default values.

on_error Event

Fired when information is available about errors during data delivery.

Syntax

class NetClockErrorEventParams(object):
  @property
  def error_code() -> int: ...

  @property
  def description() -> str: ...

# In class NetClock:
@property
def on_error() -> Callable[[NetClockErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[NetClockErrorEventParams], None]) -> None: ...

Remarks

The on_error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

NetClock Config Settings

The class 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 class, access to these internal properties is provided through the config method.

UDP Config Settings

Socket Config Settings

Base Config Settings

NetClock Errors

NetClock Errors

The class may also return one of the following error codes, which are inherited from other classes.

UDP Errors

SSL Errors

TCP/IP Errors