Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

StreamSocketListener class

Applies to Windows and Windows Phone

Supports listening for an incoming network connection using a TCP stream socket or Bluetooth RFCOMM.

Syntax


public sealed class StreamSocketListener : IDisposable

Attributes

[DualApiPartition()]
[MarshalingBehavior(Agile)]
[Threading(Both)]
[Version(0x06020000)]

Members

The StreamSocketListener class has these types of members:

Constructors

The StreamSocketListener class has these constructors.

ConstructorDescription
StreamSocketListener Creates a new StreamSocketListener object.

 

Events

The StreamSocketListener class has these events.

EventDescription
ConnectionReceived An event that indicates that a connection was received on the StreamSocketListener object.

 

Methods

The StreamSocketListener class has these methods. With C#, Visual Basic, and C++, it also inherits methods from the Object class.

MethodDescription
BindEndpointAsync Starts a bind operation on a StreamSocketListener to a local hostname and a local service name.
BindServiceNameAsync(String) Starts a bind operation on a StreamSocketListener to a local service name.
BindServiceNameAsync(String, SocketProtectionLevel) Starts a bind operation on a StreamSocketListener to a local service name with a specified SocketProtectionLevel to set on any bound sockets.
BindServiceNameAsync(String, SocketProtectionLevel, NetworkAdapter) Starts a socket bind operation on a StreamSocketListener to a local service name on a specified network adapter with a specified SocketProtectionLevel to set on any bound sockets.
Close [C++, JavaScript]Closes the StreamSocketListener object.
Dispose [C#, VB]Performs tasks associated with freeing, releasing, or resetting unmanaged resources.

 

Properties

The StreamSocketListener class has these properties.

PropertyAccess typeDescription

Control

Read-onlyGets socket control data on a StreamSocketListener object.

Information

Read-onlyGets socket information for the StreamSocketListener object.

 

Remarks

The StreamSocketListener class supports listening for an incoming network connection using a stream socket and accepting the connection.

The typical order of operations is as follows:

The SocketProtectionLevel enumeration allows a server to control protocol negotiation with clients when using the StreamSocketListener object to listen and bind to sockets over Bluetooth. When the StreamSocketListener object is used over Bluetooth, the supported SocketProtectionLevel values are PlainSocket, BluetoothEncryptionAllowNullAuthentication, or BluetoothEncryptionWithAuthentication. When the StreamSocketListener object is used to listen and bind to sockets not using Bluetooth, the only supported SocketProtectionLevel value is PlainSocket.

To use StreamSocketListener with Bluetooth, the bluetooth.rfcomm device capability must be set in the app manifest. For more information, see How to specify device capabilities for Bluetooth.

Handling exceptions

You must write code to handle exceptions when you call asynchronous methods on the StreamSocketListener class. Exceptions can result from parameter validation errors, name resolutions failures, and network errors. Exceptions from network errors (loss of connectivity, connection failures, and server failures, for example) can happen at any time. These errors result in exceptions being thrown. If not handled by your app, an exception can cause your entire app to be terminated by the runtime.

The Windows.Networking.Sockets namespace has features that simplify handling errors when using sockets. The GetStatus method on the SocketError class can convert the HRESULT from an exception to a SocketErrorStatus enumeration value. This can be useful for handling specific network exceptions differently in your app. An app can also use the HRESULT from the exception on parameter validation errors to learn more detailed information on the error that caused the exception.

For more information on possible exceptions and how to handle exceptions, see Handling exceptions in network apps.

Using StreamSocketListener with Bluetooth

Your app can use StreamSocketListener to listen for network connections over Bluetooth RFCOMM. Network connections over Bluetooth use a Bluetooth Service ID as the endpoint for connections, not an IP port or a service name. To listen for Bluetooth, your app would call one of the BindServiceNameAsync methods on StreamSocketListener with the localServiceName parameter set to a Bluetooth Service ID.

To use StreamSocketListener and StreamSocket with Bluetooth, the bluetooth.rfcomm device capability must be set in the app manifest. For more information, see the Windows.Devices.Bluetooth.Rfcomm namespace, How to specify device capabilities for Bluetooth, and the Bluetooth Rfcomm Chat sample.

Using StreamSocketListener on Windows Server 2012

On Windows Server 2012 and Windows Server 2012 R2, the Windows.Networking.dll that implements most of the classes in the Windows.Networking.Sockets namespace will fail to load unless the Media Foundation feature is enabled. As a result, apps that use StreamSocketListener and related socket classes in the Windows.Networking.Sockets namespace will fail if the Media Foundation feature is disabled. Windows Server 2012 or Windows Server 2012 R2 installs with the Media Foundation feature disabled.

The Media Foundation feature can be enabled on Windows Server 2012 or Windows Server 2012 R2 using Server Manager or by entering the following text in a command prompt or a script:

dism /online /enable-feature /featurename:ServerMediaFoundation

After the Media Foundation feature is enabled, the user is prompted to restart. Once the computer is restarted, classes for sockets and WebSockets in the Windows.Networking.Sockets namespace will work as expected.

Requirements

Minimum supported client

Windows 8 [Windows Store apps, desktop apps]

Minimum supported server

Windows Server 2012 [Windows Store apps, desktop apps]

Minimum supported phone

Windows Phone 8

Namespace

Windows.Networking.Sockets
Windows::Networking::Sockets [C++]

Metadata

Windows.winmd

DLL

Windows.Networking.dll

Capabilities

internetClientServer
privateNetworkClientServer
ID_CAP_NETWORKING [Windows Phone]
bluetooth.rfcomm

See also

Other resources
Connecting with sockets (HTML)
Connecting with sockets (XAML)
Handling exceptions in network apps
How to connect with a stream socket (HTML)
How to connect with a stream socket (XAML)
How to specify device capabilities for Bluetooth
How to use advanced socket controls (HTML)
How to use advanced socket controls (XAML)
Troubleshoot and debug network connections
Reference
IClosable
Object
SocketError
SocketErrorStatus
StreamSocket
StreamSocketListenerConnectionReceivedEventArgs
StreamSocketListenerControl
StreamSocketListenerInformation
Samples
Bluetooth Rfcomm Chat sample
ControlChannelTrigger StreamSocket sample
Proximity sample
StreamSocket sample

 

 

Show:
© 2014 Microsoft