DWC_SetSendSplitMax

C Specification

#include <dwc.h>

BOOL DWC_SetSendSplitMax( u16 sendSplitMax );

Description

Sets the maximum data size that can be sent to the connected host at one time. When using Reliable send with the DWC_SendReliable or DWC_SendReliableBitmap functions to send data larger than this size, the send data is split and any data that cannot be sent completely is saved as is. As soon as space is available in the send buffer for which the size was specified with the DWC_InitFriendsMatch function, the data is sent from within the DWC_ProcessFriendsMatch function.

When using Unreliable send with the DWC_SendUnreliable or DWC_SendUnreliableBitmap functions to send data larger than this size, the data cannot be sent and FALSE is returned.

The default maximum send size is 1465 Bytes (as defined by DWC_TRANSPORT_SEND_MAX).
Do not exceed this size in settings, as it was determined to support the settings of various communications devices.

When the Reliable send/receive buffer size is set smaller with the DWC_InitFriendsMatch function, you can use this function to adjust the maximum send data size to prevent buffer overflow.

Arguments

sendSplitMax Maximum data size that can be sent in one data send.

Return Values

TRUE Configuration was a success.
FALSE The configuration failed, because the FriendsMatch Library was not running.

See Also

DWC_InitFriendsMatch, DWC_SendReliable, DWC_SendReliableBitmap, DWC_SendUnreliable, DWC_SendUnreliableBitmap

Revision History

02/21/2006 Added note on the DWC_TRANSPORT_SEND_MAX constant
01/18/2006 Support for change to Boolean return value
12/16/2005 Added explanation regarding maximum size of divisions
11/02/2005 Initial version