VisualizerObjectSourceClient.RequestDataAsync Method

Definition

Namespace:

Microsoft.VisualStudio.Extensibility.DebuggerVisualizers

Assembly:

Microsoft.VisualStudio.Extensibility.dll

Package:

Microsoft.VisualStudio.Extensibility v17.12.2051

Overloads

RequestDataAsync(CancellationToken)	Sends an empty message to the visualizer object source in the debug target process and returns the corresponding response.
RequestDataAsync(JToken, CancellationToken)	Sends a message to the visualizer object source in the debug target process and returns the corresponding response.
RequestDataAsync(Nullable<ReadOnlySequence<Byte>>, CancellationToken)	Sends a message to the visualizer object source in the debug target process and returns the corresponding response.
RequestDataAsync<TMessage,TResponse>(TMessage, JsonSerializer, CancellationToken)	Sends a message to the visualizer object source in the debug target process and returns the corresponding response.
RequestDataAsync<TResponse>(JsonSerializer, CancellationToken)	Sends an empty message to the visualizer object source in the debug target process and returns the corresponding response.

RequestDataAsync(CancellationToken)

Sends an empty message to the visualizer object source in the debug target process and returns the corresponding response.

public virtual System.Threading.Tasks.Task<Newtonsoft.Json.Linq.JToken> RequestDataAsync (System.Threading.CancellationToken cancellationToken);

abstract member RequestDataAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<Newtonsoft.Json.Linq.JToken>
override this.RequestDataAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<Newtonsoft.Json.Linq.JToken>

Public Overridable Function RequestDataAsync (cancellationToken As CancellationToken) As Task(Of JToken)

Parameters

cancellationToken

CancellationToken

Cancellation token for the async call.

Returns

Task<Newtonsoft.Json.Linq.JToken>

The optional response to the message. The format of the returned data is defined by the chosen visualizer object source.

Exceptions

VisualizerTargetUnavailableException

When the visualizer target is unavailable or becomes unavailable before the call can be completed.

         When this exception is thrown, the attempt to retrieve the value of the object to be visualized should be
         aborted since the visualizer target is now unavailable. When the visualizer target becomes available
         again, the value of the object to be visualized may have changed, so a new value retrieval should be started.

RequestDataAsync(JToken, CancellationToken)

Sends a message to the visualizer object source in the debug target process and returns the corresponding response.

public virtual System.Threading.Tasks.Task<Newtonsoft.Json.Linq.JToken> RequestDataAsync (Newtonsoft.Json.Linq.JToken? message, System.Threading.CancellationToken cancellationToken);

abstract member RequestDataAsync : Newtonsoft.Json.Linq.JToken * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Newtonsoft.Json.Linq.JToken>
override this.RequestDataAsync : Newtonsoft.Json.Linq.JToken * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Newtonsoft.Json.Linq.JToken>

Public Overridable Function RequestDataAsync (message As JToken, cancellationToken As CancellationToken) As Task(Of JToken)

Parameters

message

Newtonsoft.Json.Linq.JToken

The content of the message. The format of message is defined by the chosen visualizer object source.

cancellationToken

CancellationToken

Cancellation token for the async call.

Returns

Task<Newtonsoft.Json.Linq.JToken>

The optional response to the message. The format of the returned data is defined by the chosen visualizer object source.

Exceptions

VisualizerTargetUnavailableException

When the visualizer target is unavailable or becomes unavailable before the call can be completed.

         When this exception is thrown, the attempt to retrieve the value of the object to be visualized should be
         aborted since the visualizer target is now unavailable. When the visualizer target becomes available
         again, the value of the object to be visualized may have changed, so a new value retrieval should be started.

RequestDataAsync(Nullable<ReadOnlySequence<Byte>>, CancellationToken)

Sends a message to the visualizer object source in the debug target process and returns the corresponding response.

public abstract System.Threading.Tasks.Task<System.Buffers.ReadOnlySequence<byte>?> RequestDataAsync (System.Buffers.ReadOnlySequence<byte>? message, System.Threading.CancellationToken cancellationToken);

abstract member RequestDataAsync : Nullable<System.Buffers.ReadOnlySequence<byte>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Nullable<System.Buffers.ReadOnlySequence<byte>>>

Public MustOverride Function RequestDataAsync (message As Nullable(Of ReadOnlySequence(Of Byte)), cancellationToken As CancellationToken) As Task(Of Nullable(Of ReadOnlySequence(Of Byte)))

Parameters

message

Nullable<ReadOnlySequence<Byte>>

The optional content of the message. The format of message is defined by the chosen visualizer object source.

cancellationToken

CancellationToken

Cancellation token for the async call.

Returns

Task<Nullable<ReadOnlySequence<Byte>>>

The optional response to the message. The format of the returned data is defined by the chosen visualizer object source.

Exceptions

VisualizerTargetUnavailableException

When the visualizer target is unavailable or becomes unavailable before the call can be completed.

         When this exception is thrown, the attempt to retrieve the value of the object to be visualized should be
         aborted since the visualizer target is now unavailable. When the visualizer target becomes available again, the
         value of the object to be visualized may have changed, so a new value retrieval should be started.

RequestDataAsync<TMessage,TResponse>(TMessage, JsonSerializer, CancellationToken)

Sends a message to the visualizer object source in the debug target process and returns the corresponding response.

public virtual System.Threading.Tasks.Task<TResponse> RequestDataAsync<TMessage,TResponse> (TMessage message, Newtonsoft.Json.JsonSerializer? jsonSerializer, System.Threading.CancellationToken cancellationToken);

abstract member RequestDataAsync : 'Message * Newtonsoft.Json.JsonSerializer * System.Threading.CancellationToken -> System.Threading.Tasks.Task<'Response>
override this.RequestDataAsync : 'Message * Newtonsoft.Json.JsonSerializer * System.Threading.CancellationToken -> System.Threading.Tasks.Task<'Response>

Public Overridable Function RequestDataAsync(Of TMessage, TResponse) (message As TMessage, jsonSerializer As JsonSerializer, cancellationToken As CancellationToken) As Task(Of TResponse)

Type Parameters

TMessage

The type of the message encoded into JSON and sent to the visualizer object source.

TResponse

The type of the response to be decoded from JSON.

Parameters

message

TMessage

The object to be encoded into JSON and sent to the visualizer object source.

jsonSerializer

Newtonsoft.Json.JsonSerializer

Optional json serializer used to convert message to JSON and convert the returned object from JSON.

cancellationToken

CancellationToken

Cancellation token for the async call.

Returns

Task<TResponse>

The optional response to the message. If TResponse is a reference type, this method can return null.

Exceptions

VisualizerTargetUnavailableException

When the visualizer target is unavailable or becomes unavailable before the call can be completed.

         When this exception is thrown, the attempt to retrieve the value of the object to be visualized should be
         aborted since the visualizer target is now unavailable. When the visualizer target becomes available
         again, the value of the object to be visualized may have changed, so a new value retrieval should be started.

RequestDataAsync<TResponse>(JsonSerializer, CancellationToken)

Sends an empty message to the visualizer object source in the debug target process and returns the corresponding response.

public virtual System.Threading.Tasks.Task<TResponse> RequestDataAsync<TResponse> (Newtonsoft.Json.JsonSerializer? jsonSerializer, System.Threading.CancellationToken cancellationToken);

abstract member RequestDataAsync : Newtonsoft.Json.JsonSerializer * System.Threading.CancellationToken -> System.Threading.Tasks.Task<'Response>
override this.RequestDataAsync : Newtonsoft.Json.JsonSerializer * System.Threading.CancellationToken -> System.Threading.Tasks.Task<'Response>

Public Overridable Function RequestDataAsync(Of TResponse) (jsonSerializer As JsonSerializer, cancellationToken As CancellationToken) As Task(Of TResponse)

Type Parameters

TResponse

The type of the response to be decoded from JSON.

Parameters

jsonSerializer

Newtonsoft.Json.JsonSerializer

Optional json serializer used to convert the returned object from JSON.

cancellationToken

CancellationToken

Cancellation token for the async call.

Returns

Task<TResponse>

The optional response to the message. If TResponse is a reference type, this method can return null.

Exceptions

VisualizerTargetUnavailableException

When the visualizer target is unavailable or becomes unavailable before the call can be completed.

         When this exception is thrown, the attempt to retrieve the value of the object to be visualized should be
         aborted since the visualizer target is now unavailable. When the visualizer target becomes available
         again, the value of the object to be visualized may have changed, so a new value retrieval should be started.