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 8.0.0.0 for Windows"> 6<META http-equiv="Content-Style-Type" content="text/css"> 7<title>WMStateCode</title> 8<LINK rel="stylesheet" href="../../css/nitro.css" type="text/css"> 9</head> 10<body> 11<h1 align="left">WMStateCode</h1> 12<h2>Definition</h2> 13<dl> 14 <dd> 15<CODE>#include <nitro/wm.h></CODE><BR> 16 <PRE><CODE>typedef enum WMStateCode 17{ 18 WM_STATECODE_PARENT_START = 0 , 19 WM_STATECODE_BEACON_SENT = 2 , 20 WM_STATECODE_SCAN_START = 3 , 21 WM_STATECODE_PARENT_NOT_FOUND = 4 , 22 WM_STATECODE_PARENT_FOUND = 5 , 23 WM_STATECODE_CONNECT_START = 6 , 24 WM_STATECODE_BEACON_LOST = 8 , 25 WM_STATECODE_CONNECTED = 7 , 26 WM_STATECODE_CHILD_CONNECTED = 7 , 27 WM_STATECODE_DISCONNECTED = 9 , 28 WM_STATECODE_DISCONNECTED_FROM_MYSELF = 26 , 29 WM_STATECODE_MP_START = 10 , 30 WM_STATECODE_MPEND_IND = 11 , 31 WM_STATECODE_MP_IND = 12 , 32 WM_STATECODE_MPACK_IND = 13 , 33 WM_STATECODE_DCF_START = 14 , 34 WM_STATECODE_DCF_IND = 15 , 35 WM_STATECODE_BEACON_RECV = 16 , 36 WM_STATECODE_DISASSOCIATE = 17 , 37 WM_STATECODE_REASSOCIATE = 18 , 38 WM_STATECODE_AUTHENTICATE = 19 , 39 WM_STATECODE_PORT_INIT = 25 , 40 WM_STATECODE_PORT_SEND = 20 , 41 WM_STATECODE_PORT_RECV = 21 , 42 WM_STATECODE_FIFO_ERROR = 22 , 43 WM_STATECODE_INFORMATION = 23 , 44 WM_STATECODE_UNKNOWN = 24 , 45} WMStateCode;</CODE></PRE> 46 </dd> 47</dl><h2>Elements</h2> 48<TABLE border="1" width="100%"> 49 <TBODY> 50 <TR> 51 <TD width="200"><CODE>WM_STATECODE_PARENT_START</CODE></TD> 52 <TD width="800">Generated as a callback for <A href="WM_StartParent.html"><CODE>WM_StartParent</CODE></A>.<br /> 53 Generated when a system begins communications processing as a parent. 54 </TD> 55 </TR> 56 <TR> 57 <TD width="200"><CODE>WM_STATECODE_BEACON_SENT</CODE></TD> 58 <TD width="800">Generated as a callback for <A href="WM_StartParent.html"><CODE>WM_StartParent</CODE></A>.<br /> 59 Generated each time beacon transmission to a child completes.<BR> 60 There is no need for applications to process this notification as long as no special processing using beacons is being performed. 61 </TD> 62 </TR> 63 <TR> 64 <TD width="200"><CODE>WM_STATECODE_SCAN_START</CODE></TD> 65 <TD width="800">The specification of <a href="WM_StartScan.html"><code>WM_StartScan</code></a> has changed; this state code will no longer be generated.</TD> 66 </TR> 67 <TR> 68 <TD width="200"><CODE>WM_STATECODE_PARENT_NOT_FOUND</CODE></TD> 69 <TD width="800">Generated as a callback for <A href="WM_StartScan.html"><CODE>WM_StartScan</CODE></A>.<br /> 70 No parent was found in the specified time as the result of a scan for a parent. 71 </TD> 72 </TR> 73 <TR> 74 <TD width="200"><CODE>WM_STATECODE_PARENT_FOUND</CODE></TD> 75 <TD width="800">Generated as a callback for <A href="WM_StartScan.html"><CODE>WM_StartScan</CODE></A>.<br /> 76 One or more parents was found as the result of a scan for a parent. 77 </TD> 78 </TR> 79 <TR> 80 <TD width="200"><CODE>WM_STATECODE_CONNECT_START</CODE></TD> 81 <TD width="800">Generated as a callback for <A href="WM_StartConnect.html"><CODE>WM_StartConnect</CODE></A>.<br /> 82 Generated when a system begins connection processing as a child. 83 </TD> 84 </TR> 85 <TR> 86 <TD width="200"><CODE>WM_STATECODE_BEACON_LOST</CODE></TD> 87 <TD width="800">Generated as a callback for <A href="WM_StartConnect.html"><CODE>WM_StartConnect</CODE></A>.<br /> 88 Generated when the beacon, transmitted periodically by the parent to synchronize communication, could not be received in a fixed period of time.<BR> 89 There is normally no need for the application to process this notification. 90 </TD> 91 </TR> 92 <TR> 93 <TD width="200"><CODE>WM_STATECODE_CONNECTED</CODE></TD> 94 <TD width="800">Generated as a callback for <a href="WM_StartParent.html"><code>WM_StartParent</code></a> or <a href="WM_StartConnect.html"><code>WM_StartConnect</code></a>.<br /> 95 Generated when the connection with the target is established. For a parent, it is generated each time children send connection requests. 96 </TD> 97 </TR> 98 <TR> 99 <TD width="200"><CODE>WM_STATECODE_CHILD_CONNECTED</CODE></TD> 100 <TD width="800">Integrated into <code>WM_STATECODE_CONNECTED</code>. 101 </TD> 102 </TR> 103 <TR> 104 <TD width="200"><CODE>WM_STATECODE_DISCONNECTED</CODE></TD> 105 <TD width="800">Generated as a callback for <a href="WM_StartParent.html"><code>WM_StartParent</code></a> or <a href="WM_StartConnect.html"><code>WM_StartConnect</code></a>.<br /> 106 Generated when a communications party disconnects. 107 </TD> 108 </TR> 109 <TR> 110 <TD width="200"><CODE>WM_STATECODE_DISCONNECTED_FROM_MYSELF</CODE></TD> 111 <TD width="800">Generated as a callback for <a href="WM_StartParent.html"><code>WM_StartParent</code></a> or <a href="WM_StartConnect.html"><code>WM_StartConnect</code></a>.<br /> 112 Generated when the local host disconnects its connection with a communication partner. 113 </TD> 114 </TR> 115 <TR> 116 <TD width="200"><CODE>WM_STATECODE_MP_START</CODE></TD> 117 <TD width="800">Generated as a callback for <A href="WM_StartMP.html"><CODE>WM_StartMP</CODE></A>.<br /> 118 Generated when MP communications begins. 119 </TD> 120 </TR> 121 <TR> 122 <TD width="200"><CODE>WM_STATECODE_MPEND_IND</CODE></TD> 123 <TD width="800">Generated as a callback for <A href="WM_StartMP.html"><CODE>WM_StartMP</CODE></A>.<br /> 124 Generated each time an MP sequence has completed.<BR> 125 Only generated when communicating as a parent.<BR> 126 There is normally no need for the application to process this notification. 127 </TD> 128 </TR> 129 <TR> 130 <TD width="200"><CODE>WM_STATECODE_MP_IND</CODE></TD> 131 <TD width="800">Generated as a callback for <A href="WM_StartMP.html"><CODE>WM_StartMP</CODE></A>.<br /> 132 Generated in the first half of an MP sequence.<BR> 133 Only generated when communicating as a child.<BR> 134 There is normally no need for the application to process this notification. 135 </TD> 136 </TR> 137 <TR> 138 <TD width="200"><CODE>WM_STATECODE_MPACK_IND</CODE></TD> 139 <TD width="800">Generated as a callback for <A href="WM_StartMP.html"><CODE>WM_StartMP</CODE></A>.<br /> 140 Generated each time an MP sequence has completed.<BR> 141 There is normally no need for the application to process this notification. 142 </TD> 143 </TR> 144 <TR> 145 <TD width="200"><CODE>WM_STATECODE_DCF_START</CODE></TD> 146 <TD width="800">Generated as a callback for <A href="WM_StartDCF.html"><CODE>WM_StartDCF</CODE></A>.<br /> 147 Generated when DCF communications begins. 148 </TD> 149 </TR> 150 <TR> 151 <TD width="200"><CODE>WM_STATECODE_DCF_IND</CODE></TD> 152 <TD width="800">Generated as a callback for <A href="WM_StartDCF.html"><CODE>WM_StartDCF</CODE></A>.<br /> 153 Generated each time DCF communications receives data. 154 </TD> 155 </TR> 156 <TR> 157 <TD width="200"><CODE>WM_STATECODE_BEACON_RECV</CODE></TD> 158 <TD width="800">Generated as the callback specified by <A href="WM_SetIndCallback.html"><CODE>WM_SetIndCallback</CODE></A>.<br /> 159 Generated each time a system receives a beacon as a child.<BR> 160 There is no need for applications to process this notification as long as no special processing using beacons is being performed. 161 </TD> 162 </TR> 163 <TR> 164 <TD width="200"><CODE>WM_STATECODE_DISASSOCIATE</CODE></TD> 165 <TD width="800">Generated as the callback specified by <A href="WM_SetIndCallback.html"><CODE>WM_SetIndCallback</CODE></A>.<br /> 166 Generated as a mid-term report on a disconnect process.<BR> 167 There is normally no need for the application to process this notification. 168 </TD> 169 </TR> 170 <TR> 171 <TD width="200"><CODE>WM_STATECODE_REASSOCIATE</CODE></TD> 172 <TD width="800">Generated as the callback specified by <A href="WM_SetIndCallback.html"><CODE>WM_SetIndCallback</CODE></A>.<br /> 173 Generated when a child that has once been disconnected is reconnected.<BR> 174 There is normally no need for the application to process this notification. 175 </TD> 176 </TR> 177 <TR> 178 <TD width="200"><CODE>WM_STATECODE_AUTHENTICATE</CODE></TD> 179 <TD width="800">Generated as the callback specified by <A href="WM_SetIndCallback.html"><CODE>WM_SetIndCallback</CODE></A>.<br /> 180 Generated as a midterm report on a connect process.<BR> 181 There is normally no need for the application to process this notification. 182 </TD> 183 </TR> 184 <TR> 185 <TD width="200"><CODE>WM_STATECODE_PORT_INIT</CODE></TD> 186 <TD width="800">Generated when port initialization has completed.</TD> 187 </TR> 188 <TR> 189 <TD width="200"><CODE>WM_STATECODE_PORT_SEND</CODE></TD> 190 <TD width="800">Generated as a callback when the data transmission to the port has completed.</TD> 191 </TR> 192 <TR> 193 <TD width="200"><CODE>WM_STATECODE_PORT_RECV</CODE></TD> 194 <TD width="800">Generated as a callback specified with <a href="WM_SetPortCallback.html"><code>WM_SetPortCallback</code></a>. 195 Generated when receiving the data to be sent to the port and when detecting the connection or disconnection of a child. 196 </TD> 197 </TR> 198 <TR> 199 <TD width="200"><CODE>WM_STATECODE_FIFO_ERROR</CODE></TD> 200 <TD width="800">Generated when automatic processing generated by the ARM7 could not be recorded in the queue.</TD> 201 </TR> 202 <TR> 203 <TD width="200"><CODE>WM_STATECODE_INFORMATION</CODE></TD> 204 <TD width="800">Generated to provide information when events occur internally.<BR> 205 There is normally no need for the application to process this notification.</TD> 206 </TR> 207 <TR> 208 <TD width="200"><CODE>WM_STATECODE_UNKNOWN</CODE></TD> 209 <TD width="800">Generated when some unspecified event occurs internally.</TD> 210 </TR> 211 </TBODY> 212</TABLE> 213<H2>Description</H2> 214<P> 215This enumerated type indicates the callback type that is used jointly as the <CODE>state</CODE> member of each structure that is passed to a WM asynchronous function's callback function. 216</P> 217<H2>Revision History</H2> 218<P> 2192007/11/13 Added description that notifications when processing by the application is not normally required.<BR> 2005/10/31 Added <CODE>WM_STATECODE_DISCONNECTED_FROM_MYSELF</CODE>, <CODE>WM_STATECODE_PORT_INIT</CODE>, and <CODE>WM_STATECODE_UNKNOWN</CODE>.<BR> 2005/07/29 Added <CODE>WM_STATECODE_INFORMATION</CODE>.<BR> 2004/11/02 Fixed omissions relating to the integration of past revisions.<BR> 2004/09/13 Integrated <CODE>WM_STATECODE_CHILD_CONNECTED</CODE> into <CODE>WM_STATECODE_CONNECTED</CODE>.<BR> 2004/08/20 Revised because of specification changes of the scan functions.<BR> 2004/08/11 Added description on the addition of WM specifications.<BR> 2004/07/29 Initial version.<BR> 220</P> 221<hr><p>CONFIDENTIAL</p></body> 222</html> 223