nn::nex::StreamSettings::SetMaxSilenceTime Member Function

Syntax

qResult SetMaxSilenceTime(
     qUnsignedInt32 uiMaxSilenceTime
);

Parameters

Name Description
in uiMaxSilenceTime The maximum amount of silence time. The unit is milliseconds.

Return Values

Always returns QSUCCESS(Core, Success).

Description

Sets a maximum value for the silence time.

If a packet expected from a station does not arrive and the maximum silence time has been exceeded, it is assumed that the station is no longer connected. Normally, once the last packet is sent, keep-alive packets are sent for the duration of time obtained with the GetKeepAliveTimeout function.

You can increase tolerance in poor-quality network environments by setting large values for the maximum number of retransmissions in addition to the maximum silence time. Conversely, by setting small values you can detect faults sooner.

The default value is 10,000 milliseconds.

Call this method before instantiating NetZ or NgsFacade objects.

See Also

GetMaxSilenceTime , SetMaxRetransmission , GetKeepAliveTimeout

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