Class HeapProfilerAdapter

Namespace

OpenQA.Selenium.DevTools.V143.HeapProfiler

Assembly

WebDriver.dll

Represents an adapter for the HeapProfiler domain to simplify the command interface.

public class HeapProfilerAdapter

Inheritance

object

HeapProfilerAdapter

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Constructors

HeapProfilerAdapter(IDevToolsSession)

Initializes a new instance of the HeapProfilerAdapter class.

public HeapProfilerAdapter(IDevToolsSession session)

Parameters

session IDevToolsSession

The IDevToolsSession to be used with this adapter.

Exceptions

ArgumentNullException

If session is null.

Properties

Session

Gets the DevToolsSession associated with the adapter.

public IDevToolsSession Session { get; }

Property Value

IDevToolsSession

Methods

AddInspectedHeapObject(AddInspectedHeapObjectCommandSettings, CancellationToken, int?, bool)

addInspectedHeapObject

public Task<AddInspectedHeapObjectCommandResponse?> AddInspectedHeapObject(AddInspectedHeapObjectCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command AddInspectedHeapObjectCommandSettings

cancellationToken CancellationToken

millisecondsTimeout int?

throwExceptionIfResponseNotReceived bool

Returns

Task<AddInspectedHeapObjectCommandResponse>

CollectGarbage(CollectGarbageCommandSettings?, CancellationToken, int?, bool)

collectGarbage

public Task<CollectGarbageCommandResponse?> CollectGarbage(CollectGarbageCommandSettings? command = null, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command CollectGarbageCommandSettings

cancellationToken CancellationToken

millisecondsTimeout int?

throwExceptionIfResponseNotReceived bool

Returns

Task<CollectGarbageCommandResponse>

Disable(DisableCommandSettings?, CancellationToken, int?, bool)

disable

public Task<DisableCommandResponse?> Disable(DisableCommandSettings? command = null, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command DisableCommandSettings

cancellationToken CancellationToken

millisecondsTimeout int?

throwExceptionIfResponseNotReceived bool

Returns

Task<DisableCommandResponse>

Enable(EnableCommandSettings?, CancellationToken, int?, bool)

enable

public Task<EnableCommandResponse?> Enable(EnableCommandSettings? command = null, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command EnableCommandSettings

cancellationToken CancellationToken

millisecondsTimeout int?

throwExceptionIfResponseNotReceived bool

Returns

Task<EnableCommandResponse>

GetHeapObjectId(GetHeapObjectIdCommandSettings, CancellationToken, int?, bool)

getHeapObjectId

public Task<GetHeapObjectIdCommandResponse> GetHeapObjectId(GetHeapObjectIdCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command GetHeapObjectIdCommandSettings

cancellationToken CancellationToken

millisecondsTimeout int?

throwExceptionIfResponseNotReceived bool

Returns

Task<GetHeapObjectIdCommandResponse>

GetObjectByHeapObjectId(GetObjectByHeapObjectIdCommandSettings, CancellationToken, int?, bool)

getObjectByHeapObjectId

public Task<GetObjectByHeapObjectIdCommandResponse> GetObjectByHeapObjectId(GetObjectByHeapObjectIdCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command GetObjectByHeapObjectIdCommandSettings

cancellationToken CancellationToken

millisecondsTimeout int?

throwExceptionIfResponseNotReceived bool

Returns

Task<GetObjectByHeapObjectIdCommandResponse>

GetSamplingProfile(GetSamplingProfileCommandSettings?, CancellationToken, int?, bool)

getSamplingProfile

public Task<GetSamplingProfileCommandResponse> GetSamplingProfile(GetSamplingProfileCommandSettings? command = null, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command GetSamplingProfileCommandSettings

cancellationToken CancellationToken

millisecondsTimeout int?

throwExceptionIfResponseNotReceived bool

Returns

Task<GetSamplingProfileCommandResponse>

StartSampling(StartSamplingCommandSettings, CancellationToken, int?, bool)

startSampling

public Task<StartSamplingCommandResponse?> StartSampling(StartSamplingCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command StartSamplingCommandSettings

cancellationToken CancellationToken

millisecondsTimeout int?

throwExceptionIfResponseNotReceived bool

Returns

Task<StartSamplingCommandResponse>

StartTrackingHeapObjects(StartTrackingHeapObjectsCommandSettings, CancellationToken, int?, bool)

startTrackingHeapObjects

public Task<StartTrackingHeapObjectsCommandResponse?> StartTrackingHeapObjects(StartTrackingHeapObjectsCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command StartTrackingHeapObjectsCommandSettings

cancellationToken CancellationToken

millisecondsTimeout int?

throwExceptionIfResponseNotReceived bool

Returns

Task<StartTrackingHeapObjectsCommandResponse>

StopSampling(StopSamplingCommandSettings?, CancellationToken, int?, bool)

stopSampling

public Task<StopSamplingCommandResponse> StopSampling(StopSamplingCommandSettings? command = null, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command StopSamplingCommandSettings

cancellationToken CancellationToken

millisecondsTimeout int?

throwExceptionIfResponseNotReceived bool

Returns

Task<StopSamplingCommandResponse>

StopTrackingHeapObjects(StopTrackingHeapObjectsCommandSettings, CancellationToken, int?, bool)

stopTrackingHeapObjects

public Task<StopTrackingHeapObjectsCommandResponse?> StopTrackingHeapObjects(StopTrackingHeapObjectsCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command StopTrackingHeapObjectsCommandSettings

cancellationToken CancellationToken

millisecondsTimeout int?

throwExceptionIfResponseNotReceived bool

Returns

Task<StopTrackingHeapObjectsCommandResponse>

TakeHeapSnapshot(TakeHeapSnapshotCommandSettings, CancellationToken, int?, bool)

takeHeapSnapshot

public Task<TakeHeapSnapshotCommandResponse?> TakeHeapSnapshot(TakeHeapSnapshotCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command TakeHeapSnapshotCommandSettings

cancellationToken CancellationToken

millisecondsTimeout int?

throwExceptionIfResponseNotReceived bool

Returns

Task<TakeHeapSnapshotCommandResponse>

Events

AddHeapSnapshotChunk

addHeapSnapshotChunk

public event EventHandler<AddHeapSnapshotChunkEventArgs>? AddHeapSnapshotChunk

Event Type

EventHandler<AddHeapSnapshotChunkEventArgs>

HeapStatsUpdate

heapStatsUpdate

public event EventHandler<HeapStatsUpdateEventArgs>? HeapStatsUpdate

Event Type

EventHandler<HeapStatsUpdateEventArgs>

LastSeenObjectId

lastSeenObjectId

public event EventHandler<LastSeenObjectIdEventArgs>? LastSeenObjectId

Event Type

EventHandler<LastSeenObjectIdEventArgs>

ReportHeapSnapshotProgress

reportHeapSnapshotProgress

public event EventHandler<ReportHeapSnapshotProgressEventArgs>? ReportHeapSnapshotProgress

Event Type

EventHandler<ReportHeapSnapshotProgressEventArgs>

ResetProfiles

resetProfiles

public event EventHandler<ResetProfilesEventArgs>? ResetProfiles

Event Type

EventHandler<ResetProfilesEventArgs>