WDPEventType

定義

#include <nitro/wdp.h>

/* イベントコールバック種別 */
typedef enum WDPEventType
{
    /*** 親子共通で通知されるイベント ***/

    WDP_EVENT_PROGRESS,             /* status 更新通知 (引数は、更新されたAID) */
    WDP_EVENT_ERROR,                /* プロトコルエラー通知 */

    /*** 親機にのみ通知されるイベント ***/

    WDP_EVENT_PRE_BEACON_VOLAT,     /* 親機の可変情報ビーコン送信決定前. (引数はWDPSessionElement*) */
    WDP_EVENT_POST_BEACON_VOLAT     /* 親機の可変情報ビーコン送信決定後. (引数はWDPSessionElement*) */

    /*** 子機にのみ通知されるイベント ***/

    WDP_EVENT_SESSION_UPDATE_BEGIN, /* 既存セッションの更新開始 */
    WDP_EVENT_SESSION_UPDATE_END,   /* セッションの新規登場または更新完了 */
    WDP_EVENT_SESSION_CLOSED,       /* セッション終了 */
    WDP_EVENT_SESSION_FULL,         /* セッション列挙最大数 */
    WDP_EVENT_BOOTABLE,             /* ブート準備完了 */
}
WDPEventType;


説明

WDPライブラリのイベントを表す列挙定数を示します。
各値の意味は以下の通りです。

・親子共通で通知されるイベント
通知内容 引数の意味
WDP_EVENT_PROGRESS 接続対象の通信状態が遷移したごとに通知されます。 遷移した接続対象のAIDがu16型として与えられます。
WDP_EVENT_ERROR ライブラリ内部で通信プロトコルのエラーを検出した場合に通知されます。
このエラー通知は主に接続先の異常によって発生し、これを受けてアプリケーションが行うべき処理は特にありません。
エラー内容を格納したWDPErrorArgument型へのポインタが与えられます。

・親機にのみ通知されるイベント
通知内容 引数の意味
WDP_EVENT_PRE_BEACON_VOLAT 可変情報ビーコンを送信する直前に通知されます。
このイベントはユーザ定義値を設定するヒントとして通知されます。
送信中セッションのWDPSessionElement*型へのポインタが与えられます。
WDP_EVENT_POST_BEACON_VOLAT 可変情報ビーコンを送信した直後に通知されます。
このイベントはユーザ定義値を設定するヒントとして通知されます。
送信中セッションのWDPSessionElement*型へのポインタが与えられます。

・子機にのみ通知されるイベント
通知内容 引数の意味
WDP_EVENT_SESSION_UPDATE_BEGIN リストアップの完了している既存セッションが再更新を開始した時点で通知されます。 セッションを指すWDPSessionDesc構造体へのポインタが与えられます。
WDP_EVENT_SESSION_UPDATE_END 新規セッションのリストアップが完了したか既存セッションが再更新を完了した時点で通知されます。 セッションを指すWDPSessionDesc構造体へのポインタが与えられます。
WDP_EVENT_SESSION_CLOSED リストアップの完了している既存セッションが喪失したとみなされた時点で通知されます。 セッションを指すWDPSessionDesc構造体へのポインタが与えられます。
WDP_EVENT_SESSION_FULL 新規セッションを発見しつつその情報を格納するプールバッファが不足した場合に通知されます。
このイベントは、アプリケーションがWDP_ReserveSession関数を呼び出すヒントとして通知されます。
引数はありません。
WDP_EVENT_BOOTABLE 通信プロトコルが終了し再起動すべきシーケンスに達した時点で通知されます。 引数はありません。

参照

WDPCommandType WDPSessionElement* WDPErrorArgument WDPSessionDesc WDPCommandType
WDP_ReserveSession

履歴

2006/02/24 初版