DWC_CloseConnectionHardFromServer

構文

#include <dwc.h>
int DWC_CloseConnectionHardFromServer(u8 aid);

引数

aid クローズしたいホストのAID

返り値

0 クローズ処理完了
-1 接続完了後でない、もしくはエラー発生時なので何もしなかった。
-2 既にクローズ済みのAIDが指定されたので何もしなかった。
-3 自分がサーバホストでない状態で呼び出した。

説明

この関数はサーバホストからのみ呼び出すことができます。

指定のAIDとのコネクションを強制的にクローズします。クローズ処理は本関数内で完了し、本関数を抜ける前にDWC_SetConnectionClosedCallback関数で設定したコールバック関数が呼び出されます。

ニンテンドーWi-Fiコネクションにはログインしたままとなります。

このクローズは相手ホストにも通知され、相手ホストではクローズコールバックDWCConnectionClosedCallbackが呼び出されます。ただし、このクローズ通知はUDP通信で一度しか送信されないため、通信路の状況などによっては相手に届かない可能性もあります。

電源を切るなどの理由で通信不能になったホストに対し、コネクションをクローズするというような、異常状態処理の用途を想定しています。

DWC_CloseConnectionHardBitmapFromServer関数を使えば、複数のAIDへのコネクションを一度にクローズすることができます。

履歴

5.1pr2より前の変更履歴はこちら