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

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

The current status of the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetIdle();

Unicode (Windows)
BOOL GetIdle();

int ipworks_netclock_getidle(void* lpObj);

bool GetIdle();

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocalHost();
int SetLocalHost(const char* lpszLocalHost);

Unicode (Windows)
LPWSTR GetLocalHost();
INT SetLocalHost(LPCWSTR lpszLocalHost);

char* ipworks_netclock_getlocalhost(void* lpObj);
int ipworks_netclock_setlocalhost(void* lpObj, const char* lpszLocalHost);

QString GetLocalHost();
int SetLocalHost(QString qsLocalHost);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocalTime();

Unicode (Windows)
LPWSTR GetLocalTime();

char* ipworks_netclock_getlocaltime(void* lpObj);

QString GetLocalTime();

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

This property is the protocol used by the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProtocol();
int SetProtocol(int iProtocol);

Unicode (Windows)
INT GetProtocol();
INT SetProtocol(INT iProtocol);

TP_TIME(0), 
TP_SNTP(1)

int ipworks_netclock_getprotocol(void* lpObj);
int ipworks_netclock_setprotocol(void* lpObj, int iProtocol);

int GetProtocol();
int SetProtocol(int iProtocol);

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

This property includes the time returned by the TimeServer .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetServerTime();

Unicode (Windows)
LPWSTR GetServerTime();

char* ipworks_netclock_getservertime(void* lpObj);

QString GetServerTime();

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

The timeout for the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTimeout();
int SetTimeout(int iTimeout);

Unicode (Windows)
INT GetTimeout();
INT SetTimeout(INT iTimeout);

int ipworks_netclock_gettimeout(void* lpObj);
int ipworks_netclock_settimeout(void* lpObj, int iTimeout);

int GetTimeout();
int SetTimeout(int iTimeout);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTimePort();
int SetTimePort(int iTimePort);

Unicode (Windows)
INT GetTimePort();
INT SetTimePort(INT iTimePort);

int ipworks_netclock_gettimeport(void* lpObj);
int ipworks_netclock_settimeport(void* lpObj, int iTimePort);

int GetTimePort();
int SetTimePort(int iTimePort);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTimeServer();
int SetTimeServer(const char* lpszTimeServer);

Unicode (Windows)
LPWSTR GetTimeServer();
INT SetTimeServer(LPCWSTR lpszTimeServer);

char* ipworks_netclock_gettimeserver(void* lpObj);
int ipworks_netclock_settimeserver(void* lpObj, const char* lpszTimeServer);

QString GetTimeServer();
int SetTimeServer(QString qsTimeServer);

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

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* ipworks_netclock_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

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.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

DoEvents Method (NetClock Class)

This method processes events from the internal message queue.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DoEvents();

Unicode (Windows)
INT DoEvents();

int ipworks_netclock_doevents(void* lpObj);

int DoEvents();

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

GetAndSetTime Method (NetClock Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAndSetTime();

Unicode (Windows)
INT GetAndSetTime();

int ipworks_netclock_getandsettime(void* lpObj);

int GetAndSetTime();

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

GetTime Method (NetClock Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTime();

Unicode (Windows)
INT GetTime();

int ipworks_netclock_gettime(void* lpObj);

int GetTime();

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Interrupt Method (NetClock Class)

This method interrupts the current method.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Interrupt();

Unicode (Windows)
INT Interrupt();

int ipworks_netclock_interrupt(void* lpObj);

int Interrupt();

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Reset Method (NetClock Class)

This method resets the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int ipworks_netclock_reset(void* lpObj);

int Reset();

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Error Event (NetClock Class)

Fired when information is available about errors during data delivery.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(NetClockErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} NetClockErrorEventParams;


Unicode (Windows)
virtual INT FireError(NetClockErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} NetClockErrorEventParams;

#define EID_NETCLOCK_ERROR 1

virtual INT IPWORKS_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class NetClockErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(NetClockErrorEventParams *e);

// Or, subclass NetClock and override this emitter function.
virtual int FireError(NetClockErrorEventParams *e) {...}

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)

UDP Config Settings

Socket Config Settings

Base Config Settings

Trappable Errors (NetClock Class)

Error Handling (C++)

Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

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