Share via

RealTimeEndpoint.BeginSendMessageInternal Method

  • Article

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.

Sends a message.

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

Syntax

'Declaration
Protected Function BeginSendMessageInternal ( _
    localIdentityUri As String, _
    messageType As MessageType, _
    sessionTarget As RealTimeAddress, _
    contentType As ContentType, _
    body As Byte(), _
    signalingHeaders As IEnumerable(Of SignalingHeader), _
    userCallback As AsyncCallback, _
    state As Object _
) As IAsyncResult

protected IAsyncResult BeginSendMessageInternal (
    string localIdentityUri,
    MessageType messageType,
    RealTimeAddress sessionTarget,
    ContentType contentType,
    byte[] body,
    IEnumerable<SignalingHeader> signalingHeaders,
    AsyncCallback userCallback,
    Object state
)

Parameters

  • localIdentityUri
    The local identify uri to use. If null, the local endpoint's uri is used.
  • messageType
    The message type.
  • sessionTarget
    The target to send the message.
  • contentType
    The content type describing the body. If null text/plain, UTF-8 is assumed.
  • body
    The body for the data.
  • signalingHeaders
    The headers provided for this invite.
  • userCallback
    The method to be called when the async operation is completed.
  • state
    A user-provided object that distinguishes this particular asynchronous operation from others.

Return Value

Returns an IAsyncResult that references this operation.

Exceptions

Exception type Condition
ArgumentNullException

Thrown when a non-null is expected for an argument. The argument name for which a non-null is expected is part of the exception message.
ServerPolicyException

Thrown when a server policy setting does not allow sending the message.
ArgumentException

Thrown if one of the SignalingHeader in the signalingHeaders collection have null or restricted header.

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

RealTimeEndpoint Class
RealTimeEndpoint Members
Microsoft.Rtc.Signaling Namespace