SignalingSession.BeginSetConnection Method
NOTE: This API is now obsolete.
This method is obsolete in UCMA 3.0 and will be removed from later versions. In its place use the ConnectionContext property on the SignalingSessionEstablishOptions class. Sets the connection to use for the outgoing signaling session before calling Participate. The initial Invite for the session will use this connection instead getting the connection based on endpoint settings. This method can be used only for SipPeerToPeer endpoint. Signaling sessions for SipEndpoint will use the connection maintained by SipEndpoint. The transport specified for the connection should be as secure as the tranport needed to send the Invite or else the Participate method call may fail. IMPORTANT: This is an advanced API. To work properly, the application should call this method before every redirect as well. The RedirectReceived event call back handler in the application should use TryThis and call this method before returning.
Namespace: Microsoft.Rtc.Signaling
Assembly: Microsoft.Rtc.Collaboration (in Microsoft.Rtc.Collaboration.dll)
Syntax
'Declaration
<ObsoleteAttribute("This method will be removed from future versions. Please use the ConnectionContext property of the SignalingSessionEstablishOptions instead.")> _
Public Function BeginSetConnection ( _
proxyHost As String, _
proxyPort As Integer, _
transport As SipTransportType, _
userCallback As AsyncCallback, _
state As Object _
) As IAsyncResult
'Usage
Dim instance As SignalingSession
Dim proxyHost As String
Dim proxyPort As Integer
Dim transport As SipTransportType
Dim userCallback As AsyncCallback
Dim state As Object
Dim returnValue As IAsyncResult
returnValue = instance.BeginSetConnection(proxyHost, _
proxyPort, transport, userCallback, _
state)
[ObsoleteAttribute("This method will be removed from future versions. Please use the ConnectionContext property of the SignalingSessionEstablishOptions instead.")]
public IAsyncResult BeginSetConnection(
string proxyHost,
int proxyPort,
SipTransportType transport,
AsyncCallback userCallback,
Object state
)
Parameters
- proxyHost
Type: System.String
The proxy host for the connection.
- proxyPort
Type: System.Int32
The port for the proxy.
- transport
Type: Microsoft.Rtc.Signaling.SipTransportType
The transport.
- 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.