WireWare native: WireWare PingMachine
From FactorityWiki
Contents |
Summary
Notifies the machine or device, that the client is still alive.
WIREWARE_RESULT WireWare_PingMachine (
| WIREWARE_MACHINE_HANDLE | handle | // handle for machine | |
| PWIREWARE_TIMEOUT | delay | // pointer to memory location for ping time | |
| WIREWARE_TIMEOUT | timeout | // timeout in ms |
);
Parameters
| handle |
Specifies the handle for the connection to the machine or device.
|
| delay |
Points to a memory location, which receives the time until the machine's or devices answer to the ping request arrived.
This parameter can be a NULL pointer. In this case no time is returned.
|
| timeout |
Specifies the maximum allowed execution time (in ms) for this function.
|
Result
If the function succeeds, the return value is WIREWARE_ERROR_NONE. Otherwise it returns an appropriate error code.
If the function returns WIREWARE_ERROR_HANDLE_MEANINGLESS, the connection dropped and has to be closed.
Explanation
This function tests, if the connection to the machine or device is still alive.
Beside of this, it tells the machine or device, that the client is still there. This function has to be called at least once per 30 sec., otherwise the machine or device would close the connection, thinking, that the network connection between client and machine dropped.
