RealTimeEndpoint.BeginSendMessage Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
BeginSendMessage(MessageType, RealTimeAddress, ContentType, Byte[], IEnumerable<SignalingHeader>, AsyncCallback, Object)
Sends a message.
public:
IAsyncResult ^ BeginSendMessage(Microsoft::Rtc::Signaling::MessageType messageType, Microsoft::Rtc::Signaling::RealTimeAddress ^ sessionTarget, System::Net::Mime::ContentType ^ contentType, cli::array <System::Byte> ^ body, System::Collections::Generic::IEnumerable<Microsoft::Rtc::Signaling::SignalingHeader ^> ^ signalingHeaders, AsyncCallback ^ userCallback, System::Object ^ state);public IAsyncResult BeginSendMessage (Microsoft.Rtc.Signaling.MessageType messageType, Microsoft.Rtc.Signaling.RealTimeAddress sessionTarget, System.Net.Mime.ContentType contentType, byte[] body, System.Collections.Generic.IEnumerable<Microsoft.Rtc.Signaling.SignalingHeader> signalingHeaders, AsyncCallback userCallback, object state);member this.BeginSendMessage : Microsoft.Rtc.Signaling.MessageType * Microsoft.Rtc.Signaling.RealTimeAddress * System.Net.Mime.ContentType * byte[] * seq<Microsoft.Rtc.Signaling.SignalingHeader> * AsyncCallback * obj -> IAsyncResultParameters
- messageType
- MessageType
The message type.
- sessionTarget
- RealTimeAddress
Target to send the message.
- contentType
- ContentType
Content type describing the body. If null text/plain, UTF-8 is assumed.
- body
- Byte[]
The body for the data.
- signalingHeaders
- IEnumerable<SignalingHeader>
The headers provided for this message. 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 others.
Returns
An IAsyncResult that references the asynchronous operation.
Exceptions
Thrown when null is supplied for a required argument. The argument name which is required is is part of the exception message.
Thrown if one of the SignalingHeader in signalingHeaders collection have null or restricted header.
Applies to
BeginSendMessage(MessageType, RealTimeAddress, ContentType, Byte[], AsyncCallback, Object)
Sends a message to another endpoint.
public:
IAsyncResult ^ BeginSendMessage(Microsoft::Rtc::Signaling::MessageType messageType, Microsoft::Rtc::Signaling::RealTimeAddress ^ sessionTarget, System::Net::Mime::ContentType ^ contentType, cli::array <System::Byte> ^ body, AsyncCallback ^ userCallback, System::Object ^ state);public IAsyncResult BeginSendMessage (Microsoft.Rtc.Signaling.MessageType messageType, Microsoft.Rtc.Signaling.RealTimeAddress sessionTarget, System.Net.Mime.ContentType contentType, byte[] body, AsyncCallback userCallback, object state);member this.BeginSendMessage : Microsoft.Rtc.Signaling.MessageType * Microsoft.Rtc.Signaling.RealTimeAddress * System.Net.Mime.ContentType * byte[] * AsyncCallback * obj -> IAsyncResultParameters
- messageType
- MessageType
The message type.
- sessionTarget
- RealTimeAddress
Target to send the message.
- contentType
- ContentType
Content type describing the body. If null the body must be null. If no encoding is specified, UTF8 is assumed.
- body
- Byte[]
The body for the data.
- 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 others.
Returns
An IAsyncResult that references the asynchronous operation.
Exceptions
Thrown when arguments are null.
Applies to
BeginSendMessage(MessageType, RealTimeAddress, SendMessageOptions, AsyncCallback, Object)
Sends a message.
public:
IAsyncResult ^ BeginSendMessage(Microsoft::Rtc::Signaling::MessageType messageType, Microsoft::Rtc::Signaling::RealTimeAddress ^ sessionTarget, Microsoft::Rtc::Signaling::SendMessageOptions ^ options, AsyncCallback ^ userCallback, System::Object ^ state);public IAsyncResult BeginSendMessage (Microsoft.Rtc.Signaling.MessageType messageType, Microsoft.Rtc.Signaling.RealTimeAddress sessionTarget, Microsoft.Rtc.Signaling.SendMessageOptions options, AsyncCallback userCallback, object state);member this.BeginSendMessage : Microsoft.Rtc.Signaling.MessageType * Microsoft.Rtc.Signaling.RealTimeAddress * Microsoft.Rtc.Signaling.SendMessageOptions * AsyncCallback * obj -> IAsyncResultParameters
- messageType
- MessageType
The message type.
- sessionTarget
- RealTimeAddress
Target to send the message.
- options
- SendMessageOptions
Options to customize the behavior of send message.
- 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 others.
Returns
An IAsyncResult that references the asynchronous operation.
Exceptions
Thrown when null is supplied for a required argument. The argument name which is required is is part of the exception message.
Thrown if one of the SignalingHeader in signalingHeaders collection have null or restricted header.
Attempting to specify a connection context sending a message on a SipEndpoint.