SignalingSession.SetConnection Method

This content is no longer actively maintained. It is provided as is, for anyone who may still be using these technologies, with no warranties or claims of accuracy with regard to the most recent product version or service release.

Sets the connection to use for the outgoing signaling session before calling Participate.

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

Syntax

'Declaration
Public Function SetConnection ( _
    proxyHost As String, _
    port As Integer, _
    transport As SipTransportType _
) As RealTimeConnection

public RealTimeConnection SetConnection (
    string proxyHost,
    int port,
    SipTransportType transport
)

Parameters

• proxyHost
  The proxy host for the connection.

• port
  The port for the proxy.

• transport
  The transport.

Return Value

The RealTimeConnection object that was created.

Exceptions

Remarks

The initial INVITE for the session uses this connection instead of getting the connection based on endpoint settings. This method can be used only for the SipPeerToPeer endpoint. Signaling sessions for SipEndpoint use the connection maintained by SipEndpoint. The transport specified for the connection should be as secure as the transport needed to send the INVITE or else the Participate method call can fail.

This is an advanced API. To work properly, the application should call this method before every redirect as well. The RedirectReceived event callback handler in the application should use TryThis and call this method before returning.

Thread Safety

All public static (Shared in Visual Basic) members of this type are thread-safe. Instance members are not guaranteed to be thread-safe.

Platforms

Development Platforms

Windows XP Professional with Service Pack 2 (SP2), Windows Server 2003, Windows Vista Ultimate Edition, Windows Vista Business Edition, Windows Vista Enterprise Edition

Target Platforms

See Also

Reference

SignalingSession Class
SignalingSession Members
Microsoft.Rtc.Signaling Namespace