DevicePortalConnection.GetServerMessageWebSocketForRequest 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
| GetServerMessageWebSocketForRequest(HttpRequestMessage) |
Returns a server-side message WebSocket for use with Device Portal. |
| GetServerMessageWebSocketForRequest(HttpRequestMessage, SocketMessageType, String) |
Returns a server-side message WebSocket for use with Device Portal. |
| GetServerMessageWebSocketForRequest(HttpRequestMessage, SocketMessageType, String, UInt32, UInt32, MessageWebSocketReceiveMode) |
Returns a server-side message WebSocket for use with Device Portal. |
GetServerMessageWebSocketForRequest(HttpRequestMessage)
Returns a server-side message WebSocket for use with Device Portal.
public:
virtual ServerMessageWebSocket ^ GetServerMessageWebSocketForRequest(HttpRequestMessage ^ request) = GetServerMessageWebSocketForRequest;/// [Windows.Foundation.Metadata.Overload("GetServerMessageWebSocketForRequest")]
ServerMessageWebSocket GetServerMessageWebSocketForRequest(HttpRequestMessage const& request);[Windows.Foundation.Metadata.Overload("GetServerMessageWebSocketForRequest")]
public ServerMessageWebSocket GetServerMessageWebSocketForRequest(HttpRequestMessage request);function getServerMessageWebSocketForRequest(request)Public Function GetServerMessageWebSocketForRequest (request As HttpRequestMessage) As ServerMessageWebSocketParameters
- request
- HttpRequestMessage
The HTTP request message (found as a property of the DevicePortalConnectionRequestReceivedEventArgs class).
Returns
A server-side message 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
GetServerMessageWebSocketForRequest(HttpRequestMessage, SocketMessageType, String)
Returns a server-side message WebSocket for use with Device Portal.
public:
virtual ServerMessageWebSocket ^ GetServerMessageWebSocketForRequest(HttpRequestMessage ^ request, SocketMessageType messageType, Platform::String ^ protocol) = GetServerMessageWebSocketForRequest;/// [Windows.Foundation.Metadata.Overload("GetServerMessageWebSocketForRequest2")]
ServerMessageWebSocket GetServerMessageWebSocketForRequest(HttpRequestMessage const& request, SocketMessageType const& messageType, winrt::hstring const& protocol);[Windows.Foundation.Metadata.Overload("GetServerMessageWebSocketForRequest2")]
public ServerMessageWebSocket GetServerMessageWebSocketForRequest(HttpRequestMessage request, SocketMessageType messageType, string protocol);function getServerMessageWebSocketForRequest(request, messageType, protocol)Public Function GetServerMessageWebSocketForRequest (request As HttpRequestMessage, messageType As SocketMessageType, protocol As String) As ServerMessageWebSocketParameters
- request
- HttpRequestMessage
The HTTP request message (found as a property of the DevicePortalConnectionRequestReceivedEventArgs class).
- messageType
- SocketMessageType
A SocketMessageType value indicating the type of messaging that this WebSocket will use.
- protocol
-
String
Platform::String
winrt::hstring
The sub-protocol that this WebSocket will use.
Returns
A server-side message 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
GetServerMessageWebSocketForRequest(HttpRequestMessage, SocketMessageType, String, UInt32, UInt32, MessageWebSocketReceiveMode)
Returns a server-side message WebSocket for use with Device Portal.
public:
virtual ServerMessageWebSocket ^ GetServerMessageWebSocketForRequest(HttpRequestMessage ^ request, SocketMessageType messageType, Platform::String ^ protocol, unsigned int outboundBufferSizeInBytes, unsigned int maxMessageSize, MessageWebSocketReceiveMode receiveMode) = GetServerMessageWebSocketForRequest;/// [Windows.Foundation.Metadata.Overload("GetServerMessageWebSocketForRequest3")]
ServerMessageWebSocket GetServerMessageWebSocketForRequest(HttpRequestMessage const& request, SocketMessageType const& messageType, winrt::hstring const& protocol, uint32_t const& outboundBufferSizeInBytes, uint32_t const& maxMessageSize, MessageWebSocketReceiveMode const& receiveMode);[Windows.Foundation.Metadata.Overload("GetServerMessageWebSocketForRequest3")]
public ServerMessageWebSocket GetServerMessageWebSocketForRequest(HttpRequestMessage request, SocketMessageType messageType, string protocol, uint outboundBufferSizeInBytes, uint maxMessageSize, MessageWebSocketReceiveMode receiveMode);function getServerMessageWebSocketForRequest(request, messageType, protocol, outboundBufferSizeInBytes, maxMessageSize, receiveMode)Public Function GetServerMessageWebSocketForRequest (request As HttpRequestMessage, messageType As SocketMessageType, protocol As String, outboundBufferSizeInBytes As UInteger, maxMessageSize As UInteger, receiveMode As MessageWebSocketReceiveMode) As ServerMessageWebSocketParameters
- request
- HttpRequestMessage
The HTTP request message (found as a property of the DevicePortalConnectionRequestReceivedEventArgs class).
- messageType
- SocketMessageType
A SocketMessageType value indicating the type of messaging that this WebSocket will use.
- 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.
- maxMessageSize
-
UInt32
unsigned int
uint32_t
The maximum message size, in bytes, for a WebSocket message to be configured on the ServerMessageWebSocket object.
- receiveMode
- MessageWebSocketReceiveMode
A MessageWebSocketReceiveMode value indicating whether this WebSocket will receive either complete or partial messages.
Returns
A server-side message 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)
|