1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> 2<html> 3<head> 4<META http-equiv="Content-Type" content="text/html; charset=windows-1252"> 5<META name="GENERATOR" content="IBM WebSphere Studio Homepage Builder Version 7.0.0.0 for Windows"> 6<META http-equiv="Content-Style-Type" content="text/css"> 7<title>MBCommPState</title> 8<LINK rel="stylesheet" href="../css/nitro.css" type="text/css"> 9</head> 10<body> 11<h1 align="left">MBCommPState <IMG src="../image/NTR.gif" width="24" height="12" border="0" align=middle><IMG src="../image/TWL.gif" width="24" height="12" border="0" align=middle></h1> 12<h2>Definition</h2> 13<dl> 14 <dd> 15<CODE>#include <nitro/mb.h></CODE> 16<PRE><CODE> 17typedef enum 18{ 19 MB_COMM_PSTATE_NONE, 20 MB_COMM_PSTATE_INIT_COMPLETE, 21 MB_COMM_PSTATE_CONNECTED, 22 MB_COMM_PSTATE_DISCONNECTED, 23 MB_COMM_PSTATE_KICKED, 24 MB_COMM_PSTATE_REQ_ACCEPTED, 25 MB_COMM_PSTATE_SEND_PROCEED, 26 MB_COMM_PSTATE_SEND_COMPLETE, 27 MB_COMM_PSTATE_BOOT_REQUEST, 28 MB_COMM_PSTATE_BOOT_STARTABLE, 29 MB_COMM_PSTATE_REQUESTED, 30 MB_COMM_PSTATE_MEMBER_FULL, 31 MB_COMM_PSTATE_END, 32 MB_COMM_PSTATE_ERROR, 33 MB_COMM_PSTATE_WAIT_TO_SEND, 34 35 MB_COMM_PSTATE_WM_EVENT = 0x80000000 36} MBCommPState; 37</CODE></PRE> 38 </dd> 39</dl> 40<H2>Description</H2> 41<P>Indicates the enumerator constant showing the state of the multi-boot parent. The meaning of each enumerator constant is shown in the following table: 42<TABLE border="0"> 43 <TBODY> 44 <TR> 45 <TD>Constant</TD> 46 <TD>Description</TD> 47 </TR> 48 <TR> 49 <TD><B><I>MB_COMM_PSTATE_NONE</B></I></TD> 50 <TD>Indicates the parent idle state. 51 </TD> 52 </TR> 53 <TR> 54 <TD><B><I>MB_COMM_PSTATE_INIT_COMPLETE</B></I></TD> 55 <TD>Indicates the completion callback for the <CODE><A href="./parent/MB_StartParent.html">MB_StartParent</A></CODE> function.<br>The <CODE><a href="../wm/wm/WMCallback.html">WMCallback</a></CODE>-type pointer passed as the completion callback argument to the <CODE><a href="../wm/wm/WM_SetParentParameter.html">WM_SetParentParameter</a></CODE> function will also be passed as the <CODE>arg</CODE> argument to the <CODE><A href="parent/MB_CommSetParentStateCallback.html">MB_CommSetParentStateCallback</A></CODE> function's callback.<br>This is not a callback for the status of a specific child, so zero is passed to the <CODE>child_aid</CODE> argument. 56 </TD> 57 </TR> 58 <TR> 59 <TD><B><I>MB_COMM_PSTATE_CONNECTED</B></I></TD> 60 <TD>Indicates the state immediately following connection from a child. The <CODE><a href="../wm/wm/WMStartParentCallback.html">WMStartParentCallback</a></CODE>-type pointer for the <CODE>WM_STATECODE_CHILD_CONNECTED</CODE> state will be passed as the <CODE>arg</CODE> argument to the <CODE><A href="parent/MB_CommSetParentStateCallback.html">MB_CommSetParentStateCallback</A></CODE> function's callback.<br>The number of the target child is passed to the <CODE>child_aid</CODE> argument. 61 </TD> 62 </TR> 63 <TR> 64 <TD><B><I>MB_COMM_PSTATE_DISCONNECTED</B></I></TD> 65 <TD>Indicates the status immediately after disconnection of a child. The <CODE><a href="../wm/wm/WMStartParentCallback.html">WMStartParentCallback</a></CODE>-type pointer for the <CODE>WM_STATECODE_DISCONNECTED</CODE> state will be passed as the <CODE>arg</CODE> argument to the <CODE><A href="parent/MB_CommSetParentStateCallback.html">MB_CommSetParentStateCallback</A></CODE> function's callback.<br>The number of the target child is passed to the <CODE>child_aid</CODE> argument. 66 </TD> 67 </TR> 68 <TR> 69 <TD><B><I>MB_COMM_PSTATE_KICKED</B></I></TD> 70 <TD>Indicates the status immediately after the completion of the connection rejection response to a child. <code>NULL</code> will be passed as the <CODE>arg</CODE> argument to the <CODE><A href="parent/MB_CommSetParentStateCallback.html">MB_CommSetParentStateCallback</A></CODE> function's callback.<br> The number of the target child is passed to the <CODE>child_aid</CODE> argument. 71 </TD> 72 </TR> 73 <TR> 74 <TD><B><I>MB_COMM_PSTATE_REQ_ACCEPTED</B></I></TD> 75 <TD>Indicates the state immediately after the connection request to a child has completed. <code>NULL</code> will be passed as the <CODE>arg</CODE> argument to the <CODE><A href="parent/MB_CommSetParentStateCallback.html">MB_CommSetParentStateCallback</A></CODE> function's callback.<br> The number of the target child is passed to the <CODE>child_aid</CODE> argument. 76 </TD> 77 </TR> 78 <TR> 79 <TD><B><I>MB_COMM_PSTATE_WAIT_TO_SEND</B></I></TD> 80 <TD>Indicates that a child has entered the download standby state.<br /><code>NULL</code> will be passed as the <CODE>arg</CODE> argument to the <CODE><A href="parent/MB_CommSetParentStateCallback.html">MB_CommSetParentStateCallback</A></CODE> function's callback.<br> The number of the target child is passed to the <CODE>child_aid</CODE> argument. 81 </TD> 82 </TR> 83 <TR> 84 <TD><B><I>MB_COMM_PSTATE_SEND_PROCEED</B></I></TD> 85 <TD>Indicates the state in which the download to a child is proceeding normally. <code>NULL</code> will be passed as the <CODE>arg</CODE> argument to the <CODE><A href="parent/MB_CommSetParentStateCallback.html">MB_CommSetParentStateCallback</A></CODE> function's callback.<br>Callback is called only once when the download started. The number of the target child is passed to the <CODE>child_aid</CODE> argument. 86 </TD> 87 </TR> 88 <TR> 89 <TD><B><I>MB_COMM_PSTATE_SEND_COMPLETE</B></I></TD> 90 <TD>Indicates the state immediately after the download to a child had completed. <code>NULL</code> will be passed as the <CODE>arg</CODE> argument to the <CODE><A href="parent/MB_CommSetParentStateCallback.html">MB_CommSetParentStateCallback</A></CODE> function's callback.<br> The number of the target child is passed to the <CODE>child_aid</CODE> argument. 91 </TD> 92 </TR> 93 <TR> 94 <TD><B><I>MB_COMM_PSTATE_BOOT_REQUEST</B></I></TD> 95 <TD>Indicates the state where the boot request is being sent to a child. A transition to this state will occur when the <CODE><A href="parent/MB_CommBootRequest.html">MB_CommBootRequest</A></CODE> or <CODE><A href="parent/MB_CommBootRequestAll.html">MB_CommBootRequestAll</A></CODE> function is called.<br> The number of the target child is passed to the <CODE>child_aid</CODE> argument. 96 </TD> 97 </TR> 98 <TR> 99 <TD><B><I>MB_COMM_PSTATE_BOOT_STARTABLE</B></I></TD> 100 <TD>Indicates the state where immediately after the boot request to a child has completed properly. <code>NULL</code> will be passed as the <CODE>arg</CODE> argument to the <CODE><A href="parent/MB_CommSetParentStateCallback.html">MB_CommSetParentStateCallback</A></CODE> function's callback.<br> The number of the target child is passed to the <CODE>child_aid</CODE> argument. 101 </TD> 102 </TR> 103 <TR> 104 <TD><B><I>MB_COMM_PSTATE_REQUESTED</B></I></TD> 105 <TD>Indicates the state that is immediately after receiving the download request from a child. A pointer to the <CODE><a href="mb_user_info_type.html">MBUserInfo</a></CODE> that stores the child device's user data will be passed as the <CODE>arg</CODE> argument to the <CODE><A href="parent/MB_CommSetParentStateCallback.html">MB_CommSetParentStateCallback</A></CODE> function's callback.<br> The number of the target child is passed to the <CODE>child_aid</CODE> argument. 106 </TD> 107 </TR> 108 <TR> 109 <TD><B><I>MB_COMM_PSTATE_MEMBER_FULL</B></I></TD> 110 <TD>Indicates the state immediately after the download process from a child was forcibly cancelled because it has reached the maximum number of people. <code>NULL</code> will be passed as the <CODE>arg</CODE> argument to the <CODE><A href="parent/MB_CommSetParentStateCallback.html">MB_CommSetParentStateCallback</A></CODE> function's callback.<br> The number of the target child is passed to the <CODE>child_aid</CODE> argument. 111 </TD> 112 </TR> 113 <TR> 114 <TD><B><I>MB_COMM_PSTATE_END</B></I></TD> 115 <TD>Indicates the completion callback for the <CODE><A href="./common/MB_End.html">MB_End</A></CODE> function.<br> <code>NULL</code> is passed as the <CODE>arg</CODE> argument to the <CODE><A href="parent/MB_CommSetParentStateCallback.html">MB_CommSetParentStateCallback</A></CODE> function's callback.<br>This is not a callback for the status of a specific child, so zero is passed to the <CODE>child_aid</CODE> argument. 116 </TD> 117 </TR> 118 <TR> 119 <TD><B><I>MB_COMM_PSTATE_ERROR</B></I></TD> 120 <TD>Indicates the callback that notifies the various errors that were generated in the MP library. A pointer to the <CODE><a href="mb_error_status_type.html">MBErrorStatus</a></CODE> that stores the cause of the error will be passed as the <CODE>arg</CODE> argument to the <CODE><A href="parent/MB_CommSetParentStateCallback.html">MB_CommSetParentStateCallback</A></CODE> function's callback.<br> 121 </TD> 122 </TR> 123 <TR> 124 <TD><font color="#808080">MB_COMM_PSTATE_WM_EVENT</font></TD> 125 <TD><font color="#808080">Used internally in the library.</font> 126 </TD> 127 </TR> 128 </TBODY> 129</TABLE> 130<BR> 131</P> 132<h2>See Also</h2> 133<p><code><a href="parent/MB_CommSetParentStateCallback.html">MB_CommSetParentStateCallback</a></code><BR> <code><a href="parent/MB_CommGetParentState.html">MB_CommGetParentState</a></code></p> 134<H2>Revision History</H2> 135<P> 1362004/10/05 Added enumerator types. <BR>2004/09/30 Added enumerator types. <BR>2004/09/27 Revised descriptions. <BR>2004/09/10 Added descriptions for the arguments to the <CODE>MB_CommSetParentStateCallback</CODE> function's arguments. <BR>2004/08/09 Initial version.<BR> 137</P> 138<hr><p>CONFIDENTIAL</p></body> 139</html> 140
