NetClock Module

Properties   Methods   Events   Config Settings   Errors  

The NetClock module provides the current time in Greenwich Mean Time from an Internet Time Server.

Syntax

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 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 module with short descriptions. Click on the links for further details.

Method List

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

Event List

The following is the full list of the events fired by the module with short descriptions. Click on the links for further details.

Config Settings

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

Idle Property (NetClock Module)

The current status of the module.

Syntax

• Swift
• Objective-C

public var idle: Bool {
  get {...}
}

@property (nonatomic,readonly,assign,getter=idle) BOOL idle;

- (BOOL)idle;

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.

LocalHost Property (NetClock Module)

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

Syntax

• Swift
• Objective-C

public var localHost: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=localHost,setter=setLocalHost:) NSString* localHost;

- (NSString*)localHost;
- (void)setLocalHost :(NSString*)newLocalHost;

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.

LocalTime Property (NetClock Module)

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

Syntax

• Swift
• Objective-C

public var localTime: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=localTime) NSString* localTime;

- (NSString*)localTime;

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

This property is the protocol used by the module.

Syntax

• Swift
• Objective-C

public var protocol_: NetClockProtocols {
  get {...}
  set {...}
}

public enum NetClockProtocols: Int32 {
  case tpTime = 0
  case tpSNTP = 1
}

@property (nonatomic,readwrite,assign,getter=protocol,setter=setProtocol:) int protocol;

- (int)protocol;
- (int)protocol_;
- (void)setProtocol :(int)newProtocol;
- (void)setProtocol_ :(int)newProtocol;

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

ServerTime Property (NetClock Module)

This property includes the time returned by the TimeServer .

Syntax

• Swift
• Objective-C

public var serverTime: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=serverTime) NSString* serverTime;

- (NSString*)serverTime;

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.

Timeout Property (NetClock Module)

The timeout for the module.

Syntax

• Swift
• Objective-C

public var timeout: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=timeout,setter=setTimeout:) int timeout;

- (int)timeout;
- (void)setTimeout :(int)newTimeout;

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 .

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.

TimePort Property (NetClock Module)

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

Syntax

• Swift
• Objective-C

public var timePort: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=timePort,setter=setTimePort:) int timePort;

- (int)timePort;
- (void)setTimePort :(int)newTimePort;

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.

TimeServer Property (NetClock Module)

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

Syntax

• Swift
• Objective-C

public var timeServer: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=timeServer,setter=setTimeServer:) NSString* timeServer;

- (NSString*)timeServer;
- (void)setTimeServer :(NSString*)newTimeServer;

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.

Config Method (NetClock Module)

Sets or retrieves a configuration setting.

Syntax

• Swift
• Objective-C

public func config(configurationString: String) throws -> String

- (NSString*)config:(NSString*)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 (NetClock Module)

This method processes events from the internal message queue.

Syntax

• Swift
• Objective-C

public func doEvents() throws -> Void

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

GetAndSetTime Method (NetClock Module)

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

Syntax

• Swift
• Objective-C

public func getAndSetTime() throws -> Void

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

GetTime Method (NetClock Module)

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

Syntax

• Swift
• Objective-C

public func getTime() throws -> Void

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

Interrupt Method (NetClock Module)

This method interrupts the current method.

Syntax

• Swift
• Objective-C

public func interrupt() throws -> Void

- (void)interrupt;

Remarks

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

Reset Method (NetClock Module)

This method resets the component.

Syntax

• Swift
• Objective-C

public func reset() throws -> Void

- (void)reset;

Remarks

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

Error Event (NetClock Module)

Fired when information is available about errors during data delivery.

Syntax

• Swift
• Objective-C

func onError(errorCode: Int32, description: String)

- (void)onError:(int)errorCode :(NSString*)description;

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class .

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

UDP Config Settings

Socket Config Settings

Base Config Settings

Trappable Errors (NetClock Module)

NetClock Errors

UDP Errors

SSL Errors

TCP/IP Errors