Ping Module

Properties   Methods   Events   Config Settings   Errors  

The PING module encapsulates Internet Control Message Protocol (ICMP) ECHO functionality, which is used to check whether there is a communications link between two computers.

Syntax

IPWorks.Ping

Remarks

When the PingHost method is called with the Host parameter, or if RemoteHost is assigned an IP address or domain name, the class sends an ICMP ECHO packet to the remote host. The ResponseTime and ResponseSource properties are updated with the time of the roundtrip to the remote host and the address of the host actually sending the response.

The class operates synchronously by default (i.e., waits for a response before returning control to the caller); however, the class may also operate asynchronously (i.e., returns control immediately) by setting Timeout to 0. Please refer to the Timeout property for more information.

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.

Active Property (Ping Module)

This property indicates whether the module is active.

Syntax

• Swift
• Objective-C

public var active: Bool {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=active,setter=setActive:) BOOL active;

- (BOOL)active;
- (void)setActive :(BOOL)newActive;

Default Value

False

Remarks

This property indicates whether the class is currently active and can send or receive data.

The PingHost method will automatically change the value of this property to True.

Note: Use the Activate or Deactivate method to control whether the class is active.

Idle Property (Ping 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

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

This property is read-only.

LocalHost Property (Ping 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

The LocalHost 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 multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

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

PacketSize Property (Ping Module)

This property includes the size of the packet to send as the ping request.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=packetSize,setter=setPacketSize:) int packetSize;

- (int)packetSize;
- (void)setPacketSize :(int)newPacketSize;

Default Value

64

Remarks

This property allows you to control the size of the data packet sent in the PingHost method. The default packet size is 64 bytes, with a minimum of 8 bytes (4 bytes of the ICMP header plus the ECHO identifier). The maximum value is 65520.

RemoteHost Property (Ping Module)

This property includes the address of the RemoteHost. Domain names are resolved to IP addresses.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=remoteHost,setter=setRemoteHost:) NSString* remoteHost;

- (NSString*)remoteHost;
- (void)setRemoteHost :(NSString*)newRemoteHost;

Default Value

""

Remarks

This property specifies the IP address (IP number in dotted internet format) or the domain name of the remote host.

If this property is set to 255.255.255.255, the class broadcasts data on the local subnet.

If this property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the property is set to the corresponding address. If the search is not successful, the class .

If UseConnection is True, this property must be set before the class is activated (Active is set to True).

RequestId Property (Ping Module)

This property includes a unique identifier for outgoing packets.

Syntax

• Swift
• Objective-C

public var requestId: Int32 {
  get {...}
}

@property (nonatomic,readonly,assign,getter=requestId) int requestId;

- (int)requestId;

Default Value

0

Remarks

This property contains a unique identifier for outgoing packets. This property is useful during asynchronous ping operations. The RequestId parameter of the Response event is used to match requests with responses.

The identifier of the outgoing ping packet is provided in this property after the PingHost method returns.

This property is read-only.

ResponseSource Property (Ping Module)

This property includes the source of the last PING response.

Syntax

• Swift
• Objective-C

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

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

- (NSString*)responseSource;

Default Value

""

Remarks

This property contains the address of the host responding to the PING (ICMP ECHO) request. This may or may not be the host used in PingHost.

This property is read-only.

ResponseStatus Property (Ping Module)

This property includes the status of the last PING response.

Syntax

• Swift
• Objective-C

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

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

- (NSString*)responseStatus;

Default Value

""

Remarks

This property contains the status of the last response. After PingHost has returned, this property will be populated with the status of the response. For responses without error, the value will be OK. In the case of an error, the value will hold a description of the error, such as Network Unreachable or Host Unreachable.

This property is read-only.

ResponseTime Property (Ping Module)

This property includes the time elapsed between sending the original packet and the remote host reply.

Syntax

• Swift
• Objective-C

public var responseTime: Int32 {
  get {...}
}

@property (nonatomic,readonly,assign,getter=responseTime) int responseTime;

- (int)responseTime;

Default Value

0

Remarks

This property contains the time elapsed between sending the original packet and the remote host reply. The time value is expressed in milliseconds. The lowest resolution available depends on the resolution of the clock on the host system (normally between 10 ms and 20 ms).

This property is read-only.

Timeout Property (Ping Module)

A 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 return immediately, potentially failing with a WOULDBLOCK error if data cannot be sent immediately.

If Timeout is set to a positive value, data is sent in a blocking manner and the class will wait for the operation to complete before returning control. The class will handle any potential WOULDBLOCK errors internally and automatically retry the operation for a maximum of Timeout seconds.

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 .

Please note that by default, all timeouts are inactivity timeouts, i.e. 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.

TimeToLive Property (Ping Module)

This property includes the time-to-live (TTL) value for the ICMP packets sent by the module.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=timeToLive,setter=setTimeToLive:) int timeToLive;

- (int)timeToLive;
- (void)setTimeToLive :(int)newTimeToLive;

Default Value

0

Remarks

This method contains the time-to-live (TTL) value for the ICMP packets sent by the class. The TTL field of the ICMP packet is a counter limiting the lifetime of a packet.

Each router (or other module) that handles a packet decrements the TTL field by one or more if it holds the packet for more than one second. Thus, the TTL value is effectively a hop count limit on how far a datagram can propagate through the internet. When the TTL value is reduced to zero (or less), the packet is discarded.

If the value of the property is set to zero, then the default TTL value of the underlying Transmission Control Protocol (TCP)/IP subsystem will be used.

TypeOfService Property (Ping Module)

This property includes the type of ICMP message sent as a ping request.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=typeOfService,setter=setTypeOfService:) int typeOfService;

- (int)typeOfService;
- (void)setTypeOfService :(int)newTypeOfService;

Default Value

8

Remarks

This property contains the type of the ICMP message sent as a ping request. The default value is 8 (ECHO REQUEST).

Activate Method (Ping Module)

This method enables sending and receiving data.

Syntax

• Swift
• Objective-C

public func activate() throws -> Void

- (void)activate;

Remarks

This method enables sending and receiving of data.

Note: Calling the PingHost method will automatically activate the class.

Config Method (Ping 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.

Deactivate Method (Ping Module)

This method disables sending and receiving data.

Syntax

• Swift
• Objective-C

public func deactivate() throws -> Void

- (void)deactivate;

Remarks

This method disables sending and receiving data.

DoEvents Method (Ping Module)

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.

Interrupt Method (Ping Module)

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

PingHost Method (Ping Module)

This method pings a host.

Syntax

• Swift
• Objective-C

public func pingHost(host: String) throws -> Void

- (void)pingHost:(NSString*)host;

Remarks

This method will ping a host. A valid internet domain name or address must be specified in Host, or an error will be returned.

A PING request (ICMP ECHO) is sent to the Host.

Example. Ping a Host:

PingControl.PingHost("MyHostName") ResponseTime = PingControl.ResponseTime

Reset Method (Ping Module)

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

ResolveRemoteHost Method (Ping Module)

Resolves the hostname in RemoteHost to an IP address.

Syntax

• Swift
• Objective-C

public func resolveRemoteHost() throws -> Void

- (void)resolveRemoteHost;

Remarks

This method resolves the hostname specified by RemoteHost to an IP address. The resolved value is available in the RemoteHost property after this method returns.

In most cases calling this method is not necessary, the class will resolve the hostname automatically when necessary. If DelayHostResolution is this method may be called to manually resolve RemoteHost if desired.

WakeOnLAN Method (Ping Module)

This method sends a Wake-On-LAN packet.

Syntax

• Swift
• Objective-C

public func wakeOnLAN(remoteHost: String, macAddress: String) throws -> Void

- (void)wakeOnLAN:(NSString*)remoteHost :(NSString*)MACAddress;

Remarks

When this method is called, a Wake-On-LAN packet is sent to RemoteHost (which may also be a broadcast address). This has the effect of powering on the machine (if such functionality is supported by the network card on the remote machine).

The physical address of the remote host must be supplied in the MACAddress parameter.

Error Event (Ping 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.

Response Event (Ping Module)

This event is fired when a response packet is received.

Syntax

• Swift
• Objective-C

func onResponse(requestId: Int32, responseSource: String, responseStatus: String, responseTime: Int32)

- (void)onResponse:(int)requestId :(NSString*)responseSource :(NSString*)responseStatus :(int)responseTime;

Remarks

The RequestId parameter is used along with the RequestId property to match requests with responses.

ResponseStatus is set to OK for normal operation, or it contains an error string, such as Network unreachable or Host unreachable.

Config Settings (Ping Module)

Ping Config Settings

ICMP Config Settings

Socket Config Settings

Base Config Settings

Trappable Errors (Ping Module)

Ping Errors

ICMP Errors

SSL Errors

TCP/IP Errors