PartyNetwork::GetDeviceConnectionType

  • [アーティクル]

このネットワーク上の指定された対象デバイスにメッセージやチャット データを送信するために、ローカル デバイスが使用する接続の種類を取得します。

構文

PartyError GetDeviceConnectionType(  
    const PartyDevice* targetDevice,  
    PartyDeviceConnectionType* deviceConnectionType  
)

パラメーター

targetDevice PartyDevice*

接続の種類を取得する必要のあるデバイス。

deviceConnectionType PartyDeviceConnectionType*
出力

出力デバイスの接続の種類。

戻り値

PartyError

c_partyErrorSuccess 接続の種類の取得に成功した場合、またはそうでない場合のエラーコード。 人間が読める形式のエラー コードは、PartyManager::GetErrorMessage() を介して取得できます。

解説

接続の種類は、デバイスで最初にユーザーをネットワークに認証するときに決定されます。 このネットワークで PartyNetworkConfiguration::directPeerConnectivityOptions フィールドで直接ピア ツー ピア接続を許可していて、どちらのデバイスも PartyOption::LocalDeviceDirectPeerConnectivityOptionsMask オプションを介したそのような接続を除外しておらず、その時点でダイレクト ピア接続が正常に確立された場合、この関数は PartyDeviceConnectionType::DirectPeerConnection の値を報告します。 そうでない場合は、PartyDeviceConnectionType::RelayServerを報告します。 この値は、対象となる PartyDevice オブジェクトがこのネットワークに存在する限り、最初に認証したユーザーに対して PartyNetwork::RemoveLocalUser() が呼び出された場合でも変更されません。

対象デバイスがローカル デバイスの場合、PartyNetworkConfiguration 設定や PartyOption::LocalDeviceDirectPeerConnectivityOptionsMask オプションにかかわらず、PartyDeviceConnectionType::RelayServer が常に報告されます。

対象デバイス オブジェクトがこのネットワークに参加していない場合は、エラーが返されます。

ローカル デバイスが対象のデバイス オブジェクトと共に他のネットワークに参加している場合、それらの他のネットワーク オブジェクトでこの同じ関数を呼び出しても同じ値が報告されると仮定することはできません。

要件

ヘッダー: Party.h

関連項目

PartyNetwork
PartyDeviceConnectionType
PartyNetworkConfiguration
PartyOption::LocalDeviceDirectPeerConnectivityOptionsMask