Ping.NewCreate a new ping object.
Syntax
Ping.New("target_host")
Arguments
target_host : The hostname to ping.
Example
ping_object = Ping.New("www.qsc.com")
startBegin the ping session.
Syntax
start(single_shot)
Arguments
single_shot : Bool. Set to true if you want only a single ping attempt.
Example
ping_object:start(false)
stopStop the ping session.
Syntax
stop()
Example
ping_object:stop()
setTimeoutIntervalSet the timeout for waiting for a ping response.
Syntax
setTimeoutInterval(interval)
Arguments
interval : Double. The timeout duration, in seconds.
Example
ping_object:setTimeoutInterval(10.0)
setPingIntervalSet the interval for retrying after a ping request.
Syntax
setPingInterval(interval)
Arguments
interval : Double. The interval duration, in seconds.
Example
ping_object:setPingInterval(10.0)
EventHandlerAssign a Lua callback for successful ping events.
Responses
ElapsedTime : Long. The amount of time for the ping to occur, in microseconds.
HostName : String. The hostname that was pinged.
Example
ping_object.EventHandler = function(response) print(response.HostName) print(response.ElapsedTime) end
ErrorHandlerAssign a Lua callback for unsuccessful ping events.
Responses
Error : String. The description of the error.
HostName : String. The hostname that was pinged.
Example
ping_object.ErrorHandler = function(response) print(response.HostName) print(response.Error) end
