SignalingSession.BeginParticipate Method

Definition

Namespace:

Microsoft.Rtc.Signaling

Assembly:

Microsoft.Rtc.Collaboration.dll

Overloads

BeginParticipate(AsyncCallback, Object)	Participates in a session. This method needs to be called (for both outgoing and incoming messages) to establish the session.
BeginParticipate(IEnumerable<SignalingHeader>, AsyncCallback, Object)	Participates in a session. This method needs to be called (for both outgoing and incoming messages) to establish the session.

BeginParticipate(AsyncCallback, Object)

Participates in a session. This method needs to be called (for both outgoing and incoming messages) to establish the session.

public:
 IAsyncResult ^ BeginParticipate(AsyncCallback ^ userCallback, System::Object ^ state);

public IAsyncResult BeginParticipate (AsyncCallback userCallback, object state);

member this.BeginParticipate : AsyncCallback * obj -> IAsyncResult

Public Function BeginParticipate (userCallback As AsyncCallback, state As Object) As IAsyncResult

Parameters

userCallback

AsyncCallback

The method to be called when the asynchronous operation is completed.

state

Object

A user-provided object that distinguishes this particular asynchronous operation from other asynchronous operations.

Returns

IAsyncResult

An IAsyncResult that references the asynchronous operation.

Exceptions

InvalidOperationException

Thrown when the session is not in a valid state to Participate.

ArgumentException

Thrown when invalid arguments are passed.

ArgumentNullException

Thrown when null is supplied for a required argument. The argument name which is required is is part of the exception message.

RealTimeException

Thrown when some other failure occurs.

Remarks

This method is now deprecated in favor of the BeginEstablish and BeginAccept APIs.

BeginParticipate(IEnumerable<SignalingHeader>, AsyncCallback, Object)

Participates in a session. This method needs to be called (for both outgoing and incoming messages) to establish the session.

public:
 IAsyncResult ^ BeginParticipate(System::Collections::Generic::IEnumerable<Microsoft::Rtc::Signaling::SignalingHeader ^> ^ signalingHeaders, AsyncCallback ^ userCallback, System::Object ^ state);

public IAsyncResult BeginParticipate (System.Collections.Generic.IEnumerable<Microsoft.Rtc.Signaling.SignalingHeader> signalingHeaders, AsyncCallback userCallback, object state);

member this.BeginParticipate : seq<Microsoft.Rtc.Signaling.SignalingHeader> * AsyncCallback * obj -> IAsyncResult

Public Function BeginParticipate (signalingHeaders As IEnumerable(Of SignalingHeader), userCallback As AsyncCallback, state As Object) As IAsyncResult

Parameters

signalingHeaders

IEnumerable<SignalingHeader>

The collection of signaling headers. Can be null.

userCallback

AsyncCallback

The method to be called when the asynchronous operation is completed.

state

Object

A user-provided object that distinguishes this particular asynchronous operation from other asynchronous operations.

Returns

IAsyncResult

An IAsyncResult that references the asynchronous operation.

Exceptions

InvalidOperationException

Thrown when the session is not in a valid state to Participate.

ArgumentException

Thrown when invalid arguments are passed.

ArgumentNullException

Thrown when null is supplied for a required argument. The argument name which is required is is part of the exception message.

RealTimeException

Thrown when some other failure occurs.

Remarks

This method is now deprecated in favor of the BeginEstablish and BeginAccept APIs.