Class
ProfilerCommunicationLayer

Definition

Namespace:ArtOfTest.WebAii.Design.Execution.Profiler

Assembly:ArtOfTest.WebAii.Design.dll

Syntax:

cs-api-definition
public class ProfilerCommunicationLayer : BaseCommunicationLayer, IProfilerCommunicationLayer, IBaseCommunicationLayer

Inheritance: objectProfilerCommunicationLayer

Implements: IBaseCommunicationLayerIProfilerCommunicationLayer

Constructors

ProfilerCommunicationLayer(Uri, ISerializerService, ISecureHttpClientProvider, IStatusCodeToExceptionMapper)

Declaration

cs-api-definition
public ProfilerCommunicationLayer(Uri profilerUri, ISerializerService serializer, ISecureHttpClientProvider secureHttpClientProvider, IStatusCodeToExceptionMapper exceptionMapper)

Parameters

profilerUri

Uri

serializer

ISerializerService

secureHttpClientProvider

ISecureHttpClientProvider

exceptionMapper

IStatusCodeToExceptionMapper

Methods

AfterExecuteStep(Guid, int, string)

Performs actions after a step executes

Declaration

cs-api-definition
public Task AfterExecuteStep(Guid testId, int stepNumber, string description)

Parameters

testId

Guid

stepNumber

int

description

string

Returns

Task

BeforeExecuteStep(Guid, int, string)

Performs actions before a step executes

Declaration

cs-api-definition
public Task BeforeExecuteStep(Guid testId, int stepNumber, string description)

Parameters

testId

Guid

stepNumber

int

description

string

Returns

Task

GetAndRemoveSampledProfilerData(Guid)

Retrieves the profiled data samples

Declaration

cs-api-definition
public Task<Dictionary<string, IProfilerPluginConfigurationSettings>> GetAndRemoveSampledProfilerData(Guid testId)

Parameters

testId

Guid

Returns

Task<Dictionary<string, IProfilerPluginConfigurationSettings>>

GetCalculatedClientTimeUtc(Guid)

Calculates and gets the client time from the server

Declaration

cs-api-definition
public Task<DateTime> GetCalculatedClientTimeUtc(Guid testHandle)

Parameters

testHandle

Guid

Returns

Task<DateTime>

GetEnvironmentConfigurationOptions(Guid)

Retrieves configuration options

Declaration

cs-api-definition
public Task<IEnvironmentalConfigurationOptions> GetEnvironmentConfigurationOptions(Guid profilerComponentId)

Parameters

profilerComponentId

Guid

Returns

Task<IEnvironmentalConfigurationOptions>

GetServerTimeUtc()

Gets the server time

Declaration

cs-api-definition
public Task<DateTime> GetServerTimeUtc()

Returns

Task<DateTime>

Initialize(Guid, Dictionary<Guid, IProfilerPluginConfigurationSettings>)

Prepare for profiling

Declaration

cs-api-definition
public Task Initialize(Guid testId, Dictionary<Guid, IProfilerPluginConfigurationSettings> profilerConfigurations)

Parameters

testId

Guid

profilerConfigurations

Dictionary<Guid, IProfilerPluginConfigurationSettings>

Returns

Task

IsProfilerValid()

Was the profiler initialized successfully

Declaration

cs-api-definition
public Task<bool> IsProfilerValid()

Returns

Task<bool>

ProveSameComputerPresence(Guid)

Returns the server's Guid that is linked to the client's Guid

Declaration

cs-api-definition
public Task<Guid> ProveSameComputerPresence(Guid clientGuid)

Parameters

clientGuid

Guid

Returns

Task<Guid>

SetServerTimeUtc(Guid, DateTime)

Updates the server with client time

Declaration

cs-api-definition
public Task SetServerTimeUtc(Guid testId, DateTime newServerTime)

Parameters

testId

Guid

newServerTime

DateTime

Returns

Task

StartProfiling(Guid)

Starts profiling a test

Declaration

cs-api-definition
public Task StartProfiling(Guid testId)

Parameters

testId

Guid

Returns

Task

StartProfilingFromController(Guid, string, TimeSpan)

Declaration

cs-api-definition
public Task StartProfilingFromController(Guid testId, string controllerHost, TimeSpan pollingInterval)

Parameters

testId

Guid

controllerHost

string

pollingInterval

TimeSpan

Returns

Task

StopTestProfiling(Guid)

Stops profiling a test

Declaration

cs-api-definition
public Task<bool> StopTestProfiling(Guid testId)

Parameters

testId

Guid

Returns

Task<bool>

TerminateProfiler()

Cleans up and disconnects a profiler

Declaration

cs-api-definition
public Task TerminateProfiler()

Returns

Task