MB_SetParentCommParam


C Specification

#include <nitro/mb.h>

BOOL MB_SetParentCommParam( 
    u16     sendSize, 
    u16     maxChildren );
    

Description

Specifies the size of the MB library's send for internally-driven communications, including the maximum number of children. This function can be used to increase the efficiency of the MP communication packets when you already know the maximum number of connected devices.

This function can be called only after calling the MB_Init function and before calling the MB_StartParent function.

This function is the same as the MB_SetParentCommSize function except it also includes and specifies the maximum number of connected children. Note that this function cannot set the parent receive size.

Arguments

sendSize send buffer size in MB parent MP communication
This size must be greater than MB_COMM_PARENT_SEND_MIN and less than MB_COMM_PARENT_SEND_MAX.
maxChildren The maximum number of children the MB receives
Fails when you set the MB_RegisterFile function to receive more children than this number and call it.
The maxPlayerNum of MBGameRegistry is the number of devices, including the parent. Therefore, the value of MBGameRegistry is smaller by one when setting the same number of devices.

Return Values

Returns TRUE if the value is set in the correct range. Otherwise returns FALSE.

See Also

MB_COMM_PARENT_*, MBUserInfo, MB_Init, MB_SetParentCommSize, MB_StartParent, MB_RegisterFile, MBGameRegistry

Revision History

11/18/2004 Discontinue recvSize argument.
10/18/2004 Fixed several links.
10/05/2004 Initial version.