nn::nex::StreamSettings::SetKeepAliveTimeout Member Function

Syntax

qResult SetKeepAliveTimeout(
     qUnsignedInt32 uiKeepAliveTimeout
);

Parameters

Name Description
in uiKeepAliveTimeout The keep-alive timeout value (in milliseconds).

Return Values

Always returns QSUCCESS(Core, Success).

Description

Sets the keep-alive timeout value.

The keep-alive feature is a way for the local station to send packets to other stations to inform them that it is still functioning (that is, still alive). This function is a part of the fault-detection mechanism. For the duration of this keep-alive timeout value, keep-alive packets are sent to stations that are not sending packets. If no packets are received during the duration of time obtained by the GetMaxSilenceTime function, it is assumed that the station is not connected. Call this method before instantiating NetZ or NgsFacade objects.

The default value is 1000 milliseconds.

See Also

GetKeepAliveTimeout, SetMaxSilenceTime, GetMaxSilenceTime

Revision History

2014/04/16
Changed the notation of the QRESULT_SUCCESS return value to QSUCCESS.
2012/03/07
Added details to the description.
2012/01/26
Initial version.

CONFIDENTIAL