/windows.networking.sockets/streamsocketcontrol.md

https://github.com/MicrosoftDocs/winrt-api · Markdown · 86 lines · 58 code · 28 blank · 0 comment · 0 complexity · 16c55f1eeb8c2fb3b3e71b8d1770c4a9 MD5 · raw file 

    

  1. ---
    2. 

  2. -api-id: T:Windows.Networking.Sockets.StreamSocketControl
    3. 

  3. -api-type: winrt class
    4. 

  4. ---
    5. 

  5. 

  6. <!-- Class syntax.
    7. 

  7. public class StreamSocketControl : Windows.Networking.Sockets.IStreamSocketControl, Windows.Networking.Sockets.IStreamSocketControl2, Windows.Networking.Sockets.IStreamSocketControl3
    8. 

  8. -->
    9. 

  9. 

  10. # Windows.Networking.Sockets.StreamSocketControl
    11. 

  11. 

  12. ## -description
    13. 

  13. Provides socket control data on a [StreamSocket](streamsocket.md) object.
    14. 

  14. 

  15. ## -remarks
    16. 

  16. The StreamSocketControl class provides access to advanced socket control data on a [StreamSocket](streamsocket.md) object.
    17. 

  17. 

  18. A StreamSocketControl object is automatically created with the parent [StreamSocket](streamsocket.md) object. The [StreamSocket.Control](streamsocket_control.md) property provides access to the associated StreamSocketControl object.
    19. 

  19. 

  20. Any changes to the property values on the StreamSocketControl must be set before the [StreamSocket](streamsocket.md) is connected. As a result if you need to make changes to the [ClientCertificate](streamsocketcontrol_clientcertificate.md), [IgnorableServerCertificateErrors](streamsocketcontrol_ignorableservercertificateerrors.md), [KeepAlive](streamsocketcontrol_keepalive.md), [NoDelay](streamsocketcontrol_nodelay.md), [OutboundBufferSizeInBytes](streamsocketcontrol_outboundbuffersizeinbytes.md) , [OutboundUnicastHopLimit](streamsocketcontrol_outboundunicasthoplimit.md), or [QualityOfService](streamsocketcontrol_qualityofservice.md) properties, then these changes must occur before a successful call to one of the [ConnectAsync](streamsocket_connectasync_13692504.md) methods on the [StreamSocket](streamsocket.md).
    21. 

  21. 

  22. Use the [ClientCertificate](streamsocketcontrol_clientcertificate.md) to set a client certificate to be used to make secure connections over the associated [StreamSocket](streamsocket.md) object.
    23. 

  23. 

  24. The following example creates a [StreamSocket](streamsocket.md), and then demonstrates how to set the [NoDelay](streamsocketcontrol_nodelay.md) property to **false**. Other properties may be set in a similar manner. After this is done, the app can connect the [StreamSocket](streamsocket.md).
    25. 

  25. 

  26. ```csharp
    27. 

  27. using Windows.Networking.Sockets;
    28. 

    29. 

  29. StreamSocket clientSocket = new StreamSocket();
    30. 

    31. 

  31. // Get the current setting for this option.
    32. 

  32. // This isn't required, but it shows how to get the current setting.
    33. 

  33. bool currentSetting = clientSocket.Control.NoDelay;
    34. 

    35. 

  35. // Set NoDelay to false so that the Nagle algorithm is not disabled.
    36. 

  36. clientSocket.Control.NoDelay = false;
    37. 

    38. 

  38. // Now you can call the ConnectAsync method to connect the StreamSocket.
    39. 

  39. ```
    40. 

  40. 

  41. ```cppwinrt
    42. 

  42. #include <winrt/Windows.Networking.Sockets.h>
    43. 

  43. using namespace winrt;
    44. 

  44. ...
    45. 

  45. Windows::Networking::Sockets::StreamSocket clientSocket;
    46. 

    47. 

  47. // Get the current setting for this option.
    48. 

  48. // This isn't required, but it shows how to get the current setting.
    49. 

  49. bool currentSetting{ clientSocket.Control().NoDelay() };
    50. 

    51. 

  51. // Set NoDelay to false so that the Nagle algorithm is not disabled.
    52. 

  52. clientSocket.Control().NoDelay(false);
    53. 

    54. 

  54. // Now you can call the ConnectAsync function to connect the StreamSocket.
    55. 

  55. ```
    56. 

  56. 

  57. ```cppcx
    58. 

  58. using namespace Windows::Networking::Sockets;
    59. 

    60. 

  60. StreamSocket^ clientSocket = ref new StreamSocket();
    61. 

    62. 

  62. // Get the current setting for this option.
    63. 

  63. // This isn't required, but it shows how to get the current setting.
    64. 

  64. bool currentSetting = clientSocket->Control->NoDelay;
    65. 

    66. 

  66. // Set NoDelay to false so that the Nagle algorithm is not disabled.
    67. 

  67. clientSocket->Control->NoDelay = false;
    68. 

    69. 

  69. // Now you can call the ConnectAsync method to connect the StreamSocket.
    70. 

  70. ```
    71. 

  71. 

  72. For more information on using StreamSocketControl, see [How to use advanced socket controls](/previous-versions/windows/apps/jj150598(v=win.10)).
    73. 

  73. 

  74. ### Version history
    75. 

  75. 

  76. | Windows version | SDK version | Value added |
    77. 

  77. | -- | -- | -- |
    78. 

  78. | 1709 | 16299 | MinProtectionLevel |
    79. 

  79. 

  80. ## -examples
    81. 

  81. 

  82. ## -see-also
    83. 

  83. [Connecting with sockets](/previous-versions/windows/apps/hh452976(v=win.10)), [How to use advanced socket controls](/previous-versions/windows/apps/jj150598(v=win.10)), [StreamSocket](streamsocket.md), [StreamSocket.Control](streamsocket_control.md), [StreamSocketInformation](datagramsocketinformation.md), [ControlChannelTrigger StreamSocket sample](https://github.com/microsoftarchive/msdn-code-gallery-microsoft/tree/master/Official%20Windows%20Platform%20Sample/Windows%208.1%20Store%20app%20samples/%5BC%23%5D-Windows%208.1%20Store%20app%20samples/ControlChannelTrigger%20StreamSocket%20sample/C%23), [StreamSocket sample](/samples/browse/)
    84. 

  84. 

  85. ## -capabilities
    86. 

  86. ID_CAP_NETWORKING [Windows Phone], bluetooth.rfcomm
    87.