WM_SetMPDataToPortEx

C Specification

#include <nitro/wm.h>

WMErrCode WM_SetMPDataToPortEx(
WMCallbackFunc  callback ,
void*      arg ,
const u16*      sendData,
u16             sendDataSize ,
u16             destBitmap ,
u16             port ,
u16             prio
);

Arguments

callback Designates the callback function to call when the asynchronous process completes. This callback is called from within the interrupt handler.
arg User definition data to be passed to the callback function.
sendData Pointer to the data to be send-reserved. Notice that this data entity will be forcibly cached.
sendDataSize The size of the send-reserved data.
destBitmap Bitmap that indicates the AID of the send destination child. (enabled only for the parent).
port The port number that sends data. Use a value from 0-15.
prio Data send priority. Use a value from 0 (highest) through 3 (lowest).

Return Values

Returns the results of the WMErrCode enumerated type process.

Description

Sets the data to be sent to the port that is specified by the MP. This function is only executable when the WM is in either the MP PARENT or MP CHILD state. If the return value is WM_ERRCODE_OPERATING, a callback is generated after the MP completes the data transmission process. Do not rewrite the buffer identified by sendData until the callback is called. Unlike the asynchronous functions of other wireless APIs, processing continues normally even if different function pointers are specified for callbacks when this API is called repeatedly without waiting for callbacks. However, you can call this function a maximum of 10 consecutive times without waiting for a callback; If this function is called more than 10 consecutive times, the API returns an error. The user definition data that is specified by arg is passed to the callback identified by arg in WMPortSendCallback structure.

See Also

WM_StartMP, WM_EndMP, WM_SetMPDataToPort, WM_SetPortCallback, WMPort

Revision History

07/08/2005 Added a description of the maximum number of times in a row that this function can be called asynchronously.
06/08/2005 Added statement about callbacks being called from the interrupt handler.
03/02/2004 Added a description of the specifiable range for the argument port.
10/22/2004 Changed return value type.
09/25/2004 Added to and revised Description.
09/09/2004 Initial version.