StreamSocketListener クラス

リファレンス

定義

名前空間:: Windows.Networking.Sockets

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

編集

TCP ストリームソケットまたは Bluetooth RFCOMM を使用した受信ネットワーク接続のリッスンをサポートします。

public ref class StreamSocketListener sealed : IClosable

/// [Windows.Foundation.Metadata.Activatable(65536, Windows.Foundation.UniversalApiContract)]
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class StreamSocketListener final : IClosable

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
/// [Windows.Foundation.Metadata.Activatable(65536, "Windows.Foundation.UniversalApiContract")]
class StreamSocketListener final : IClosable

[Windows.Foundation.Metadata.Activatable(65536, typeof(Windows.Foundation.UniversalApiContract))]
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class StreamSocketListener : System.IDisposable

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.Foundation.Metadata.Activatable(65536, "Windows.Foundation.UniversalApiContract")]
public sealed class StreamSocketListener : System.IDisposable

function StreamSocketListener()

Public NotInheritable Class StreamSocketListener
Implements IDisposable

継承: Object Platform::Object IInspectable StreamSocketListener

属性: ActivatableAttribute ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

実装: IClosable IDisposable

Windows の要件

デバイスファミリ	Windows 10 (10.0.10240.0 で導入)
API contract	Windows.Foundation.UniversalApiContract (v1.0 で導入)
アプリの機能	bluetooth.rfcomm ID_CAP_NETWORKING [Windows Phone] internetClientServer privateNetworkClientServer

注釈

StreamSocketListener クラスは、ストリームソケットを使用した受信ネットワーク接続のリッスンと接続の受け入れをサポートします。

操作の一般的な順序は次のとおりです。

StreamSocketListener を作成します。
Control プロパティを使用して StreamSocketListenerControl オブジェクトを取得し、必要なサービスのソケット品質を設定します。
ConnectionReceived イベントをイベントハンドラーに割り当てます。
BindServiceNameAsync メソッドまたは BindEndpointAsync メソッドを呼び出して、ローカル TCP ポート番号またはサービス名にバインドします。 Bluetooth RFCOMM の場合、ローカルサービス名パラメーターは Bluetooth サービス ID です。
接続を受信したら、StreamSocketListenerConnectionReceivedEventArgs オブジェクトを使用して、StreamSocket オブジェクトが作成された Socket プロパティを取得します。
StreamSocket オブジェクトを使用して、データの送受信を行います。
Close メソッドを呼び出して受信ネットワーク接続のリッスンと受け入れを停止し、StreamSocketListener オブジェクトに関連付けられているすべてのアンマネージドリソースを解放します。接続の受信時に作成された StreamSocket オブジェクトは影響を受けず、必要に応じて引き続き使用できます。

SocketProtectionLevel 列挙により、StreamSocketListener オブジェクトを使用して Bluetooth 経由でソケットをリッスンおよびバインドするときに、サーバーはクライアントとのプロトコルネゴシエーションを制御できます。 StreamSocketListener オブジェクトを Bluetooth 経由で使用する場合、サポートされている SocketProtectionLevel 値は PlainSocket、 BluetoothEncryptionAllowNullAuthentication、または BluetoothEncryptionWithAuthentication です。 StreamSocketListener オブジェクトを使用して Bluetooth を使用しないソケットをリッスンおよびバインドする場合、サポートされている SocketProtectionLevel 値は PlainSocket のみです。

Bluetooth で StreamSocketListener を使用するには、アプリマニフェストで bluetooth.rfcomm デバイス機能を設定する必要があります。詳細については、「 Bluetooth のデバイス機能を指定する方法」を参照してください。

例外の処理

StreamSocketListener クラスで非同期メソッドを呼び出すときに例外を処理するコードを記述する必要があります。例外は、パラメーター検証エラー、名前解決エラー、およびネットワークエラーによって発生する可能性があります。ネットワークエラーの例外 (接続の損失、接続エラー、サーバーエラーなど) は、いつでも発生する可能性があります。これらのエラーが起きると、例外がスローされます。アプリによって処理されない場合は、例外によってアプリ全体がランタイムによって終了する可能性があります。

Windows.Networking.Sockets 名前空間には、ソケット使用時のエラー処理を簡略化する機能があります。 SocketError クラスの GetStatus メソッドは、例外から SocketErrorStatus 列挙値に HRESULT を変換できます。これは、アプリで特定のネットワーク例外を異なる方法で処理する場合に役立つことがあります。アプリでは、パラメーター検証エラーの例外から HRESULT を使用して、例外の原因となったエラーの詳細を確認することもできます。

可能な例外と例外の処理方法の詳細については、「ネットワークアプリでの例外の処理」を参照してください。

Bluetooth での StreamSocketListener の使用

アプリでは、StreamSocketListener を使用して、Bluetooth RFCOMM 経由のネットワーク接続をリッスンできます。 Bluetooth 経由のネットワーク接続では、IP ポートやサービス名ではなく、接続のエンドポイントとして Bluetooth サービス ID が使用されます。 Bluetooth をリッスンするために、アプリは StreamSocketListener で BindServiceNameAsync メソッドのいずれかを呼び出し、 localServiceName パラメーターを Bluetooth サービス ID に設定します。

Bluetooth で StreamSocketListener と StreamSocket を使用するには、アプリマニフェストで bluetooth.rfcomm デバイス機能を設定する必要があります。詳細については、 Windows.Devices.Bluetooth.Rfcomm 名前空間、 Bluetooth のデバイス機能を指定する方法、 Bluetooth Rfcomm チャットのサンプルを参照してください。

Windows Server 2012での StreamSocketListener の使用

Windows Server 2012 および Windows Server 2012 R2 では、Media Foundation 機能が有効になっていない限り、Windows.Networking.Sockets 名前空間のほとんどのクラスを実装するWindows.Networking.dllは読み込みに失敗します。その結果、Media Foundation 機能が無効になっている場合、StreamSocketListener と Windows.Networking.Sockets 名前空間の関連ソケットクラスを使用するアプリは失敗します。 Windows Server 2012または Windows Server 2012 R2 は Media Foundation 機能を無効にしてインストールされます。

Media Foundation 機能は、サーバーマネージャーを使用するか、コマンドプロンプトまたはスクリプトに次のテキストを入力して、Windows Server 2012または Windows Server 2012 R2 で有効にすることができます。

dism /online /enable-feature /featurename:ServerMediaFoundation Media Foundation 機能を有効にすると、ユーザーは再起動するように求められます。コンピューターが再起動されると、 Windows.Networking.Sockets 名前空間のソケットと WebSocket のクラスが期待どおりに動作します。

コンストラクター

StreamSocketListener()

新しい StreamSocketListener オブジェクトを作成します。

プロパティ

Control	StreamSocketListener オブジェクトのソケットコントロールデータを取得します。
Information	StreamSocketListener オブジェクトのソケット情報を取得します。

メソッド

BindEndpointAsync(HostName, String)	StreamSocketListener でローカルホスト名とローカルサービス名へのバインド操作を開始します。
BindServiceNameAsync(String)	StreamSocketListener でローカルサービス名へのバインド操作を開始します。
BindServiceNameAsync(String, SocketProtectionLevel)	StreamSocketListener で、バインドされたソケットに設定する SocketProtectionLevel を指定して、ローカルサービス名へのバインド操作を開始します。
BindServiceNameAsync(String, SocketProtectionLevel, NetworkAdapter)	StreamSocketListener でソケットバインド操作を開始し、指定した SocketProtectionLevel を使用して、指定したネットワークアダプター上のローカルサービス名にバインドし、バインドされたソケットに設定します。
CancelIOAsync()	StreamSocketListener オブジェクトに対する保留中の読み取りと書き込みを取り消します。
Close()	StreamSocketListener オブジェクトを閉じます。
Dispose()	アンマネージリソースの解放またはリセットに関連付けられているアプリケーション定義のタスクを実行します。
EnableTransferOwnership(Guid)	アプリがアクティブでない間にこの StreamSocketListener のトラフィックが到着したときに、ソケットブローカーによってアプリのバックグラウンドタスクがトリガーされるようにします。
EnableTransferOwnership(Guid, SocketActivityConnectedStandbyAction)	システムがコネクトスタンバイ状態にある間にこの StreamSocketListener のトラフィックが到着したときに、ソケットブローカーによってアプリのバックグラウンドタスクがトリガーされるようにします。
TransferOwnership(String)	StreamSocketListener の所有権をソケットブローカーサービスに転送します。これにより、ソケットアクティビティが監視され、アクティビティがある場合はバックグラウンドタスクを通じてアプリに通知されます。
TransferOwnership(String, SocketActivityContext)	StreamSocketListener の所有権をソケットブローカーサービスに転送します。これにより、ソケットアクティビティが監視され、アクティビティがある場合はバックグラウンドタスクを通じてアプリに通知されます。

イベント

ConnectionReceived

StreamSocketListener オブジェクトで接続が受信されたことを示すイベント。

適用対象

次の方法で共有