DevicePortalConnection.GetServerStreamWebSocketForRequest Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| GetServerStreamWebSocketForRequest(HttpRequestMessage) |
Returns a server-side stream WebSocket for use with Device Portal. |
| GetServerStreamWebSocketForRequest(HttpRequestMessage, String, UInt32, Boolean) |
Returns a server-side stream WebSocket for use with Device Portal. |
GetServerStreamWebSocketForRequest(HttpRequestMessage)
Returns a server-side stream WebSocket for use with Device Portal.
public:
virtual ServerStreamWebSocket ^ GetServerStreamWebSocketForRequest(HttpRequestMessage ^ request) = GetServerStreamWebSocketForRequest;/// [Windows.Foundation.Metadata.Overload("GetServerStreamWebSocketForRequest")]
ServerStreamWebSocket GetServerStreamWebSocketForRequest(HttpRequestMessage const& request);[Windows.Foundation.Metadata.Overload("GetServerStreamWebSocketForRequest")]
public ServerStreamWebSocket GetServerStreamWebSocketForRequest(HttpRequestMessage request);function getServerStreamWebSocketForRequest(request)Public Function GetServerStreamWebSocketForRequest (request As HttpRequestMessage) As ServerStreamWebSocketParameters
- request
- HttpRequestMessage
The HTTP request message (found as a property of the DevicePortalConnectionRequestReceivedEventArgs class).
Returns
A server-side stream WebSocket object that can be used with Device Portal.
- Attributes
Windows requirements
| Device family |
Windows 10, version 1803 (introduced in 10.0.17134.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced in v6.0)
|
Applies to
GetServerStreamWebSocketForRequest(HttpRequestMessage, String, UInt32, Boolean)
Returns a server-side stream WebSocket for use with Device Portal.
public:
virtual ServerStreamWebSocket ^ GetServerStreamWebSocketForRequest(HttpRequestMessage ^ request, Platform::String ^ protocol, unsigned int outboundBufferSizeInBytes, bool noDelay) = GetServerStreamWebSocketForRequest;/// [Windows.Foundation.Metadata.Overload("GetServerStreamWebSocketForRequest2")]
ServerStreamWebSocket GetServerStreamWebSocketForRequest(HttpRequestMessage const& request, winrt::hstring const& protocol, uint32_t const& outboundBufferSizeInBytes, bool const& noDelay);[Windows.Foundation.Metadata.Overload("GetServerStreamWebSocketForRequest2")]
public ServerStreamWebSocket GetServerStreamWebSocketForRequest(HttpRequestMessage request, string protocol, uint outboundBufferSizeInBytes, bool noDelay);function getServerStreamWebSocketForRequest(request, protocol, outboundBufferSizeInBytes, noDelay)Public Function GetServerStreamWebSocketForRequest (request As HttpRequestMessage, protocol As String, outboundBufferSizeInBytes As UInteger, noDelay As Boolean) As ServerStreamWebSocketParameters
- request
- HttpRequestMessage
The HTTP request message (found as a property of the DevicePortalConnectionRequestReceivedEventArgs class).
- protocol
-
String
Platform::String
winrt::hstring
The sub-protocol that this WebSocket will use.
- outboundBufferSizeInBytes
-
UInt32
unsigned int
uint32_t
The size, in bytes, of the send buffer to be used for sending data on a ServerMessageWebSocket object.
- noDelay
-
Boolean
bool
A boolean value indicating whether Nagle's algorithm is used on this WebSocket object. See the StreamSocketControl class for more information on Nagle's algorithm.
Returns
A server-side stream WebSocket object that can be used with Device Portal.
- Attributes
Windows requirements
| Device family |
Windows 10, version 1803 (introduced in 10.0.17134.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced in v6.0)
|