RemoteSystemSessionMessageChannel Class

Reference

Definition

Namespace:: Windows.System.RemoteSystems

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.

Edit

Handles a dedicated data transfer channel within a remote session. This class owns the functionality for both sending and receiving.

public ref class RemoteSystemSessionMessageChannel sealed

/// [Windows.Foundation.Metadata.Activatable(Windows.System.RemoteSystems.IRemoteSystemSessionMessageChannelFactory, 262144, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 262144)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class RemoteSystemSessionMessageChannel final

[Windows.Foundation.Metadata.Activatable(typeof(Windows.System.RemoteSystems.IRemoteSystemSessionMessageChannelFactory), 262144, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 262144)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class RemoteSystemSessionMessageChannel

function RemoteSystemSessionMessageChannel(session, channelName, reliability)

Public NotInheritable Class RemoteSystemSessionMessageChannel

Inheritance: Object Platform::Object IInspectable RemoteSystemSessionMessageChannel

Attributes: ActivatableAttribute ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Windows requirements

Device family	Windows 10 Creators Update (introduced in 10.0.15063.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v4.0)
App capabilities	remoteSystem

Remarks

Messages are sent and received over this channel asynchronously, so the chronological ordering of messages is not guaranteed.

Messages are delivered through a hub and spoke model: any message that a client sends to a participant or a set of participants is internally sent to the host device first, which then sends it to the target participant or participants.

Constructors

RemoteSystemSessionMessageChannel(RemoteSystemSession, String, RemoteSystemSessionMessageChannelReliability)	Initializes an instance of RemoteSystemSessionMessageChannel to manage messaging for a given remote session, specifying the reliability type of the channel.
RemoteSystemSessionMessageChannel(RemoteSystemSession, String)	Initializes an instance of RemoteSystemSessionMessageChannel to manage messaging for a given remote session

Properties

Session

Gets the remote session to which this messaging channel corresponds.

Methods

BroadcastValueSetAsync(ValueSet)	Sends a message to all other participants in this remote session messaging channel.
SendValueSetAsync(ValueSet, RemoteSystemSessionParticipant)	Sends a message to a participant in this remote session messaging channel.
SendValueSetToParticipantsAsync(ValueSet, IIterable<RemoteSystemSessionParticipant>)	Sends a message to a specified set participants in this remote session messaging channel.

Events

ValueSetReceived

Raised when a message (in the form of a key-value pair) is received by the channel. The contents of the message are contained by the RemoteSystemSessionValueSetReceivedEventArgs object that is passed in.

Applies to

Dela via