BeginSendReliableProvisionalResponse Method (Int32, IEnumerable(SignalingHeader), Boolean, AsyncCallback, Object)
Sends a reliable provisional response with option to send answer for early media.
Namespace: Microsoft.Rtc.Signaling
Assembly: Microsoft.Rtc.Collaboration (in Microsoft.Rtc.Collaboration.dll)
Syntax
'Declaration
Public Function BeginSendReliableProvisionalResponse ( _
responseCode As Integer, _
signalingHeaders As IEnumerable(Of SignalingHeader), _
needEarlyMediaSupport As Boolean, _
userCallback As AsyncCallback, _
state As Object _
) As IAsyncResult
'Usage
Dim instance As SignalingSession
Dim responseCode As Integer
Dim signalingHeaders As IEnumerable(Of SignalingHeader)
Dim needEarlyMediaSupport As Boolean
Dim userCallback As AsyncCallback
Dim state As Object
Dim returnValue As IAsyncResult
returnValue = instance.BeginSendReliableProvisionalResponse(responseCode, _
signalingHeaders, needEarlyMediaSupport, _
userCallback, state)
public IAsyncResult BeginSendReliableProvisionalResponse(
int responseCode,
IEnumerable<SignalingHeader> signalingHeaders,
bool needEarlyMediaSupport,
AsyncCallback userCallback,
Object state
)
Parameters
- responseCode
Type: System..::..Int32
The provisonal response code in the range 101-199.
- signalingHeaders
Type: System.Collections.Generic..::..IEnumerable<(Of <(<'SignalingHeader>)>)>
The custom signaling headers to add the response.
- needEarlyMediaSupport
Type: System..::..Boolean
The flag indicating whether the provisional response needs to send the media description.
- userCallback
Type: System..::..AsyncCallback
The callback to be invoked when the SendProvisionalResponse operation has completed.
- state
Type: System..::..Object
The state to be passed back to the callback.
Return Value
Type: System..::..IAsyncResult
An IAsyncResult object that references this operation.
Exceptions
| Exception | Condition |
|---|---|
| ArgumentOutOfRangeException | Thrown when the response code is not a provisional response code. |
| InvalidOperationException | Thrown if the sesison is not in incoming state. |
Remarks
If the inviter supports 100rel and the local policy is not unsupported, this method will wait for the PRACK. Otherwise, this method will not require 100rel. Any application that supports 100rel is recommended to use this method for sending provisional response. SendProvisional method can be used only when the application knows for sure that the remote does not require 100rel.