SipEndpoint.BeginRegister Method

Definition

Namespace:

Microsoft.Rtc.Signaling

Assembly:

Microsoft.Rtc.Collaboration.dll

Overloads

BeginRegister(AsyncCallback, Object)	Starts an asynchronous Register operation for the current endpoint.
BeginRegister(IEnumerable<SignalingHeader>, AsyncCallback, Object)	Starts an asynchronous Register operation for the current endpoint.

BeginRegister(AsyncCallback, Object)

Starts an asynchronous Register operation for the current endpoint.

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

public IAsyncResult BeginRegister (AsyncCallback userCallback, object state);

member this.BeginRegister : AsyncCallback * obj -> IAsyncResult

Public Function BeginRegister (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 method was not called in the Unregistered state, or the endpoint had been terminated.

BeginRegister(IEnumerable<SignalingHeader>, AsyncCallback, Object)

Starts an asynchronous Register operation for the current endpoint.

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

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

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

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

Parameters

signalingHeaders

IEnumerable<SignalingHeader>

Collection of signaling headers to be included with Register request. 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 method was not called in the Unregistered state, or the endpoint is terminated.

RegisterException

Thrown when the registration failed.

AuthenticationException

Thrown when a general authentication-related problem occurred.

ArgumentException

Thrown when one of the header in headers parameters is a restricted header.