DWC_SetConnectionKeepAliveTime

Syntax

#include <dwc.h>
BOOL DWC_SetConnectionKeepAliveTime(u32 time);

Arguments

time The duration of the receive timeout (in milliseconds) to set. Cannot specify 0.

Return Values

TRUE The timeout was set successfully.
FALSE Setting failed because the FriendsMatch library is not in operation, or else time was set to 0.

Description

Sets the timeout, which is the standard for determining when to disconnect from a connected peer after a fixed period of time elapses with no reliable or unreliable transmission from that peer.

If this function is not called, 20,000 ms is used as the default value.

Because the DWC library does not automatically, internally perform the communication required to maintain connections, applications must perform some kind of reliable/unreliable transmission with all connected hosts within an interval shorter than the timeout set by this function.

If data has not been received and the time set using this function has passed, connection with the other host is automatically disconnected inside the DWC library, and DWCConnectionClosedCallback is called.

Revision History

For the changelog prior to 5.1 PR2, click here.


CONFIDENTIAL