WMStartConnectCallback

定義

#include <nitro/wm.h>
typedef struct WMStartConnectCallback
{ 
    u16     apiid;
    u16     errcode;
    u16     wlCmdID;
    u16     wlResult;
    u16     state;
    u16     aid;
    u16     reason;
    u16     wlStatus;
    u8      macAddress[6];

} WMStartConnectCallback;

要素

apiid コールバック発生の元となったAPIのIDです。WMApiid列挙型と同義です。 ここではWM_APIID_START_CONNECTに固定となります。
errcode 非同期処理の結果です。WMErrCode列挙型と同義です。
wlCmdID errcodeがWM_ERRCODE_FAILEDの場合、無線ファームウェアでエラーとなったコマンドのIDが格納されます。
wlResult errcodeがWM_ERRCODE_FAILEDの場合、無線ファームウェアでエラーとなった要因コードが格納されます。
state errcodeがWM_ERRCODE_SUCCESSの場合、コールバックの発生した要因種別が格納されます。発生しうる要因は以下の5つです。
WM_STATECODE_CONNECT_START、WM_STATECODE_CONNECTED、WM_STATECODE_BEACON_LOST、WM_STATECODE_DISCONNECTED、WM_STATECODE_DISCONNECTED_FROM_MYSELF。
aid stateがWM_STATECODE_CONNECTEDの場合、親機から割り当てられたAIDが格納されます。
reason stateがWM_STATECODE_DISCONNECTED、WM_STATECODE_DISCONNECTED_FROM_MYSELFの場合、切断された理由を示すコードが格納されます。
ライブラリ内部で使用されるデバッグ目的のメンバです。
wlStatus errcodeがWM_ERRCODE_FAILEDの場合、接続に失敗する原因となった通信相手の状態を示すコードが格納されます。
ライブラリ内部で使用されるデバッグ目的のメンバです。
macAddress stateがWM_STATECODE_CONNECTED、WM_STATECODE_DISCONNECTED、WM_STATECODE_DISCONNECTED_FROM_MYSELFの場合に、親機のMACアドレスが格納されます。

説明

WM_StartConnect( )に対するコールバック関数に渡される構造体です。

履歴

2006/02/17 stateに返るコードに関する記述を修正
2005/10/31 macAddressメンバの追加
2005/09/05 wlStatusメンバについての説明を追加
2004/11/10 reasonメンバについての説明を変更
2004/08/02 構造体名の統一
2004/07/29 初版