NetClock Class

Properties   Methods   Events   Config Settings   Errors  

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

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 (IPWorks_NetClock Class)

The current status of the class.

Object Oriented Interface

public function getIdle();

Procedural Interface

ipworks_netclock_get($res, 1 );

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.

Data Type

Boolean

LocalHost Property (IPWorks_NetClock Class)

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

Object Oriented Interface

public function getLocalHost();
public function setLocalHost($value);

Procedural Interface

ipworks_netclock_get($res, 2 );
ipworks_netclock_set($res, 2, $value );

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

Data Type

String

LocalTime Property (IPWorks_NetClock Class)

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

Object Oriented Interface

public function getLocalTime();

Procedural Interface

ipworks_netclock_get($res, 3 );

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 and not available at design time.

Data Type

String

Protocol Property (IPWorks_NetClock Class)

This property is the protocol used by the class.

Object Oriented Interface

public function getProtocol();
public function setProtocol($value);

Procedural Interface

ipworks_netclock_get($res, 4 );
ipworks_netclock_set($res, 4, $value );

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

Data Type

Integer

ServerTime Property (IPWorks_NetClock Class)

This property includes the time returned by the TimeServer .

Object Oriented Interface

public function getServerTime();

Procedural Interface

ipworks_netclock_get($res, 5 );

Default Value

''

Remarks

This property contains the time returned by the TimeServer. 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 LocalTime property.

This property is read-only and not available at design time.

Data Type

String

Timeout Property (IPWorks_NetClock Class)

The timeout for the class.

Object Oriented Interface

public function getTimeout();
public function setTimeout($value);

Procedural Interface

ipworks_netclock_get($res, 6 );
ipworks_netclock_set($res, 6, $value );

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

Data Type

Integer

TimePort Property (IPWorks_NetClock Class)

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

Object Oriented Interface

public function getTimePort();
public function setTimePort($value);

Procedural Interface

ipworks_netclock_get($res, 7 );
ipworks_netclock_set($res, 7, $value );

Default Value

123

Remarks

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

This property is not available at design time.

Data Type

Integer

TimeServer Property (IPWorks_NetClock Class)

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

Object Oriented Interface

public function getTimeServer();
public function setTimeServer($value);

Procedural Interface

ipworks_netclock_get($res, 8 );
ipworks_netclock_set($res, 8, $value );

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 TimePort on the TimeServer.

Data Type

String

Config Method (IPWorks_NetClock Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

ipworks_netclock_do_config($res, $configurationstring);

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.

DoEvents Method (IPWorks_NetClock Class)

This method processes events from the internal message queue.

Object Oriented Interface

public function doEvents();

Procedural Interface

ipworks_netclock_do_doevents($res);

Remarks

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

GetAndSetTime Method (IPWorks_NetClock Class)

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

Object Oriented Interface

public function doGetAndSetTime();

Procedural Interface

ipworks_netclock_do_getandsettime($res);

Remarks

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

GetTime Method (IPWorks_NetClock Class)

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

Object Oriented Interface

public function doGetTime();

Procedural Interface

ipworks_netclock_do_gettime($res);

Remarks

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.

Interrupt Method (IPWorks_NetClock Class)

This method interrupts the current method.

Object Oriented Interface

public function doInterrupt();

Procedural Interface

ipworks_netclock_do_interrupt($res);

Remarks

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

Reset Method (IPWorks_NetClock Class)

This method resets the class.

Object Oriented Interface

public function doReset();

Procedural Interface

ipworks_netclock_do_reset($res);

Remarks

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

Error Event (IPWorks_NetClock Class)

Fired when information is available about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

ipworks_netclock_register_callback($res, 1, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

Remarks

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

Config Settings (NetClock Class)

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

Trappable Errors (NetClock Class)

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