1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html>
3
4<head>
5<meta http-equiv="Content-Type" content="text/html; charset=windows-1252">
6<META http-equiv="Content-Style-Type" content="text/css">
7<LINK rel="stylesheet" type="text/css" href="../CSS/revolution.css">
8<title>MPDisconnectReason</title>
9</head>
10
11<body>
12
13<h1>MPDisconnectReason</h1>
14
15<h2>Definitions</h2>
16<dl><dd>
17<pre>
18<code>#include &lt;revolution/mp.h&gt;</code>
19
20enum
21{
22    // the reason value related to an externally-cause disconnection
23    MP_DISCONNECT_REASON_RESERVED                      = 0,
24    MP_DISCONNECT_REASON_UNSPECIFIED                   = 1,
25    MP_DISCONNECT_REASON_PREV_AUTH_INVALID             = 2,
26    MP_DISCONNECT_REASON_DEAUTH_LEAVING                = 3,
27    MP_DISCONNECT_REASON_INACTIVE                      = 4,
28    MP_DISCONNECT_REASON_UNABLE_HANDLE                 = 5,
29    MP_DISCONNECT_REASON_RX_CLASS2_FROM_NONAUTH_STA    = 6,
30    MP_DISCONNECT_REASON_RX_CLASS3_FROM_NONASSOC_STA   = 7,
31    MP_DISCONNECT_REASON_DISASSOC_LEAVING              = 8,
32    MP_DISCONNECT_REASON_ASSOC_STA_NOTAUTHED           = 9,
33
34    // the reason values unique to Wii-DS' local communications
35    MP_DISCONNECT_REASON_NO_ENTRY                      = 19,
36
37    // the reason values related to internal automatic disconnects from the library
38    MP_DISCONNECT_REASON_MP_LIFETIME                   = 0x8001,
39    MP_DISCONNECT_REASON_UPDATE                        = 0xc001,
40    MP_DISCONNECT_REASON_DEPRIVED_AID                  = 0xc002,
41
42    // the reason values related to an explicit disconnection by the library
43    MP_DISCONNECT_REASON_RESET                         = 0xf001,
44    MP_DISCONNECT_REASON_ACTIVE                        = 0xf002
45} MPDisconnectReason;
46</pre>
47</dd></dl>
48
49<H2>Description</H2>
50<p>
51Enumerated type to indicate the reason code for a disconnection.
52</p>
53<p>
54It is possible to determine using the function macro, <code>MP_IS_DISCONNECTED_FROM_MYSELF(reason)</code>, whether an MP library function was actively called for a disconnection.
55</p>
56<TABLE border="1">
57  <TBODY>
58      <tr>
59<th><strong>Member</strong></th>
60<th><strong>Description</strong></th>
61      </tr>
62    <TR>
63<td valign="top" width="120" bgcolor="#ffffe8"><em><strong>MP_DISCONNECT_REASON_RESERVED</strong></em></td>
64<TD width="520">Reserved</TD>
65    </TR>
66    <TR>
67<td valign="top" width="120" bgcolor="#ffffe8"><em><strong>MP_DISCONNECT_REASON_UNSPECIFIED</strong></em></td>
68<TD width="520">Indicates that an unspecified error has occurred.</TD>
69    </TR>
70    <TR>
71<td valign="top" width="120" bgcolor="#ffffe8"><em><strong>MP_DISCONNECT_REASON_PREV_AUTH_INVALID</strong></em></td>
72<TD width="520">Indicates that the previous authentication is no longer valid.</TD>
73    </TR>
74    <TR>
75<td valign="top" width="120" bgcolor="#ffffe8"><em><strong>MP_DISCONNECT_REASON_DEAUTH_LEAVING</strong></em></td>
76<TD width="520">Indicates that authorization was removed because the BSS has been left.</TD>
77    </TR>
78    <TR>
79<td valign="top" width="120" bgcolor="#ffffe8"><em><strong>MP_DISCONNECT_REASON_INACTIVE</strong></em></td>
80<TD width="520">Indicates that a connection was lost due to inactivity.</TD>
81    </TR>
82    <TR>
83<td valign="top" width="120" bgcolor="#ffffe8"><em><strong>MP_DISCONNECT_REASON_UNABLE_HANDLE</strong></em></td>
84<TD width="520">Indicates the connection was lost because the AP had insufficient resources.</TD>
85    </TR>
86    <TR>
87<td valign="top" width="120" bgcolor="#ffffe8"><em><strong>MP_DISCONNECT_REASON_RX_CLASS2_FROM_NONAUTH_STA</strong></em></td>
88<TD width="520">Indicates that a Class2 frame was received from an unauthenticated STA.</TD>
89    </TR>
90    <TR>
91<td valign="top" width="120" bgcolor="#ffffe8"><em><strong>MP_DISCONNECT_REASON_RX_CLASS3_FROM_NONASSOC_STA</strong></em></td>
92<TD width="520">Indicates that a Class3 frame was received from a disconnected STA.</TD>
93    </TR>
94    <TR>
95<td valign="top" width="120" bgcolor="#ffffe8"><em><strong>MP_DISCONNECT_REASON_DISASSOC_LEAVING</strong></em></td>
96<TD width="520">Indicates that association was removed because the BSS has been left.</TD>
97    </TR>
98    <TR>
99<td valign="top" width="120" bgcolor="#ffffe8"><em><strong>MP_DISCONNECT_REASON_ASSOC_STA_NOTAUTHED</strong></em></td>
100<TD width="520">Indicates that the requested STA has not yet received authentication.</TD>
101    </TR>
102    <TR>
103<td valign="top" width="120" bgcolor="#ffffe8"><em><strong>MP_DISCONNECT_REASON_NO_ENTRY</strong></em></td>
104<TD width="520">Indicates that the parent is not yet in receipt of the current entry.</TD>
105    </TR>
106    <TR>
107<td valign="top" width="120" bgcolor="#ffffe8"><em><strong>MP_DISCONNECT_REASON_MP_LIFETIME</strong></em></td>
108<TD width="520">Indicates that the MP communications lifetime has expired.</TD>
109    </TR>
110    <TR>
111<td valign="top" width="120" bgcolor="#ffffe8"><em><strong>MP_DISCONNECT_REASON_UPDATE</strong></em></td>
112<TD width="520">Indicates that the child device in questions was re-registered with a different AID.</TD>
113    </TR>
114    <TR>
115<td valign="top" width="120" bgcolor="#ffffe8"><em><strong>MP_DISCONNECT_REASON_DEPRIVED_AID</strong></em></td>
116<TD width="520">Indicates that another communications partner has registered with the same AID number.</TD>
117    </TR>
118    <TR>
119<td valign="top" width="120" bgcolor="#ffffe8"><em><strong>MP_DISCONNECT_REASON_RESET</strong></em></td>
120<TD width="520">Indicates a disconnection resulting from a reset process.</TD>
121    </TR>
122    <TR>
123<td valign="top" width="120" bgcolor="#ffffe8"><em><strong>MP_DISCONNECT_REASON_ACTIVE</strong></em></td>
124<TD width="520">Indicates disconnection from self resulting from a disconnect function.</TD>
125    </TR>
126  </TBODY>
127</TABLE>
128
129<H2>Revision History</H2>
130<p>2006/07/03 Initial version.</p>
131
132<hr><p>CONFIDENTIAL</p></body>
133</html>
134