Class IPAddressAccessibilityCheck

Namespace

Xping.Sdk.Actions

Assembly

Xping.Sdk.dll

The IPAddressAccessibilityCheck class is a concrete implementation of the TestComponent class that is used to check the accessibility of an IP address. It uses the mechanisms provided by the operating system to check the accessibility of an IP address.

public sealed class IPAddressAccessibilityCheck : TestComponent, ITestComponent

Inheritance

object

TestComponent

IPAddressAccessibilityCheck

Implements

ITestComponent

Inherited Members

TestComponent.Name

TestComponent.Type

TestComponent.ProbeAsync(Uri, TestSettings, IServiceProvider, CancellationToken)

TestComponent.AddComponent(ITestComponent)

TestComponent.RemoveComponent(ITestComponent)

TestComponent.Components

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

note

The IPAddressAccessibilityCheck component requires the DnsLookup component to be registered before it in the pipeline, because it depends on the DNS resolution results.

The IPAddressAccessibilityCheck component uses the Ping class to send an Internet Control Message Protocol (ICMP) echo request to the IP address and receive an echo reply. The Ping class can handle both synchronous and asynchronous operations, and can also provide information such as the round-trip time, the time-to-live, and the buffer size of the ICMP packets. The IPAddressAccessibilityCheck component can use these information to determine the availability and performance of the IP address.

Constructors

IPAddressAccessibilityCheck(PingConfiguration)

Initializes new instance of th

public IPAddressAccessibilityCheck(PingConfiguration configuration)

Parameters

configuration PingConfiguration

The ping operation configuration.

Fields

StepName

The name of the test component that represents a IPAddressAccessibilityCheck of tests.

public const string StepName = "IPAddress accessibility check"

Field Value

string

Remarks

This constant is used to register the IPAddressAccessibilityCheck class in the test framework.

Methods

HandleAsync(Uri, TestSettings, TestContext, IServiceProvider, CancellationToken)

This method performs the test step operation asynchronously.

public override Task HandleAsync(Uri url, TestSettings settings, TestContext context, IServiceProvider serviceProvider, CancellationToken cancellationToken = default)

Parameters

url Uri

A Uri object that represents the URL of the page being validated.

settings TestSettings

A TestSettings object that contains the settings for the test.

context TestContext

A TestContext object that represents the test context.

serviceProvider IServiceProvider

An instance object of a mechanism for retrieving a service object.

cancellationToken CancellationToken

An optional CancellationToken object that can be used to cancel this operation.

Returns

Task

TestStep object.