SignalingSession.BeginEstablish Method (SignalingSessionEstablishOptions, AsyncCallback, Object)

Establish the session with options specified.

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

Syntax

'Declaration
Public Function BeginEstablish ( _
    options As SignalingSessionEstablishOptions, _
    userCallback As AsyncCallback, _
    state As Object _
) As IAsyncResult
'Usage
Dim instance As SignalingSession
Dim options As SignalingSessionEstablishOptions
Dim userCallback As AsyncCallback
Dim state As Object
Dim returnValue As IAsyncResult

returnValue = instance.BeginEstablish(options, _
    userCallback, state)
public IAsyncResult BeginEstablish(
    SignalingSessionEstablishOptions options,
    AsyncCallback userCallback,
    Object state
)

Parameters

  • 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
InvalidOperationException

Thrown when the state of the session does not allow the operation.

ArgumentException

Thrown when the options parameter contains invalid or restricted signaling headers.

See Also

Reference

SignalingSession Class

SignalingSession Members

BeginEstablish Overload

Microsoft.Rtc.Signaling Namespace