SignalingSession.BeginSendReliableProvisionalResponse Method (Int32, String, IEnumerable<SignalingHeader>, Boolean, AsyncCallback, Object)

This method can be used to send a reliable provisional response with option to send answer for early media. 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.

Namespace:  Microsoft.Rtc.Signaling
Assembly:  Microsoft.Rtc.Collaboration (in Microsoft.Rtc.Collaboration.dll)

Syntax

'Declaration
Public Function BeginSendReliableProvisionalResponse ( _
    responseCode As Integer, _
    responseText As String, _
    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 responseText As String
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, _
    responseText, signalingHeaders, _
    needEarlyMediaSupport, userCallback, _
    state)
public IAsyncResult BeginSendReliableProvisionalResponse(
    int responseCode,
    string responseText,
    IEnumerable<SignalingHeader> signalingHeaders,
    bool needEarlyMediaSupport,
    AsyncCallback userCallback,
    Object state
)

Parameters

  • responseCode
    Type: System.Int32
    The provisional response code in the range 101-199.
  • responseText
    Type: System.String
    Reason phrase send out with the response. If null or empty default reason phrase will be generated.
  • needEarlyMediaSupport
    Type: System.Boolean
    The flag indicating whether the provisional response need to send media description.
  • userCallback
    Type: System.AsyncCallback
    The method to be called when the asynchronous operation is completed.
  • state
    Type: System.Object
    A user-provided object that distinguishes this particular asynchronous operation from other asynchronous operations.

Return Value

Type: System.IAsyncResult
An IAsyncResult that references the asynchronous operation.

Exceptions

Exception Condition
ArgumentOutOfRangeException

Thrown when the response code is not a provisional response code.

InvalidOperationException

Thrown if the sesssion is not in incoming state.

See Also

Reference

SignalingSession Class

SignalingSession Members

BeginSendReliableProvisionalResponse Overload

Microsoft.Rtc.Signaling Namespace