Interface IWinProcessEnvironment

Represents the environment that a device can interact with processes and system performance.

Inherited Members

Namespace: Microsoft.XboxStudios.DeviceConsole.Environments.Performance

Assembly: DeviceConsole.Environments.dll

Syntax

public interface IWinProcessEnvironment : IProcessEnvironment, IDeviceEnvironment, IDeviceContainer, IHasConnectionStatus

Methods

View Source

GetRunningProcessesAsync(TimeSpan?)

Gets the running processes on the device.

Declaration

Task<IEnumerable<ProcessInfo>> GetRunningProcessesAsync(TimeSpan? timeout = null)

Parameters

Type	Name	Description
TimeSpan?	timeout	The timeout for the operation.

Returns

Type	Description
Task<IEnumerable<ProcessInfo>>	An enumerable of running processes on the device.

View Source

GetRunningProcessesAsync(CancellationToken)

Gets the running processes on the device.

Declaration

Task<IEnumerable<ProcessInfo>> GetRunningProcessesAsync(CancellationToken cancellationToken)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	The cancellation token for the operation.

Returns

Type	Description
Task<IEnumerable<ProcessInfo>>	An enumerable of running processes on the device.

View Source

GetSystemPerformanceAsync(TimeSpan?)

Gets current system performance for the device.

Declaration

Task<SystemPerformanceInfo> GetSystemPerformanceAsync(TimeSpan? timeout = null)

Parameters

Type	Name	Description
TimeSpan?	timeout	The timeout for the operation.

Returns

Type	Description
Task<SystemPerformanceInfo>	The system performance information.

View Source

GetSystemPerformanceAsync(CancellationToken)

Gets current system performance for the device.

Declaration

Task<SystemPerformanceInfo> GetSystemPerformanceAsync(CancellationToken cancellationToken)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	The cancellation token for the operation.

Returns

Type	Description
Task<SystemPerformanceInfo>	The system performance information.

View Source

StartListeningForProcessInfoAsync(TimeSpan?)

Starts listening for process information events from the device.

Declaration

Task StartListeningForProcessInfoAsync(TimeSpan? timeout = null)

Parameters

Type	Name	Description
TimeSpan?	timeout	The timeout for the operation.

Returns

Type	Description
Task	A Task representing the result of the asynchronous operation.

View Source

StartListeningForProcessInfoAsync(CancellationToken)

Starts listening for process information events from the device.

Declaration

Task StartListeningForProcessInfoAsync(CancellationToken cancellationToken)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	The cancellation token for the operation.

Returns

Type	Description
Task	A Task representing the result of the asynchronous operation.

View Source

StartListeningForSystemPerformanceAsync(TimeSpan?)

Starts listening for system performance events from the device.

Declaration

Task StartListeningForSystemPerformanceAsync(TimeSpan? timeout = null)

Parameters

Type	Name	Description
TimeSpan?	timeout	The timeout for the operation.

Returns

Type	Description
Task	A Task representing the result of the asynchronous operation.

View Source

StartListeningForSystemPerformanceAsync(CancellationToken)

Starts listening for system performance events from the device.

Declaration

Task StartListeningForSystemPerformanceAsync(CancellationToken cancellationToken)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	The cancellation token for the operation.

Returns

Type	Description
Task	A Task representing the result of the asynchronous operation.

View Source

StopListeningForProcessInfoAsync(TimeSpan?)

Stops listening for process information events from the device.

Declaration

Task StopListeningForProcessInfoAsync(TimeSpan? timeout = null)

Parameters

Type	Name	Description
TimeSpan?	timeout	The timeout for the operation.

Returns

Type	Description
Task	A Task representing the result of the asynchronous operation.

View Source

StopListeningForProcessInfoAsync(CancellationToken)

Stops listening for process information events from the device.

Declaration

Task StopListeningForProcessInfoAsync(CancellationToken cancellationToken)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	The cancellation token for the operation.

Returns

Type	Description
Task	A Task representing the result of the asynchronous operation.

View Source

StopListeningForSystemPerformanceAsync(TimeSpan?)

Stops listening for system performance events from the device.

Declaration

Task StopListeningForSystemPerformanceAsync(TimeSpan? timeout = null)

Parameters

Type	Name	Description
TimeSpan?	timeout	The timeout for the operation.

Returns

Type	Description
Task	A Task representing the result of the asynchronous operation.

View Source

StopListeningForSystemPerformanceAsync(CancellationToken)

Stops listening for system performance events from the device.

Declaration

Task StopListeningForSystemPerformanceAsync(CancellationToken cancellationToken)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	The cancellation token for the operation.

Returns

Type	Description
Task	A Task representing the result of the asynchronous operation.

Events

View Source

ProcessInfoReceived

Process info received event.

Declaration

event EventHandler<IEnumerable<ProcessInfo>> ProcessInfoReceived

Event Type

Type	Description
EventHandler<IEnumerable<ProcessInfo>>

View Source

SystemPerformanceReceived

System performance update received event.

Declaration

event EventHandler<SystemPerformanceInfo> SystemPerformanceReceived

Event Type

Type	Description
EventHandler<SystemPerformanceInfo>

Extension Methods

IHasConnectionStatusExtensions.IsConnected(IHasConnectionStatus)